| blob | eac6095bdb3d675037d0db1bb9172db2a633f4eb |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
6 ;; Simon Marshall <simon@gnu.org>
7 ;; Maintainer: FSF
8 ;; Keywords: processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Please send me bug reports, bug fixes, and extensions, so that I can
30 ;; merge them into the master source.
31 ;; - Olin Shivers (shivers@cs.cmu.edu)
32 ;; - Simon Marshall (simon@gnu.org)
34 ;; This file defines a general command-interpreter-in-a-buffer package
35 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
36 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
37 ;; This way, all these specific packages share a common base functionality,
38 ;; and a common set of bindings, which makes them easier to use (and
39 ;; saves code, implementation time, etc., etc.).
41 ;; Several packages are already defined using comint mode:
42 ;; - shell.el defines a shell-in-a-buffer mode.
43 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
44 ;;
45 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
46 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
47 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
48 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
49 ;; previewers, and printers from within emacs.
50 ;; - background.el allows csh-like job control inside emacs.
51 ;; It is pretty easy to make new derived modes for other processes.
53 ;; For documentation on the functionality provided by comint mode, and
54 ;; the hooks available for customising it, see the comments below.
55 ;; For further information on the standard derived modes (shell,
56 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
58 ;; For hints on converting existing process modes (e.g., tex-mode,
59 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
60 ;; instead of shell-mode, see the notes at the end of this file.
62 \f
63 ;; Brief Command Documentation:
64 ;;============================================================================
65 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
66 ;; mode)
67 ;;
68 ;; m-p comint-previous-input Cycle backwards in input history
69 ;; m-n comint-next-input Cycle forwards
70 ;; m-r comint-previous-matching-input Previous input matching a regexp
71 ;; m-s comint-next-matching-input Next input that matches
72 ;; m-c-l comint-show-output Show last batch of process output
73 ;; return comint-send-input
74 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
75 ;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
76 ;; second time, move to process-mark.
77 ;; c-c c-u comint-kill-input ^u
78 ;; c-c c-w backward-kill-word ^w
79 ;; c-c c-c comint-interrupt-subjob ^c
80 ;; c-c c-z comint-stop-subjob ^z
81 ;; c-c c-\ comint-quit-subjob ^\
82 ;; c-c c-o comint-kill-output Delete last batch of process output
83 ;; c-c c-r comint-show-output Show last batch of process output
84 ;; c-c c-l comint-dynamic-list-input-ring List input history
85 ;;
86 ;; Not bound by default in comint-mode (some are in shell mode)
87 ;; comint-run Run a program under comint-mode
88 ;; send-invisible Read a line w/o echo, and send to proc
89 ;; comint-dynamic-complete-filename Complete filename at point.
90 ;; comint-dynamic-complete-variable Complete variable name at point.
91 ;; comint-dynamic-list-filename-completions List completions in help buffer.
92 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
93 ;; replace with expanded/completed name.
94 ;; comint-replace-by-expanded-history Expand history at point;
95 ;; replace with expanded name.
96 ;; comint-magic-space Expand history and add (a) space(s).
97 ;; comint-kill-subjob No mercy.
98 ;; comint-show-maximum-output Show as much output as possible.
99 ;; comint-continue-subjob Send CONT signal to buffer's process
100 ;; group. Useful if you accidentally
101 ;; suspend your process (with C-c C-z).
102 ;; comint-get-next-from-history Fetch successive input history lines
103 ;; comint-accumulate Combine lines to send them together
104 ;; as input.
105 ;; comint-goto-process-mark Move point to where process-mark is.
106 ;; comint-set-process-mark Set process-mark to point.
108 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
110 ;;; Code:
113 \f
114 ;; Buffer Local Variables:
115 ;;============================================================================
116 ;; Comint mode buffer local variables:
117 ;; comint-prompt-regexp string comint-bol uses to match prompt
118 ;; comint-delimiter-argument-list list For delimiters and arguments
119 ;; comint-last-input-start marker Handy if inferior always echoes
120 ;; comint-last-input-end marker For comint-kill-output command
121 ;; comint-input-ring-size integer For the input history
122 ;; comint-input-ring ring mechanism
123 ;; comint-input-ring-index number ...
124 ;; comint-save-input-ring-index number ...
125 ;; comint-input-autoexpand symbol ...
126 ;; comint-input-ignoredups boolean ...
127 ;; comint-dynamic-complete-functions hook For the completion mechanism
128 ;; comint-completion-fignore list ...
129 ;; comint-file-name-chars string ...
130 ;; comint-file-name-quote-list list ...
131 ;; comint-get-old-input function Hooks for specific
132 ;; comint-input-filter-functions hook process-in-a-buffer
133 ;; comint-output-filter-functions hook function modes.
134 ;; comint-preoutput-filter-functions hook
135 ;; comint-input-filter function ...
136 ;; comint-input-sender function ...
137 ;; comint-eol-on-send boolean ...
138 ;; comint-process-echoes boolean ...
139 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
140 ;; comint-scroll-to-bottom-on-output symbol ...
141 ;; comint-scroll-show-maximum-output boolean ...
142 ;; comint-accum-marker maker For comint-accumulate
143 ;;
144 ;; Comint mode non-buffer local variables:
145 ;; comint-completion-addsuffix boolean/cons For file name
146 ;; comint-completion-autolist boolean completion behavior
147 ;; comint-completion-recexact boolean ...
150 "General command interpreter in a window stuff."
154 "Completion facilities in comint"
158 "Source finding facilities in comint"
164 "Regexp to recognise prompts in the inferior process.
167 Good choices:
178 "List of characters to recognise as separate arguments in input.
179 Strings comprising a character in this list will separate the arguments
180 surrounding them, and also be regarded as arguments in their own right (unlike
181 whitespace). See `comint-arguments'.
182 Defaults to the empty list.
189 "*If non-nil, expand input command history references on completion.
190 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
192 If the value is `input', then the expansion is seen on input.
193 If the value is `history', then the expansion is only when inserting
194 into the buffer's input ring. See also `comint-magic-space' and
195 `comint-dynamic-complete'.
197 This variable is buffer-local."
205 "*If non-nil, don't add input matching the last on the input ring.
206 This mirrors the optional behavior of bash.
208 This variable is buffer-local."
213 "*If non-nil, name of the file to read/write input history.
214 See also `comint-read-input-ring' and `comint-write-input-ring'.
216 This variable is buffer-local, and is a good thing to set in mode hooks."
221 "*Controls whether input to interpreter causes window to scroll.
222 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
223 If `this', scroll only the selected window.
225 The default is nil.
227 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
235 "*Controls whether interpreter output causes window to scroll.
236 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
237 If `this', scroll only the selected window.
238 If `others', scroll only those that are not the selected window.
240 The default is nil.
242 See variable `comint-scroll-show-maximum-output' and function
243 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
252 "*Controls how interpreter output causes window to scroll.
253 If non-nil, then show the maximum output when the window is scrolled.
255 See variable `comint-scroll-to-bottom-on-output' and function
256 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
261 "*The maximum size in lines for comint buffers.
262 Comint buffers are truncated from the top to be no greater than this number, if
263 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
274 "*If non-nil, assume that the subprocess echoes any input.
275 If so, delete one copy of the input so that only one copy eventually
276 appears in the buffer.
278 This variable is buffer-local."
282 ;; AIX puts the name of the person being su'd to in front of the prompt.
283 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
284 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
285 ;; ssh-add prints a prompt like `Enter passphrase: '.
286 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
291 "*Regexp matching prompts for passwords in the inferior process.
292 This is used by `comint-watch-for-password-prompt'."
296 ;; Here are the per-interpreter hooks.
298 "Function that returns old text in comint mode.
299 This function is called when return is typed while the point is in old text.
300 It returns the text to be submitted as process input. The default is
301 `comint-get-old-input-default', which grabs the current line, and strips off
306 "List of functions called to perform completion.
307 Functions should return non-nil if completion was performed.
308 See also `comint-dynamic-complete'.
314 "Predicate for filtering additions to input history.
315 Takes one argument, the input. If non-nil, the input may be saved on the input
319 "Functions to call before input is sent to the process.
320 These functions get one argument, a string containing the text to send.
325 "Functions to call after output is inserted into the buffer.
326 One possible function is `comint-postoutput-scroll-to-bottom'.
327 These functions get one argument, a string containing the text as originally
328 inserted. Note that this might not be the same as the buffer contents between
329 `comint-last-output-start' and the buffer's `process-mark', if other filter
330 functions have already modified the buffer.
332 See also `comint-preoutput-filter-functions'.
337 "Function to actually send to PROCESS the STRING submitted by user.
338 Usually this is just `comint-simple-send', but if your mode needs to
339 massage the input string, put a different function here.
340 `comint-simple-send' just sends the string plus a newline.
344 "*Non-nil means go to the end of the line before sending input.
345 See `comint-send-input'."
350 "Called upon entry into comint-mode
351 This is run before the process is cranked up."
356 "Called each time a process is exec'd by `comint-exec'.
357 This is called after the process is cranked up. It is useful for things that
358 must be done each time a process is executed in a comint mode buffer (e.g.,
359 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
360 executed once when the buffer is created."
367 "Non-nil if communications via pty; false if by pipe. Buffer local.
379 "Last input ring index which you copied.
383 "Non-nil if you are accumulating input lines to send as input together.
402 "Major mode for interacting with an inferior interpreter.
403 Interpreter name is same as buffer name, sans the asterisks.
404 Return at end of buffer sends line as input.
405 Return not at end copies rest of line to end and sends it.
406 Setting variable `comint-eol-on-send' means jump to the end of the line
407 before submitting new input.
409 This mode is customised to create major modes such as Inferior Lisp
410 mode, Shell mode, etc. This can be done by setting the hooks
411 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
412 and `comint-get-old-input' to appropriate functions, and the variable
413 `comint-prompt-regexp' to the appropriate regular expression.
415 An input history is maintained of size `comint-input-ring-size', and
416 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
417 Input ring history expansion can be achieved with the commands
419 Input ring expansion is controlled by the variable `comint-input-autoexpand',
420 and addition is controlled by the variable `comint-input-ignoredups'.
422 Commands with no default key bindings include `send-invisible',
423 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
424 `comint-magic-space'.
426 Input to, and output from, the subprocess can cause the window to scroll to
427 the end of the buffer. See variables `comint-output-filter-functions',
428 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
429 and `comint-scroll-to-bottom-on-output'.
432 to continue it.
436 Entry to this mode runs the hooks on `comint-mode-hook'."
438 ;; Do not remove this. All major modes must do this.
492 nil
493 ;; Keys:
522 ;; Menu bars:
523 ;; completion:
534 ;; Input history:
571 ;; Signals
586 ;; Put them in the menu bar:
588 menu-bar-final-items))
589 )
592 "Return t if there is a living process associated w/buffer BUFFER.
593 Living means the status is `open', `run', or `stop'.
594 BUFFER can be either a buffer or the name of one."
598 ;;;###autoload
600 "Make a comint process NAME in a buffer, running PROGRAM.
601 The name of the buffer is made by surrounding NAME with `*'s.
602 PROGRAM should be either a string denoting an executable program to create
603 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
604 connection to be opened via `open-network-stream'. If there is already a
605 running process in that buffer, it is not restarted. Optional third arg
606 STARTFILE is the name of a file to send the contents of to the process.
608 If PROGRAM is a string, any more args are arguments to PROGRAM."
612 ;; If no process, or nuked process, crank up a new one and put buffer in
613 ;; comint mode. Otherwise, leave buffer and existing process alone.
619 buffer))
621 ;;;###autoload
623 "Run PROGRAM in a comint buffer and switch to it.
624 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
625 The file name is used to make a symbol name, such as `comint-sh-hook', and any
626 hooks on this symbol are run in the buffer.
627 See `make-comint' and `comint-exec'."
634 "Start up a process in buffer BUFFER for comint modes.
635 Blasts any old process running in the buffer. Doesn't set the buffer mode.
636 You can use this to cheaply run a series of processes in the same comint
637 buffer. The hook `comint-exec-hook' is run after each exec."
642 ;; Crank up a new process
650 ;; Jump to the end, and set the process mark.
653 ;; Feed it the startfile.
655 ;;This is guaranteed to wait long enough
656 ;;but has bad results if the comint does not prompt at all
657 ;; (while (= size (buffer-size))
658 ;; (sleep-for 1))
659 ;;I hope 1 second is enough!
667 buffer)))
669 ;; This auxiliary function cranks up the process for comint-exec in
670 ;; the appropriate environment.
675 ;; If using termcap, we specify `emacs' as the terminal type
676 ;; because that lets us specify a width.
677 ;; If using terminfo, we specify `dumb' because that is
678 ;; a defined terminal type. `emacs' is not a defined terminal type
679 ;; and there is no way for us to define it here.
680 ;; Some programs that use terminfo get very confused
681 ;; if TERM is not a valid terminal type.
688 process-environment))
691 default-directory
693 proc decoding encoding changed)
695 ;; If the command has slashes, make sure we
696 ;; first look relative to the current directory.
702 ;; If start-process decided to use some coding system for decoding
703 ;; data sent from the process and the coding system doesn't
704 ;; specify EOL conversion, we had better convert CRLF to LF.
707 changed t))
708 ;; Even if start-process left the coding system for encoding data
709 ;; sent from the process undecided, we had better use the same one
710 ;; as what we use for decoding. But, we should suppress EOL
711 ;; conversion.
714 changed t))
717 proc))
718 \f
719 ;; Input history processing in a buffer
720 ;; ===========================================================================
721 ;; Useful input history functions, courtesy of the Ergo group.
723 ;; Eleven commands:
724 ;; comint-dynamic-list-input-ring List history in help buffer.
725 ;; comint-previous-input Previous input...
726 ;; comint-previous-matching-input ...matching a string.
727 ;; comint-previous-matching-input-from-input ... matching the current input.
728 ;; comint-next-input Next input...
729 ;; comint-next-matching-input ...matching a string.
730 ;; comint-next-matching-input-from-input ... matching the current input.
731 ;; comint-backward-matching-input Backwards input...
732 ;; comint-forward-matching-input ...matching a string.
733 ;; comint-replace-by-expanded-history Expand history at point;
734 ;; replace with expanded history.
735 ;; comint-magic-space Expand history and insert space.
736 ;;
737 ;; Three functions:
738 ;; comint-read-input-ring Read into comint-input-ring...
739 ;; comint-write-input-ring Write to comint-input-ring-file-name.
740 ;; comint-replace-by-expanded-history-before-point Workhorse function.
743 "Sets the buffer's `comint-input-ring' from a history file.
744 The name of the file is given by the variable `comint-input-ring-file-name'.
745 The history ring is of size `comint-input-ring-size', regardless of file size.
746 If `comint-input-ring-file-name' is nil this function does nothing.
748 If the optional argument SILENT is non-nil, we say nothing about a
749 failure to read the history file.
751 This function is useful for major mode commands and mode hooks.
753 The commands stored in the history file are separated by the
754 `comint-input-ring-separator'. The most recent command comes last.
756 See also `comint-input-ignoredups' and `comint-write-input-ring'."
759 nil)
763 comint-input-ring-file-name)))
776 ;; Save restriction in case file is already visited...
777 ;; Watch for those date stamps in history files!
781 nil t))
797 comint-input-ring-index nil)))))
800 "Writes the buffer's `comint-input-ring' to a history file.
801 The name of the file is given by the variable `comint-input-ring-file-name'.
802 The original contents of the file are lost if `comint-input-ring' is not empty.
803 If `comint-input-ring-file-name' is nil this function does nothing.
805 Useful within process sentinels.
807 See also `comint-read-input-ring'."
811 nil)
819 ;; Write it all out into a buffer first. Much faster, but messier,
820 ;; than writing it one line at a time.
832 "List in help buffer the buffer's input history."
841 ;; We have to build up a list ourselves from the ring vector.
845 ;; Change "completion" to "history reference"
846 ;; to make the display accurate.
862 ;; Return list of regexp and prefix arg using PROMPT.
870 regexp)
874 ;; First make sure there is a ring and that we are after the process mark
881 ;; arg of zero resets search from beginning, and uses arg of 1
885 arg)))
888 ;; Index to start a directional search, starting at comint-input-ring-index
890 ;; If a search is running, offset by 1 in direction of arg
893 ;; For a new search, start from beginning or end, as appropriate
899 "Return the string ARG places along the input ring.
900 Moves relative to `comint-input-ring-index'."
904 arg)))
907 "Cycle backwards through input history."
912 "Cycle forwards through input history."
917 "Return the string matching REGEXP ARG places along the input ring.
918 Moves relative to `comint-input-ring-index'."
923 "Return the index matching REGEXP ARG places along the input ring.
924 Moves relative to START, or `comint-input-ring-index'."
933 ;; Do the whole search as many times as the argument says.
935 ;; Step once.
938 ;; If we haven't reached a match, step some more.
942 ;; If we have gone all the way around in this search.
945 ;; Now that we know which ring element to use, if we found it, return that.
947 n)))
950 "Search backwards through input history for match for REGEXP.
951 \(Previous history elements are earlier commands.)
952 With prefix argument N, search for Nth previous match.
953 If N is negative, find the next or Nth next match."
957 ;; Has a match been found?
963 ;; Can't use kill-region as it sets this-command
970 "Search forwards through input history for match for REGEXP.
971 \(Later history elements are more recent commands.)
972 With prefix argument N, search for Nth following match.
973 If N is negative, find the previous or Nth previous match."
978 "Search backwards through input history for match for current input.
979 \(Previous history elements are earlier commands.)
980 With prefix argument N, search for Nth previous match.
981 If N is negative, search forwards for the -Nth following match."
984 comint-next-matching-input-from-input)))
985 ;; Starting a new search
991 comint-input-ring-index nil))
994 arg))
997 "Search forwards through input history for match for current input.
998 \(Following history elements are more recent commands.)
999 With prefix argument N, search for Nth following match.
1000 If N is negative, search backwards for the -Nth previous match."
1006 "Expand input command history references before point.
1007 Expansion is dependent on the value of `comint-input-autoexpand'.
1009 This function depends on the buffer's idea of the input history, which may not
1010 match the command interpreter's idea, assuming it has one.
1012 Assumes history syntax is like typical Un*x shells'. However, since emacs
1013 cannot know the interpreter's idea of input line numbers, assuming it has one,
1014 it cannot expand absolute input line number references.
1016 If the optional argument SILENT is non-nil, never complain
1017 even if history reference seems erroneous.
1019 If the optional argument START is non-nil, that specifies the
1020 start of the text to scan for history references, rather
1021 than the logical beginning of line.
1023 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1025 Returns t if successful."
1031 ;; Looks like there might be history references in the command.
1038 "Expand directory stack reference before point.
1039 See `comint-replace-by-expanded-history'. Returns t if successful.
1041 If the optional argument START is non-nil, that specifies the
1042 start of the text to scan for history references, rather
1043 than the logical beginning of line."
1054 ;; This seems a bit complex. We look for references such as !!, !-num,
1055 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1056 ;; If that wasn't enough, the plings can be suffixed with argument
1057 ;; range specifiers.
1058 ;; Argument ranges are complex too, so we hive off the input line,
1059 ;; referenced with plings, with the range string to `comint-args'.
1063 ;; The history is quoted, or we're in quotes.
1066 ;; We cannot know the interpreter's idea of input line numbers.
1070 ;; Just a number of args from `number' lines backward.
1079 t t)
1085 ;; Just a number of args from the previous input line.
1089 t t)
1093 ;; Most recent input starting with or containing (possibly
1094 ;; protected) string, maybe just a number of args. Phew.
1112 t t)
1115 ;; Quick substitution on the previous input line.
1132 "Expand input history references before point and insert ARG spaces.
1133 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1137 \f
1139 "Return t if the number of quotes between BEG and END is odd.
1140 Quotes are single and double."
1146 "Return number of matches for REGEXP from BEG to END."
1153 count))
1156 ;; From STRING, return the args depending on the range specified in the text
1157 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1158 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1174 ;; Return a list of arguments from ARG. Break it up at the
1175 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1190 comint-delimiter-argument-list)))
1193 args)))
1196 "Return from STRING the NTH to MTH arguments.
1197 NTH and/or MTH can be nil, which means the last argument.
1198 Returned arguments are separated by single spaces.
1199 We assume whitespace separates arguments, except within quotes
1200 and except for a space or tab that immediately follows a backslash.
1201 Also, a run of one or more of a single character
1202 in `comint-delimiter-argument-list' is a separate argument.
1203 Argument 0 is the command name."
1204 ;; The first line handles ordinary characters and backslash-sequences
1205 ;; (except with w32 msdos-like shells, where backslashes are valid).
1206 ;; The second matches "-quoted strings.
1207 ;; The third matches '-quoted strings.
1208 ;; The fourth matches `-quoted strings.
1209 ;; This seems to fit the syntax of BASH 2.0.
1220 beg str value quotes)
1221 ;; Build a list of all the args until we have as many as we want.
1225 ;; It's contiguous, part of the same arg.
1228 ;; It's a new separate arg.
1230 ;; Put the previous arg, if there was one, onto ARGS.
1247 \f
1248 ;;
1249 ;; Input processing stuff
1250 ;;
1253 "Send input to process.
1254 After the process output mark, sends all text from the process mark to
1255 point as input to the process. Before the process output mark, calls value
1256 of variable `comint-get-old-input' to retrieve old input, copies it to the
1257 process mark, and sends it. If variable `comint-process-echoes' is nil,
1258 a terminal newline is also inserted into the buffer and sent to the process
1259 \(if it is non-nil, all text from the process mark to point is deleted,
1260 since it is assumed the remote process will re-echo it).
1262 Any history reference may be expanded depending on the value of the variable
1263 `comint-input-autoexpand'. The list of function names contained in the value
1264 of `comint-input-filter-functions' is called on the input before sending it.
1265 The input is entered into the input history ring, if the value of variable
1266 `comint-input-filter' returns non-nil when called on the input.
1268 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1269 end of line before sending the input.
1271 The values of `comint-get-old-input', `comint-input-filter-functions', and
1272 `comint-input-filter' are chosen according to the command interpreter running
1273 in the buffer. E.g.,
1275 If the interpreter is the csh,
1276 comint-get-old-input is the default: take the current line, discard any
1277 initial string matching regexp comint-prompt-regexp.
1280 comint-input-filter is the default: returns t if the input isn't all white
1281 space.
1283 If the comint is Lucid Common Lisp,
1284 comint-get-old-input snarfs the sexp ending at point.
1285 comint-input-filter-functions does nothing.
1286 comint-input-filter returns nil if the input matches input-filter-regexp,
1287 which matches (1) all whitespace (2) :a, :c, etc.
1289 Similarly for Soar, Scheme, etc."
1291 ;; Note that the input string does not include its terminal newline.
1301 copy)))
1303 ;; Just whatever's already there
1304 intxt
1305 ;; Expand and leave it visible in buffer
1309 input
1310 ;; This is messy 'cos ultimately the original
1311 ;; functions used do insertion, rather than return
1312 ;; strings. We have to expand, then insert back.
1318 copy))))
1327 history))))
1333 ;; Update the markers before we send the input
1334 ;; in case we get output amidst sending the input.
1338 ;; clear the "accumulation" marker
1341 ;; This used to call comint-output-filter-functions,
1342 ;; but that scrolled the buffer in undesirable ways.
1346 "List of functions to call before inserting Comint output into the buffer.
1347 Each function gets one argument, a string containing the text received
1348 from the subprocess. It should return the string to insert, perhaps
1349 the same string that was received, or perhaps a modified or transformed
1350 string.
1352 The functions on the list are called sequentially, and each one is
1353 given the string returned by the previous one. The string returned by
1354 the last function is the text that is actually inserted in the
1355 redirection buffer.
1359 ;; The purpose of using this filter for comint processes
1360 ;; is to keep comint-last-input-end from moving forward
1361 ;; when output is inserted.
1364 ;; First check for killed buffer or no input.
1383 ;; Insert after old_begv, but before old_zv.
1389 ;; Don't insert initial prompt outside the top of the window.
1405 "Go to the end of buffer in all windows showing it.
1406 Movement occurs if point in the selected window is not after the process mark,
1407 and `this-command' is an insertion command. Insertion commands recognised
1408 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1409 Depends on the value of `comint-scroll-to-bottom-on-input'.
1411 This function should be a pre-command hook."
1414 hilit-yank)))
1430 nil t))))))
1433 "Go to the end of buffer in all windows showing it.
1434 Does not scroll if the current line is the last line in the buffer.
1435 Depends on the value of `comint-scroll-to-bottom-on-output' and
1436 `comint-scroll-show-maximum-output'.
1438 This function should be in the list `comint-output-filter-functions'."
1452 ;; Maybe user wants point to jump to end.
1455 ;; If point was at the end, keep it at end.
1459 ;; Optionally scroll so that the text
1460 ;; ends at the bottom of the window.
1467 nil t))
1471 "Truncate the buffer to `comint-buffer-maximum-size'.
1472 This function could be on `comint-output-filter-functions' or bound to a key."
1481 "Strip trailing `^M' characters from the current output group.
1482 This function could be on `comint-output-filter-functions' or bound to a key."
1495 "Put the end of the buffer at the bottom of the window."
1501 "Default for `comint-get-old-input'.
1502 Take the current line, and discard any initial text matching
1503 `comint-prompt-regexp'."
1512 "Insert after prompt old input at point as new input to be edited.
1513 Calls `comint-get-old-input' to get old input."
1523 "Skip past the text matching regexp `comint-prompt-regexp'.
1524 If this takes us past the end of the current line, don't skip at all."
1531 "Return t if point is after the process output marker."
1536 "Default function for sending to PROC input STRING.
1537 This just sends STRING plus a newline. To override this,
1538 set the hook `comint-input-sender'."
1543 "Goes to the beginning of line, then skips past the prompt, if any.
1546 The prompt skip is done by skipping text matching the regular expression
1547 `comint-prompt-regexp', a buffer local variable."
1552 ;; These three functions are for entering text you don't want echoed or
1553 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1554 ;; Just enter m-x send-invisible and type in your line, or add
1555 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1558 "Read a single line of text from user without echoing, and return it.
1559 Prompt with argument PROMPT, a string. Optional argument STARS causes
1560 input to be echoed with '*' characters on the prompt line. Input ends with
1561 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1562 `inhibit-quit' is set because e.g. this function was called from a process
1563 filter and C-g is pressed, this function returns nil rather than a string).
1565 Note that the keystrokes comprising the text can still be recovered
1567 Once the caller uses the password, it can erase the password
1568 by doing (fillarray STRING 0)."
1580 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1583 ;; This function may get called from a process filter, where
1584 ;; inhibit-quit is set. In later versions of emacs read-char
1585 ;; may clear quit-flag itself and return C-g. That would make
1586 ;; it impossible to quit this loop in a simple way, so
1587 ;; re-enable it here (for backward-compatibility the check for
1588 ;; quit-flag below would still be necessary, so this seems
1589 ;; like the simplest way to do things).
1591 done t))
1605 ;; Emulate a true quit, except that we have to return a value.
1611 ans)))
1614 "Read a string without echoing.
1615 Then send it to the process running in the current buffer.
1616 The string is sent using `comint-input-sender'.
1617 Security bug: your string can still be temporarily recovered with
1632 "Prompt in the minibuffer for password and send without echoing.
1633 This function uses `send-invisible' to read and send a password to the buffer's
1634 process if STRING contains a password prompt defined by
1635 `comint-password-prompt-regexp'.
1637 This function could be in the list `comint-output-filter-functions'."
1640 \f
1641 ;; Low-level process communication
1645 \f
1646 ;; Random input hackage
1649 "Kill all output from interpreter since last input.
1650 Does not delete the prompt."
1663 ;; Output message and put back prompt
1667 "Display start of this batch of interpreter output at top of window.
1668 Sets mark to the value of point when this command is run."
1678 "Interrupt the current subjob.
1679 This command also kills the pending input
1680 between the process-mark and point."
1686 "Send kill signal to the current subjob.
1687 This command also kills the pending input
1688 between the process-mark and point."
1694 "Send quit signal to the current subjob.
1695 This command also kills the pending input
1696 between the process-mark and point."
1702 "Stop the current subjob.
1703 This command also kills the pending input
1704 between the process-mark and point.
1706 WARNING: if there is no current subjob, you can end up suspending
1707 the top-level process running in the buffer. If you accidentally do
1709 is not a problem with most shells, since they ignore this signal.)"
1715 "Send CONT signal to process buffer's process group.
1716 Useful if you accidentally suspend the top-level process."
1721 "Kill all text from last stuff output by interpreter to point."
1728 "Delete ARG characters forward or send an EOF to subprocess.
1729 Sends an EOF only if point is at the end of the buffer and there is no input."
1737 "Send an EOF to the current buffer's process."
1743 "Search backward through buffer for match for REGEXP.
1744 Matches are searched for on lines that match `comint-prompt-regexp'.
1745 With prefix argument N, search for Nth previous match.
1746 If N is negative, find the next or Nth next match."
1759 "Search forward through buffer for match for REGEXP.
1760 Matches are searched for on lines that match `comint-prompt-regexp'.
1761 With prefix argument N, search for Nth following match.
1762 If N is negative, find the previous or Nth previous match."
1768 "Move to end of Nth next prompt in the buffer.
1769 See `comint-prompt-regexp'."
1777 "Move to end of Nth previous prompt in the buffer.
1778 See `comint-prompt-regexp'."
1781 \f
1782 ;; Support for source-file processing commands.
1783 ;;============================================================================
1784 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1785 ;; commands that process files of source text (e.g. loading or compiling
1786 ;; files). So the corresponding process-in-a-buffer modes have commands
1787 ;; for doing this (e.g., lisp-load-file). The functions below are useful
1788 ;; for defining these commands.
1789 ;;
1790 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1791 ;; and Soar, in that they don't know anything about file extensions.
1792 ;; So the compile/load interface gets the wrong default occasionally.
1793 ;; The load-file/compile-file default mechanism could be smarter -- it
1794 ;; doesn't know about the relationship between filename extensions and
1795 ;; whether the file is source or executable. If you compile foo.lisp
1796 ;; with compile-file, then the next load-file should use foo.bin for
1797 ;; the default, not foo.lisp. This is tricky to do right, particularly
1798 ;; because the extension for executable files varies so much (.o, .bin,
1799 ;; .lbin, .mo, .vo, .ao, ...).
1802 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1803 ;; commands.
1804 ;;
1805 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1806 ;; want to save the buffer before issuing any process requests to the command
1807 ;; interpreter.
1808 ;;
1809 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1810 ;; for the file to process.
1812 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1813 ;;============================================================================
1814 ;; This function computes the defaults for the load-file and compile-file
1815 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
1816 ;;
1817 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1818 ;; source-file processing command. NIL if there hasn't been one yet.
1819 ;; - SOURCE-MODES is a list used to determine what buffers contain source
1820 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1821 ;; Typically, (lisp-mode) or (scheme-mode).
1822 ;;
1823 ;; If the command is given while the cursor is inside a string, *and*
1824 ;; the string is an existing filename, *and* the filename is not a directory,
1825 ;; then the string is taken as default. This allows you to just position
1826 ;; your cursor over a string that's a filename and have it taken as default.
1827 ;;
1828 ;; If the command is given in a file buffer whose major mode is in
1829 ;; SOURCE-MODES, then the the filename is the default file, and the
1830 ;; file's directory is the default directory.
1831 ;;
1832 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1833 ;; then the default directory & file are what was used in the last source-file
1834 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1835 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1836 ;; is the cwd, with no default file. (\"no default file\" = nil)
1837 ;;
1838 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1839 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1840 ;; for Soar programs, etc.
1841 ;;
1842 ;; The function returns a pair: (default-directory . default-file).
1853 ;; (COMINT-CHECK-SOURCE fname)
1854 ;;============================================================================
1855 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1856 ;; process-in-a-buffer modes), this function can be called on the filename.
1857 ;; If the file is loaded into a buffer, and the buffer is modified, the user
1858 ;; is queried to see if he wants to save the buffer before proceeding with
1859 ;; the load or compile.
1866 ;; save BUFF.
1873 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1874 ;;============================================================================
1875 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1876 ;; commands that process source files (like loading or compiling a file).
1877 ;; It prompts for the filename, provides a default, if there is one,
1878 ;; and returns the result filename.
1879 ;;
1880 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1881 ;;
1882 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1883 ;; from the last source processing command. SOURCE-MODES is a list of major
1884 ;; modes used to determine what file buffers contain source files. (These
1885 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1886 ;; then the filename reader will only accept a file that exists.
1887 ;;
1888 ;; A typical use:
1889 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1890 ;; '(lisp-mode) t))
1892 ;; This is pretty stupid about strings. It decides we're in a string
1893 ;; if there's a quote on both sides of point on the current line.
1895 "Return string around POINT that starts the current line, or nil."
1922 prompt deffile)
1923 prompt)
1924 defdir
1926 mustmatch-p)))
1929 ;; I am somewhat divided on this string-default feature. It seems
1930 ;; to violate the principle-of-least-astonishment, in that it makes
1931 ;; the default harder to predict, so you actually have to look and see
1932 ;; what the default really is before choosing it. This can trip you up.
1933 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
1934 ;; on this.
1935 ;; -Olin
1937 \f
1938 ;; Simple process query facility.
1939 ;; ===========================================================================
1940 ;; This function is for commands that want to send a query to the process
1941 ;; and show the response to the user. For example, a command to get the
1942 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1943 ;; to an inferior Common Lisp process.
1944 ;;
1945 ;; This simple facility just sends strings to the inferior process and pops
1946 ;; up a window for the process buffer so you can see what the process
1947 ;; responds with. We don't do anything fancy like try to intercept what the
1948 ;; process responds with and put it in a pop-up window or on the message
1949 ;; line. We just display the buffer. Low tech. Simple. Works good.
1951 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
1952 ;; a window for the inferior process so that its response can be seen.
1962 ;; Try to position the proc window so you can see the answer.
1963 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1964 ;; I don't know why. Wizards invited to improve it.
1973 \f
1974 ;; Filename/command/history completion in a buffer
1975 ;; ===========================================================================
1976 ;; Useful completion functions, courtesy of the Ergo group.
1978 ;; Six commands:
1979 ;; comint-dynamic-complete Complete or expand command, filename,
1980 ;; history at point.
1981 ;; comint-dynamic-complete-filename Complete filename at point.
1982 ;; comint-dynamic-list-filename-completions List completions in help buffer.
1983 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
1984 ;; replace with expanded/completed name.
1985 ;; comint-dynamic-simple-complete Complete stub given candidates.
1987 ;; These are not installed in the comint-mode keymap. But they are
1988 ;; available for people who want them. Shell-mode installs them:
1989 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1990 ;; (define-key shell-mode-map "\M-?"
1991 ;; 'comint-dynamic-list-filename-completions)))
1992 ;;
1993 ;; Commands like this are fine things to put in load hooks if you
1994 ;; want them present in specific modes.
1997 "*If non-nil, automatically list possibilities on partial completion.
1998 This mirrors the optional behavior of tcsh."
2003 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2004 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2005 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2006 This mirrors the optional behavior of tcsh."
2011 "*If non-nil, use shortest completion if characters cannot be added.
2012 This mirrors the optional behavior of tcsh.
2014 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2019 "*List of suffixes to be disregarded during file completion.
2020 This mirrors the optional behavior of bash and tcsh.
2022 Note that this applies to `comint-dynamic-complete-filename' only."
2027 "Prefix prepended to absolute file names taken from process input.
2028 This is used by comint's and shell's completion functions, and by shell's
2033 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2035 "String of characters valid in a file name.
2036 Note that all non-ASCII characters are considered valid in a file name
2037 regardless of what this variable says.
2048 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2051 directory)))
2055 "Return the word of WORD-CHARS at point, or nil if non is found.
2056 Word constituents are considered to be those in WORD-CHARS, which is like the
2058 plus all non-ASCII characters."
2062 ;;(memq (char-after (point)) shell-file-name-quote-list)
2066 ;; Don't go forward over a word-char (this can happen if we're at bob).
2069 ;; Set match-data to match the entire string.
2075 "Return FILENAME with environment variables substituted.
2076 Supports additional environment variable syntax of the command
2077 interpreter (e.g., the percent notation of cmd.exe on NT)."
2081 env-var-val)
2090 name))
2093 "Return the filename at point, or nil if non is found.
2094 Environment variables are substituted. See `comint-word'."
2101 "Return FILENAME with magic characters quoted.
2102 Magic characters are those in `comint-file-name-quote-list'."
2104 filename
2111 filename))))
2114 "Return FILENAME with quoted characters unquoted."
2116 filename
2122 filename)))
2126 "Dynamically perform completion at point.
2127 Calls the functions in `comint-dynamic-complete-functions' to perform
2128 completion until a function returns non-nil, at which point completion is
2129 assumed to have occurred."
2135 "Dynamically complete the filename at point.
2136 Completes if after a filename. See `comint-match-partial-filename' and
2137 `comint-dynamic-complete-as-filename'.
2138 This function is similar to `comint-replace-by-expanded-filename', except that
2139 it won't change parts of the filename already entered in the buffer; it just
2140 adds completion characters to the end of the filename. A completions listing
2141 may be shown in a help buffer if completion is ambiguous.
2143 Completion is dependent on the value of `comint-completion-addsuffix',
2144 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2145 completions listing is dependent on the value of `comint-completion-autolist'.
2147 Returns t if successful."
2155 "Dynamically complete at point as a filename.
2156 See `comint-dynamic-complete-filename'. Returns t if successful."
2159 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2160 ;; I think it was originally bound to solve file completion problems,
2161 ;; but subsequent changes may have made this unnecessary. sm.
2162 ;;(file-name-handler-alist nil)
2197 ;; We inserted a unique completion.
2204 ;; It's not unique, but user wants shortest match.
2210 ;; It's not unique, list possible completions.
2215 success))
2219 "Dynamically expand and complete the filename at point.
2220 Replace the filename with an expanded, canonicalised and completed replacement.
2223 removed, and the filename is made absolute instead of relative. For expansion
2224 see `expand-file-name' and `substitute-in-file-name'. For completion see
2225 `comint-dynamic-complete-filename'."
2232 "Dynamically complete STUB from CANDIDATES list.
2233 This function inserts completion characters at point by completing STUB from
2234 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2235 if completion is ambiguous.
2237 Returns nil if no completion was inserted.
2238 Returns `sole' if completed with the only completion match.
2239 Returns `shortest' if completed with the shortest of the completion matches.
2240 Returns `partial' if completed as far as possible with the completion matches.
2241 Returns `listed' if a completion listing was shown.
2243 See also `comint-dynamic-complete-filename'."
2252 nil)
2263 ;; Insert the longest substring.
2268 ;; It's not unique, but user wants shortest match.
2274 ;; It's not unique, list possible completions.
2283 "List in help buffer possible completions of the filename at point."
2286 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2287 ;; I think it was originally bound to solve file completion problems,
2288 ;; but subsequent changes may have made this unnecessary. sm.
2289 ;;(file-name-handler-alist nil)
2302 "List in help buffer sorted COMPLETIONS.
2303 Typing SPC flushes the help buffer."
2317 ;; If the user does mouse-choose-completion with the mouse,
2318 ;; execute the command, then delete the completion window.
2325 \f
2327 "After fetching a line from input history, this fetches the following line.
2328 In other words, this recalls the input line after the line you recalled last.
2329 You can use this to repeat a sequence of input lines."
2338 "Accumulate a line to send as input along with more lines.
2339 This inserts a newline so that you can enter more text
2341 to send all the accumulated input, at once.
2342 The entire accumulated text becomes one item in the input history
2343 when you send it."
2352 "Move point to the process mark.
2353 The process mark separates output, and input already sent,
2354 from input that has not yet been sent."
2362 "Move point to beginning of line (after prompt) or to the process mark.
2363 The first time you use this command, it moves to the beginning of the line
2364 \(but after the prompt, if any). If you repeat it again immediately,
2365 it moves point to the process mark.
2367 The process mark separates the process output, along with input already sent,
2368 from input that has not yet been sent. Ordinarily, the process mark
2369 is at the beginning of the current input line; but if you have
2371 the process mark is at the beginning of the accumulated input."
2378 "Set the process mark at point."
2385 \f
2386 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2388 ;; This little add-on for comint is intended to make it easy to get
2389 ;; output from currently active comint buffers into another buffer,
2390 ;; or buffers, and then go back to using the comint shell.
2391 ;;
2392 ;; My particular use is SQL interpreters; I want to be able to execute a
2393 ;; query using the process associated with a comint-buffer, and save that
2394 ;; somewhere else. Because the process might have state (for example, it
2395 ;; could be in an uncommitted transaction), just running starting a new
2396 ;; process and having it execute the query and then finish, would not
2397 ;; work. I'm sure there are other uses as well, although in many cases
2398 ;; starting a new process is the simpler, and thus preferable, approach.
2399 ;;
2400 ;; The basic implementation is as follows: comint-redirect changes the
2401 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2402 ;; its own filter. The filter puts the output into the designated buffer,
2403 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2404 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2405 ;; sees the stop regexp, it restores the old filter functions, and runs
2406 ;; comint-redirect-hook.
2407 ;;
2408 ;; Each comint buffer may only use one redirection at a time, but any number
2409 ;; of different comint buffers may be simultaneously redirected.
2410 ;;
2411 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2412 ;; correct prompt for your interpreter, or that you supply a regexp that says
2413 ;; when the redirection is finished. Otherwise, redirection will continue
2414 ;; indefinitely. The code now does a sanity check to ensure that it can find
2415 ;; a prompt in the comint buffer; however, it is still important to ensure that
2416 ;; this prompt is set correctly.
2417 ;;
2419 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2420 ;; Variables
2421 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2424 "*If non-nil, print messages each time the redirection filter is invoked.
2425 Also print a message when redirection is completed."
2429 ;; Directly analagous to comint-preoutput-filter-functions
2431 "List of functions to call before inserting redirected process output.
2432 Each function gets one argument, a string containing the text received
2433 from the subprocess. It should return the string to insert, perhaps
2434 the same string that was received, or perhaps a modified or transformed
2435 string.
2437 The functions on the list are called sequentially, and each one is given
2438 the string returned by the previous one. The string returned by the
2443 ;; Internal variables
2449 "Regular expression that determines when to stop redirection in Comint.
2450 When the redirection filter function is given output that matches this regexp,
2454 "If non-nil, the text that ends a redirection is included in it.
2455 More precisely, the text that matches `comint-redirect-finished-regexp'
2456 and therefore terminates an output redirection is inserted in the
2469 "If non-nil, check that redirection is likely to complete successfully.
2470 More precisely, before starting a redirection, verify that the
2471 regular expression `comint-redirect-finished-regexp' that controls
2472 when to terminate it actually matches some text already in the process
2473 buffer. The idea is that this regular expression should match a prompt
2474 string, and that there ought to be at least one copy of your prompt string
2478 "The process filter that was in place when redirection is started.
2479 When redirection is completed, the process filter is restored to
2482 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2483 ;; Functions
2484 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2487 comint-buffer
2488 finished-regexp
2490 "Set up for output redirection.
2491 This function sets local variables that are used by `comint-redirect-filter'
2492 to perform redirection.
2494 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2495 in the output matches FINISHED-REGEXP.
2497 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2498 original comint buffer.
2500 This function is called by `comint-redirect-send-command-to-process',
2501 and does not normally need to be invoked by the end user or programmer."
2525 "End a Comint redirection. See `comint-redirect-send-command'."
2527 ;; Restore the process filter
2529 comint-redirect-original-filter-function)
2530 ;; Restore the mode line
2532 ;; Set the completed flag
2535 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2536 ;; that it really occurs.
2540 "Filter function which redirects output from PROCESS to a buffer or buffers.
2541 The variable `comint-redirect-output-buffer' says which buffer(s) to
2542 place output in.
2544 INPUT-STRING is the input from the comint process.
2546 This function runs as a process filter, and does not need to be invoked by the
2547 end user."
2551 ;; If we have to echo output, give it to the original filter function
2553 comint-redirect-original-filter-function
2555 process input-string)))))
2559 "Comint filter function which redirects comint output to a buffer or buffers.
2560 The variable `comint-redirect-output-buffer' says which buffer(s) to
2561 place output in.
2563 INPUT-STRING is the input from the comint process.
2565 This function does not need to be invoked by the end user."
2568 comint-redirect-output-buffer
2572 ;; If there are any filter functions, give them a chance to modify the string
2579 ;; Clobber `comint-redirect-finished-regexp'
2585 ;; Send output to all registered buffers
2589 ;; Set this buffer to the output buffer
2591 ;; Go to the end of the buffer
2593 ;; Insert the output
2595 output-buffer-list))
2597 ;; Message
2602 ;; If we see the prompt, tidy up
2603 ;; We'll look for the prompt in the original string, so nobody can
2604 ;; clobber it
2611 ;; Echo input?
2613 filtered-input-string
2616 ;;;###autoload
2618 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2619 With prefix arg, echo output in process buffer.
2621 If NO-DISPLAY is non-nil, do not show the output buffer."
2629 ;;;###autoload
2632 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2633 With prefix arg, echo output in process buffer.
2635 If NO-DISPLAY is non-nil, do not show the output buffer."
2640 process))
2642 ;; Change to the process buffer
2645 ;; Make sure there's a prompt in the current process buffer
2652 ;;;;;;;;;;;;;;;;;;;;;
2653 ;; Set up for redirection
2654 ;;;;;;;;;;;;;;;;;;;;;
2656 ;; Output Buffer
2657 output-buffer
2658 ;; Comint Buffer
2660 ;; Finished Regexp
2661 comint-prompt-regexp
2662 ;; Echo input
2663 echo)
2665 ;;;;;;;;;;;;;;;;;;;;;
2666 ;; Set the filter
2667 ;;;;;;;;;;;;;;;;;;;;;
2668 ;; Save the old filter
2673 ;;;;;;;;;;;;;;;;;;;;;
2674 ;; Send the command
2675 ;;;;;;;;;;;;;;;;;;;;;
2680 ;;;;;;;;;;;;;;;;;;;;;
2681 ;; Show the output
2682 ;;;;;;;;;;;;;;;;;;;;;
2688 output-buffer))))))
2690 ;;;###autoload
2692 "Send COMMAND to current process.
2693 Return a list of expressions in the output which match REGEXP.
2694 REGEXP-GROUP is the regular expression group in REGEXP to use."
2697 command regexp regexp-group))
2699 ;;;###autoload
2701 "Send COMMAND to PROCESS.
2702 Return a list of expressions in the output which match REGEXP.
2703 REGEXP-GROUP is the regular expression group in REGEXP to use."
2705 results)
2710 output-buffer process nil t)
2711 ;; Wait for the process to complete
2715 ;; Collect the output
2718 ;; Skip past the command, if it was echoed
2726 results)))
2727 results)))
2732 "^Empty input ring$"
2733 "^No history$"
2736 \f
2737 ;; Converting process modes to use comint mode
2738 ;; ===========================================================================
2739 ;; The code in the Emacs 19 distribution has all been modified to use comint
2740 ;; where needed. However, there are `third-party' packages out there that
2741 ;; still use the old shell mode. Here's a guide to conversion.
2742 ;;
2743 ;; Renaming variables
2744 ;; Most of the work is renaming variables and functions. These are the common
2745 ;; ones:
2746 ;; Local variables:
2747 ;; last-input-start comint-last-input-start
2748 ;; last-input-end comint-last-input-end
2749 ;; shell-prompt-pattern comint-prompt-regexp
2750 ;; shell-set-directory-error-hook <no equivalent>
2751 ;; Miscellaneous:
2752 ;; shell-set-directory <unnecessary>
2753 ;; shell-mode-map comint-mode-map
2754 ;; Commands:
2755 ;; shell-send-input comint-send-input
2756 ;; shell-send-eof comint-delchar-or-maybe-eof
2757 ;; kill-shell-input comint-kill-input
2758 ;; interrupt-shell-subjob comint-interrupt-subjob
2759 ;; stop-shell-subjob comint-stop-subjob
2760 ;; quit-shell-subjob comint-quit-subjob
2761 ;; kill-shell-subjob comint-kill-subjob
2762 ;; kill-output-from-shell comint-kill-output
2763 ;; show-output-from-shell comint-show-output
2764 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
2765 ;;
2766 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2767 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2768 ;; Comint mode does not provide functionality equivalent to
2769 ;; shell-set-directory-error-hook; it is gone.
2770 ;;
2771 ;; comint-last-input-start is provided for modes which want to munge
2772 ;; the buffer after input is sent, perhaps because the inferior
2773 ;; insists on echoing the input. The LAST-INPUT-START variable in
2774 ;; the old shell package was used to implement a history mechanism,
2775 ;; but you should think twice before using comint-last-input-start
2776 ;; for this; the input history ring often does the job better.
2777 ;;
2778 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2779 ;; *not* create the comint-mode local variables in your foo-mode function.
2780 ;; This is not modular. Instead, call comint-mode, and let *it* create the
2781 ;; necessary comint-specific local variables. Then create the
2782 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2783 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2784 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2785 ;; get-old-input) that need to be different from the defaults. Call
2786 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2787 ;; comint-mode will take care of it. The following example, from shell.el,
2788 ;; is typical:
2789 ;;
2790 ;; (defvar shell-mode-map '())
2791 ;; (cond ((not shell-mode-map)
2792 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
2793 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2794 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2795 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2796 ;; (define-key shell-mode-map "\M-?"
2797 ;; 'comint-dynamic-list-filename-completions)))
2798 ;;
2799 ;; (defun shell-mode ()
2800 ;; (interactive)
2801 ;; (comint-mode)
2802 ;; (setq comint-prompt-regexp shell-prompt-pattern)
2803 ;; (setq major-mode 'shell-mode)
2804 ;; (setq mode-name "Shell")
2805 ;; (use-local-map shell-mode-map)
2806 ;; (make-local-variable 'shell-directory-stack)
2807 ;; (setq shell-directory-stack nil)
2808 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2809 ;; (run-hooks 'shell-mode-hook))
2810 ;;
2811 ;;
2812 ;; Completion for comint-mode users
2813 ;;
2814 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2815 ;; hook to add completion functions to. Functions on this list should return
2816 ;; non-nil if completion occurs (i.e., further completion should not occur).
2817 ;; You could use comint-dynamic-simple-complete to do the bulk of the
2818 ;; completion job.
2819 \f
2822 ;; comint.el ends here