| blob | a3cc276c0aa301ba17f3205c605f9495fb550e97 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; Please send me bug reports, bug fixes, and extensions, so that I can
31 ;; merge them into the master source.
32 ;; - Olin Shivers (shivers@cs.cmu.edu)
33 ;; - Simon Marshall (simon@gnu.org)
35 ;; This file defines a general command-interpreter-in-a-buffer package
36 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
37 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
38 ;; This way, all these specific packages share a common base functionality,
39 ;; and a common set of bindings, which makes them easier to use (and
40 ;; saves code, implementation time, etc., etc.).
42 ;; Several packages are already defined using comint mode:
43 ;; - shell.el defines a shell-in-a-buffer mode.
44 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
45 ;;
46 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
47 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
48 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
49 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
50 ;; previewers, and printers from within emacs.
51 ;; - background.el allows csh-like job control inside emacs.
52 ;; It is pretty easy to make new derived modes for other processes.
54 ;; For documentation on the functionality provided by comint mode, and
55 ;; the hooks available for customising it, see the comments below.
56 ;; For further information on the standard derived modes (shell,
57 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
59 ;; For hints on converting existing process modes (e.g., tex-mode,
60 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
61 ;; instead of shell-mode, see the notes at the end of this file.
63 \f
64 ;; Brief Command Documentation:
65 ;;============================================================================
66 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
67 ;; mode)
68 ;;
69 ;; m-p comint-previous-input Cycle backwards in input history
70 ;; m-n comint-next-input Cycle forwards
71 ;; m-r comint-previous-matching-input Previous input matching a regexp
72 ;; m-s comint-next-matching-input Next input that matches
73 ;; m-c-l comint-show-output Show last batch of process output
74 ;; return comint-send-input
75 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
76 ;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
77 ;; second time, move to process-mark.
78 ;; c-c c-u comint-kill-input ^u
79 ;; c-c c-w backward-kill-word ^w
80 ;; c-c c-c comint-interrupt-subjob ^c
81 ;; c-c c-z comint-stop-subjob ^z
82 ;; c-c c-\ comint-quit-subjob ^\
83 ;; c-c c-o comint-delete-output Delete last batch of process output
84 ;; c-c c-r comint-show-output Show last batch of process output
85 ;; c-c c-l comint-dynamic-list-input-ring List input history
86 ;;
87 ;; Not bound by default in comint-mode (some are in shell mode)
88 ;; comint-run Run a program under comint-mode
89 ;; send-invisible Read a line w/o echo, and send to proc
90 ;; comint-dynamic-complete-filename Complete filename at point.
91 ;; comint-dynamic-complete-variable Complete variable name at point.
92 ;; comint-dynamic-list-filename-completions List completions in help buffer.
93 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
94 ;; replace with expanded/completed name.
95 ;; comint-replace-by-expanded-history Expand history at point;
96 ;; replace with expanded name.
97 ;; comint-magic-space Expand history and add (a) space(s).
98 ;; comint-kill-subjob No mercy.
99 ;; comint-show-maximum-output Show as much output as possible.
100 ;; comint-continue-subjob Send CONT signal to buffer's process
101 ;; group. Useful if you accidentally
102 ;; suspend your process (with C-c C-z).
103 ;; comint-get-next-from-history Fetch successive input history lines
104 ;; comint-accumulate Combine lines to send them together
105 ;; as input.
106 ;; comint-goto-process-mark Move point to where process-mark is.
107 ;; comint-set-process-mark Set process-mark to point.
109 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
111 ;;; Code:
114 \f
115 ;; Buffer Local Variables:
116 ;;============================================================================
117 ;; Comint mode buffer local variables:
118 ;; comint-prompt-regexp string comint-bol uses to match prompt
119 ;; comint-delimiter-argument-list list For delimiters and arguments
120 ;; comint-last-input-start marker Handy if inferior always echoes
121 ;; comint-last-input-end marker For comint-delete-output command
122 ;; comint-input-ring-size integer For the input history
123 ;; comint-input-ring ring mechanism
124 ;; comint-input-ring-index number ...
125 ;; comint-save-input-ring-index number ...
126 ;; comint-input-autoexpand symbol ...
127 ;; comint-input-ignoredups boolean ...
128 ;; comint-dynamic-complete-functions hook For the completion mechanism
129 ;; comint-completion-fignore list ...
130 ;; comint-file-name-chars string ...
131 ;; comint-file-name-quote-list list ...
132 ;; comint-get-old-input function Hooks for specific
133 ;; comint-input-filter-functions hook process-in-a-buffer
134 ;; comint-output-filter-functions hook function modes.
135 ;; comint-preoutput-filter-functions hook
136 ;; comint-input-filter function ...
137 ;; comint-input-sender function ...
138 ;; comint-eol-on-send boolean ...
139 ;; comint-process-echoes boolean ...
140 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
141 ;; comint-scroll-to-bottom-on-output symbol ...
142 ;; comint-scroll-show-maximum-output boolean ...
143 ;; comint-accum-marker maker For comint-accumulate
144 ;; comint-last-output-overlay overlay
145 ;;
146 ;; Comint mode non-buffer local variables:
147 ;; comint-completion-addsuffix boolean/cons For file name
148 ;; comint-completion-autolist boolean completion behavior
149 ;; comint-completion-recexact boolean ...
152 "General command interpreter in a window stuff."
156 "Completion facilities in comint"
160 "Source finding facilities in comint"
165 "Regexp to recognise prompts in the inferior process.
168 This variable is only used if the variable
169 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
171 Good choices:
182 "List of characters to recognise as separate arguments in input.
183 Strings comprising a character in this list will separate the arguments
184 surrounding them, and also be regarded as arguments in their own right (unlike
185 whitespace). See `comint-arguments'.
186 Defaults to the empty list.
193 "*If non-nil, expand input command history references on completion.
194 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
196 If the value is `input', then the expansion is seen on input.
197 If the value is `history', then the expansion is only when inserting
198 into the buffer's input ring. See also `comint-magic-space' and
199 `comint-dynamic-complete'.
201 This variable is buffer-local."
209 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
210 The face used is `comint-highlight-input'."
215 "Face to use to highlight input when `comint-highlight-input' is non-nil."
219 "*If non-nil, highlight program prompts.
220 The face used is `comint-highlight-prompt'."
226 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
230 "*If non-nil, don't add input matching the last on the input ring.
231 This mirrors the optional behavior of bash.
233 This variable is buffer-local."
238 "*If non-nil, name of the file to read/write input history.
239 See also `comint-read-input-ring' and `comint-write-input-ring'.
241 This variable is buffer-local, and is a good thing to set in mode hooks."
243 file)
247 "*Controls whether input to interpreter causes window to scroll.
248 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
249 If `this', scroll only the selected window.
251 The default is nil.
253 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
261 "*Controls whether interpreter output causes window to scroll.
262 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
263 If `this', scroll only the selected window.
264 If `others', scroll only those that are not the selected window.
266 The default is nil.
268 See variable `comint-scroll-show-maximum-output' and function
269 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
278 "*Controls how interpreter output causes window to scroll.
279 If non-nil, then show the maximum output when the window is scrolled.
281 See variable `comint-scroll-to-bottom-on-output' and function
282 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
287 "*The maximum size in lines for comint buffers.
288 Comint buffers are truncated from the top to be no greater than this number, if
289 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
300 "*If non-nil, assume that the subprocess echoes any input.
301 If so, delete one copy of the input so that only one copy eventually
302 appears in the buffer.
304 This variable is buffer-local."
308 ;; AIX puts the name of the person being su'd to in front of the prompt.
309 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
310 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
311 ;; ssh-add prints a prompt like `Enter passphrase: '.
312 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
317 "*Regexp matching prompts for passwords in the inferior process.
318 This is used by `comint-watch-for-password-prompt'."
322 ;; Here are the per-interpreter hooks.
324 "Function that returns old text in comint mode.
325 This function is called when return is typed while the point is in old
326 text. It returns the text to be submitted as process input. The
327 default is `comint-get-old-input-default', which either grabs the
328 current input field or grabs the current line and strips off leading
329 text matching `comint-prompt-regexp', depending on the value of
334 "List of functions called to perform completion.
335 Functions should return non-nil if completion was performed.
336 See also `comint-dynamic-complete'.
342 "Predicate for filtering additions to input history.
343 Takes one argument, the input. If non-nil, the input may be saved on the input
347 "Functions to call before input is sent to the process.
348 These functions get one argument, a string containing the text to send.
353 "Functions to call after output is inserted into the buffer.
354 One possible function is `comint-postoutput-scroll-to-bottom'.
355 These functions get one argument, a string containing the text as originally
356 inserted. Note that this might not be the same as the buffer contents between
357 `comint-last-output-start' and the buffer's `process-mark', if other filter
358 functions have already modified the buffer.
360 See also `comint-preoutput-filter-functions'.
365 "Function to actually send to PROCESS the STRING submitted by user.
366 Usually this is just `comint-simple-send', but if your mode needs to
367 massage the input string, put a different function here.
368 `comint-simple-send' just sends the string plus a newline.
372 "*Non-nil means go to the end of the line before sending input.
373 See `comint-send-input'."
377 ;; Note: If it is decided to purge comint-prompt-regexp from the source
378 ;; entirely, searching for uses of this variable will help to identify
379 ;; places that need attention.
381 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
382 If nil, then program output and user-input are given different `field'
383 properties, which emacs commands can use to distinguish them (in
384 particular, common movement commands such as begining-of-line respect
385 field boundaries in a natural way)."
390 "Called upon entry into `comint-mode'
391 This is run before the process is cranked up."
396 "Called each time a process is exec'd by `comint-exec'.
397 This is called after the process is cranked up. It is useful for things that
398 must be done each time a process is executed in a comint mode buffer (e.g.,
399 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
400 executed once when the buffer is created."
407 "Non-nil if communications via pty; false if by pipe. Buffer local.
419 "Last input ring index which you copied.
423 "Non-nil if you are accumulating input lines to send as input together.
442 "Major mode for interacting with an inferior interpreter.
443 Interpreter name is same as buffer name, sans the asterisks.
444 Return at end of buffer sends line as input.
445 Return not at end copies rest of line to end and sends it.
446 Setting variable `comint-eol-on-send' means jump to the end of the line
447 before submitting new input.
449 This mode is customised to create major modes such as Inferior Lisp
450 mode, Shell mode, etc. This can be done by setting the hooks
451 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
452 and `comint-get-old-input' to appropriate functions, and the variable
453 `comint-prompt-regexp' to the appropriate regular expression.
455 An input history is maintained of size `comint-input-ring-size', and
456 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
457 Input ring history expansion can be achieved with the commands
459 Input ring expansion is controlled by the variable `comint-input-autoexpand',
460 and addition is controlled by the variable `comint-input-ignoredups'.
462 Commands with no default key bindings include `send-invisible',
463 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
464 `comint-magic-space'.
466 Input to, and output from, the subprocess can cause the window to scroll to
467 the end of the buffer. See variables `comint-output-filter-functions',
468 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
469 and `comint-scroll-to-bottom-on-output'.
472 to continue it.
476 Entry to this mode runs the hooks on `comint-mode-hook'."
527 nil
528 ;; Keys:
558 ;; Mouse Buttons:
560 ;; Menu bars:
561 ;; completion:
572 ;; Input history:
613 ;; Signals
628 ;; Put them in the menu bar:
630 menu-bar-final-items))
631 )
634 "Return t if there is a living process associated w/buffer BUFFER.
635 Living means the status is `open', `run', or `stop'.
636 BUFFER can be either a buffer or the name of one."
640 ;;;###autoload
642 "Make a comint process NAME in a buffer, running PROGRAM.
643 The name of the buffer is made by surrounding NAME with `*'s.
644 PROGRAM should be either a string denoting an executable program to create
645 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
646 connection to be opened via `open-network-stream'. If there is already a
647 running process in that buffer, it is not restarted. Optional third arg
648 STARTFILE is the name of a file to send the contents of to the process.
650 If PROGRAM is a string, any more args are arguments to PROGRAM."
654 ;; If no process, or nuked process, crank up a new one and put buffer in
655 ;; comint mode. Otherwise, leave buffer and existing process alone.
660 buffer))
662 ;;;###autoload
664 "Run PROGRAM in a comint buffer and switch to it.
665 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
666 The file name is used to make a symbol name, such as `comint-sh-hook', and any
667 hooks on this symbol are run in the buffer.
668 See `make-comint' and `comint-exec'."
675 "Start up a process in buffer BUFFER for comint modes.
676 Blasts any old process running in the buffer. Doesn't set the buffer mode.
677 You can use this to cheaply run a series of processes in the same comint
678 buffer. The hook `comint-exec-hook' is run after each exec."
683 ;; Crank up a new process
691 ;; Jump to the end, and set the process mark.
694 ;; Feed it the startfile.
696 ;;This is guaranteed to wait long enough
697 ;;but has bad results if the comint does not prompt at all
698 ;; (while (= size (buffer-size))
699 ;; (sleep-for 1))
700 ;;I hope 1 second is enough!
708 buffer)))
710 ;; This auxiliary function cranks up the process for comint-exec in
711 ;; the appropriate environment.
716 ;; If using termcap, we specify `emacs' as the terminal type
717 ;; because that lets us specify a width.
718 ;; If using terminfo, we specify `dumb' because that is
719 ;; a defined terminal type. `emacs' is not a defined terminal type
720 ;; and there is no way for us to define it here.
721 ;; Some programs that use terminfo get very confused
722 ;; if TERM is not a valid terminal type.
729 process-environment))
732 default-directory
734 proc decoding encoding changed)
736 ;; If the command has slashes, make sure we
737 ;; first look relative to the current directory.
743 ;; If start-process decided to use some coding system for decoding
744 ;; data sent from the process and the coding system doesn't
745 ;; specify EOL conversion, we had better convert CRLF to LF.
748 changed t))
749 ;; Even if start-process left the coding system for encoding data
750 ;; sent from the process undecided, we had better use the same one
751 ;; as what we use for decoding. But, we should suppress EOL
752 ;; conversion.
755 changed t))
758 proc))
762 "In a comint buffer, set the current input to the clicked-on previous input."
765 ;; Ignore non-input overlays
769 ;; do we have input in this area?
774 ;; Can't use kill-region as it sets this-command
779 ;; fall back to the user's previous definition if we aren't
780 ;; on previous input region.
784 \f
785 ;; Input history processing in a buffer
786 ;; ===========================================================================
787 ;; Useful input history functions, courtesy of the Ergo group.
789 ;; Eleven commands:
790 ;; comint-dynamic-list-input-ring List history in help buffer.
791 ;; comint-previous-input Previous input...
792 ;; comint-previous-matching-input ...matching a string.
793 ;; comint-previous-matching-input-from-input ... matching the current input.
794 ;; comint-next-input Next input...
795 ;; comint-next-matching-input ...matching a string.
796 ;; comint-next-matching-input-from-input ... matching the current input.
797 ;; comint-backward-matching-input Backwards input...
798 ;; comint-forward-matching-input ...matching a string.
799 ;; comint-replace-by-expanded-history Expand history at point;
800 ;; replace with expanded history.
801 ;; comint-magic-space Expand history and insert space.
802 ;;
803 ;; Three functions:
804 ;; comint-read-input-ring Read into comint-input-ring...
805 ;; comint-write-input-ring Write to comint-input-ring-file-name.
806 ;; comint-replace-by-expanded-history-before-point Workhorse function.
809 "Sets the buffer's `comint-input-ring' from a history file.
810 The name of the file is given by the variable `comint-input-ring-file-name'.
811 The history ring is of size `comint-input-ring-size', regardless of file size.
812 If `comint-input-ring-file-name' is nil this function does nothing.
814 If the optional argument SILENT is non-nil, we say nothing about a
815 failure to read the history file.
817 This function is useful for major mode commands and mode hooks.
819 The commands stored in the history file are separated by the
820 `comint-input-ring-separator'. The most recent command comes last.
822 See also `comint-input-ignoredups' and `comint-write-input-ring'."
825 nil)
829 comint-input-ring-file-name)))
842 ;; Save restriction in case file is already visited...
843 ;; Watch for those date stamps in history files!
862 comint-input-ring-index nil)))))
865 "Writes the buffer's `comint-input-ring' to a history file.
866 The name of the file is given by the variable `comint-input-ring-file-name'.
867 The original contents of the file are lost if `comint-input-ring' is not empty.
868 If `comint-input-ring-file-name' is nil this function does nothing.
870 Useful within process sentinels.
872 See also `comint-read-input-ring'."
876 nil)
884 ;; Write it all out into a buffer first. Much faster, but messier,
885 ;; than writing it one line at a time.
897 "List in help buffer the buffer's input history."
906 ;; We have to build up a list ourselves from the ring vector.
910 ;; Change "completion" to "history reference"
911 ;; to make the display accurate.
927 ;; Return list of regexp and prefix arg using PROMPT.
935 regexp)
939 ;; First make sure there is a ring and that we are after the process mark
946 ;; arg of zero resets search from beginning, and uses arg of 1
950 arg)))
953 ;; Index to start a directional search, starting at comint-input-ring-index
955 ;; If a search is running, offset by 1 in direction of arg
958 ;; For a new search, start from beginning or end, as appropriate
964 "Return the string ARG places along the input ring.
965 Moves relative to `comint-input-ring-index'."
969 arg)))
972 "Cycle backwards through input history."
977 "Cycle forwards through input history."
982 "Return the string matching REGEXP ARG places along the input ring.
983 Moves relative to `comint-input-ring-index'."
988 "Return the index matching REGEXP ARG places along the input ring.
989 Moves relative to START, or `comint-input-ring-index'."
998 ;; Do the whole search as many times as the argument says.
1000 ;; Step once.
1003 ;; If we haven't reached a match, step some more.
1007 ;; If we have gone all the way around in this search.
1010 ;; Now that we know which ring element to use, if we found it, return that.
1012 n)))
1015 "Search backwards through input history for match for REGEXP.
1016 \(Previous history elements are earlier commands.)
1017 With prefix argument N, search for Nth previous match.
1018 If N is negative, find the next or Nth next match."
1022 ;; Has a match been found?
1028 ;; Can't use kill-region as it sets this-command
1035 "Search forwards through input history for match for REGEXP.
1036 \(Later history elements are more recent commands.)
1037 With prefix argument N, search for Nth following match.
1038 If N is negative, find the previous or Nth previous match."
1043 "Search backwards through input history for match for current input.
1044 \(Previous history elements are earlier commands.)
1045 With prefix argument N, search for Nth previous match.
1046 If N is negative, search forwards for the -Nth following match."
1049 comint-next-matching-input-from-input)))
1050 ;; Starting a new search
1056 comint-input-ring-index nil))
1059 arg))
1062 "Search forwards through input history for match for current input.
1063 \(Following history elements are more recent commands.)
1064 With prefix argument N, search for Nth following match.
1065 If N is negative, search backwards for the -Nth previous match."
1071 "Expand input command history references before point.
1072 Expansion is dependent on the value of `comint-input-autoexpand'.
1074 This function depends on the buffer's idea of the input history, which may not
1075 match the command interpreter's idea, assuming it has one.
1077 Assumes history syntax is like typical Un*x shells'. However, since emacs
1078 cannot know the interpreter's idea of input line numbers, assuming it has one,
1079 it cannot expand absolute input line number references.
1081 If the optional argument SILENT is non-nil, never complain
1082 even if history reference seems erroneous.
1084 If the optional argument START is non-nil, that specifies the
1085 start of the text to scan for history references, rather
1086 than the logical beginning of line.
1088 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1090 Returns t if successful."
1095 ;; Use comint-prompt-regexp
1098 ;; Use input fields. User input that hasn't been entered
1099 ;; yet, at the end of the buffer, has a nil `field' property.
1101 ;; Looks like there might be history references in the command.
1108 "Expand directory stack reference before point.
1109 See `comint-replace-by-expanded-history'. Returns t if successful.
1111 If the optional argument START is non-nil, that specifies the
1112 start of the text to scan for history references, rather
1113 than the logical beginning of line."
1120 ;; This seems a bit complex. We look for references such as !!, !-num,
1121 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1122 ;; If that wasn't enough, the plings can be suffixed with argument
1123 ;; range specifiers.
1124 ;; Argument ranges are complex too, so we hive off the input line,
1125 ;; referenced with plings, with the range string to `comint-args'.
1129 ;; The history is quoted, or we're in quotes.
1132 ;; We cannot know the interpreter's idea of input line numbers.
1136 ;; Just a number of args from `number' lines backward.
1145 t t)
1151 ;; Just a number of args from the previous input line.
1155 t t)
1159 ;; Most recent input starting with or containing (possibly
1160 ;; protected) string, maybe just a number of args. Phew.
1178 t t)
1181 ;; Quick substitution on the previous input line.
1198 "Expand input history references before point and insert ARG spaces.
1199 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1203 \f
1205 "Return t if the number of quotes between BEG and END is odd.
1206 Quotes are single and double."
1212 "Return number of matches for REGEXP from BEG to END."
1219 count))
1222 ;; From STRING, return the args depending on the range specified in the text
1223 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1224 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1240 ;; Return a list of arguments from ARG. Break it up at the
1241 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1256 comint-delimiter-argument-list)))
1259 args)))
1262 "Return from STRING the NTH to MTH arguments.
1263 NTH and/or MTH can be nil, which means the last argument.
1264 Returned arguments are separated by single spaces.
1265 We assume whitespace separates arguments, except within quotes
1266 and except for a space or tab that immediately follows a backslash.
1267 Also, a run of one or more of a single character
1268 in `comint-delimiter-argument-list' is a separate argument.
1269 Argument 0 is the command name."
1270 ;; The first line handles ordinary characters and backslash-sequences
1271 ;; (except with w32 msdos-like shells, where backslashes are valid).
1272 ;; The second matches "-quoted strings.
1273 ;; The third matches '-quoted strings.
1274 ;; The fourth matches `-quoted strings.
1275 ;; This seems to fit the syntax of BASH 2.0.
1286 beg str value quotes)
1287 ;; Build a list of all the args until we have as many as we want.
1291 ;; It's contiguous, part of the same arg.
1294 ;; It's a new separate arg.
1296 ;; Put the previous arg, if there was one, onto ARGS.
1313 \f
1314 ;;
1315 ;; Input processing stuff
1316 ;;
1319 "Send input to process.
1320 After the process output mark, sends all text from the process mark to
1321 point as input to the process. Before the process output mark, calls value
1322 of variable `comint-get-old-input' to retrieve old input, copies it to the
1323 process mark, and sends it. If variable `comint-process-echoes' is nil,
1324 a terminal newline is also inserted into the buffer and sent to the process
1325 \(if it is non-nil, all text from the process mark to point is deleted,
1326 since it is assumed the remote process will re-echo it).
1328 Any history reference may be expanded depending on the value of the variable
1329 `comint-input-autoexpand'. The list of function names contained in the value
1330 of `comint-input-filter-functions' is called on the input before sending it.
1331 The input is entered into the input history ring, if the value of variable
1332 `comint-input-filter' returns non-nil when called on the input.
1334 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1335 end of line before sending the input.
1337 The values of `comint-get-old-input', `comint-input-filter-functions', and
1338 `comint-input-filter' are chosen according to the command interpreter running
1339 in the buffer. E.g.,
1341 If the interpreter is the csh,
1342 comint-get-old-input is the default: either return the current
1343 field, or take the current line and discard any
1344 initial string matching regexp `comint-prompt-regexp', depending
1345 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1348 comint-input-filter is the default: returns t if the input isn't all white
1349 space.
1351 If the comint is Lucid Common Lisp,
1352 comint-get-old-input snarfs the sexp ending at point.
1353 comint-input-filter-functions does nothing.
1354 comint-input-filter returns nil if the input matches input-filter-regexp,
1355 which matches (1) all whitespace (2) :a, :c, etc.
1357 Similarly for Soar, Scheme, etc."
1359 ;; Note that the input string does not include its terminal newline.
1369 copy)))
1371 ;; Just whatever's already there
1372 intxt
1373 ;; Expand and leave it visible in buffer
1377 input
1378 ;; This is messy 'cos ultimately the original
1379 ;; functions used do insertion, rather than return
1380 ;; strings. We have to expand, then insert back.
1386 copy))))
1397 history))))
1406 ;; Make an overlay for the input field
1409 ;; Give old user input a field property of `input', to
1410 ;; distinguish it from both process output and unsent
1411 ;; input. The terminating newline is put into a special
1412 ;; `boundary' field to make cursor movement between input
1413 ;; and output fields smoother.
1420 ;; Make an overlay for the terminating newline
1429 ;; Update the markers before we send the input
1430 ;; in case we get output amidst sending the input.
1434 ;; clear the "accumulation" marker
1437 ;; This used to call comint-output-filter-functions,
1438 ;; but that scrolled the buffer in undesirable ways.
1442 "List of functions to call before inserting Comint output into the buffer.
1443 Each function gets one argument, a string containing the text received
1444 from the subprocess. It should return the string to insert, perhaps
1445 the same string that was received, or perhaps a modified or transformed
1446 string.
1448 The functions on the list are called sequentially, and each one is
1449 given the string returned by the previous one. The string returned by
1450 the last function is the text that is actually inserted in the
1451 redirection buffer.
1455 ;; When non-nil, this is the last overlay used for output.
1456 ;; It is kept around so that we can extend it instead of creating
1457 ;; multiple contiguous overlays for multiple contiguous output chunks.
1460 ;; When non-nil, this is an overlay over the last recognized prompt in
1461 ;; the buffer; it is used when highlighting the prompt.
1464 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1465 ;; Any further output will then create a new comint-last-prompt-overlay.
1471 ;; The purpose of using this filter for comint processes
1472 ;; is to keep comint-last-input-end from moving forward
1473 ;; when output is inserted.
1476 ;; First check for killed buffer or no input.
1479 ;; Run preoutput filters
1485 ;; Insert STRING
1487 ;; Avoid the overhead of save-excursion, since we just
1488 ;; fiddle with the point
1491 ;; The point should float after any insertion we do
1494 ;; We temporarly remove any buffer narrowing, in case the
1495 ;; process mark is outside of the restriction
1502 ;; insert-before-markers is a bad thing. XXX
1503 ;;
1504 ;; It is used here to force window-point markers (used to
1505 ;; store the value of point in non-selected windows) to
1506 ;; advance, but it also screws up any other markers that we
1507 ;; don't _want_ to advance, such as the start-marker of some
1508 ;; of the overlays we create.
1509 ;;
1510 ;; We work around the problem with the overlays by
1511 ;; explicitly adjusting them after we do the insertion, but
1512 ;; in the future this problem should be solved correctly, by
1513 ;; using `insert', and making the insertion-type of
1514 ;; window-point markers settable (via a buffer-local
1515 ;; variable). In comint buffers, this variable would be set
1516 ;; to `t', to cause point in non-select windows to advance.
1518 ;; Fixup markers and overlays that got screwed up because we
1519 ;; used `insert-before-markers'.
1521 ;; comint-last-output-start
1523 ;; comint-last-input-end
1528 ;; No overlays we create are set to advance upon insertion
1529 ;; (at the start/end), so we assume that any overlay which
1530 ;; is at the current point was incorrectly advanced by
1531 ;; insert-before-markers. First fixup overlays that might
1532 ;; start at point:
1537 old-point
1539 ;; Then do overlays that might end at point:
1544 old-point))))
1546 ;; Advance process-mark
1550 ;; We check to see if the last overlay used for output is
1551 ;; adjacent to the new input, and if so, just extend it.
1555 ;; Extend comint-last-output-overlay to include the
1556 ;; most recent output
1560 ;; Create a new overlay
1568 ;; Highlight the prompt, where we define `prompt' to mean
1569 ;; the most recent output that doesn't end with a newline.
1571 ;; Need to create or move the prompt overlay (in the case
1572 ;; where there is no prompt ((bolp) == t), we still do
1573 ;; this if there's already an existing overlay).
1576 ;; Just move an existing overlay
1579 ;; Need to create the overlay
1590 "Go to the end of buffer in all windows showing it.
1591 Movement occurs if point in the selected window is not after the process mark,
1592 and `this-command' is an insertion command. Insertion commands recognised
1593 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1594 Depends on the value of `comint-scroll-to-bottom-on-input'.
1596 This function should be a pre-command hook."
1599 hilit-yank)))
1615 nil t))))))
1618 "Go to the end of buffer in all windows showing it.
1619 Does not scroll if the current line is the last line in the buffer.
1620 Depends on the value of `comint-scroll-to-bottom-on-output' and
1621 `comint-scroll-show-maximum-output'.
1623 This function should be in the list `comint-output-filter-functions'."
1637 ;; Maybe user wants point to jump to end.
1640 ;; If point was at the end, keep it at end.
1644 ;; Optionally scroll so that the text
1645 ;; ends at the bottom of the window.
1652 nil t))
1656 "Truncate the buffer to `comint-buffer-maximum-size'.
1657 This function could be on `comint-output-filter-functions' or bound to a key."
1666 "Strip trailing `^M' characters from the current output group.
1667 This function could be on `comint-output-filter-functions' or bound to a key."
1680 "Put the end of the buffer at the bottom of the window."
1686 "Default for `comint-get-old-input'.
1687 Returns either the current field, or the current line with any initial
1688 text matching `comint-prompt-regexp' stripped off, depending on the
1689 value of `comint-use-prompt-regexp-instead-of-fields'."
1697 ;; Return the contents of the field at the current point.
1702 "Insert after prompt old input at point as new input to be edited.
1703 Calls `comint-get-old-input' to get old input."
1713 "Skip past the text matching regexp `comint-prompt-regexp'.
1714 If this takes us past the end of the current line, don't skip at all."
1721 "Return t if point is after the process output marker."
1726 "Default function for sending to PROC input STRING.
1727 This just sends STRING plus a newline. To override this,
1728 set the hook `comint-input-sender'."
1733 "Returns the buffer position of the beginning of the line, after any prompt.
1734 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1735 prompt skip is done by skipping text matching the regular expression
1736 `comint-prompt-regexp', a buffer local variable."
1738 ;; Use comint-prompt-regexp
1743 ;; Use input fields. Note that, unlike the behavior of
1744 ;; `line-beginning-position' inside a field, this function will
1745 ;; return the position of the end of a prompt, even if the point is
1746 ;; already inside the prompt. In order to do this, it assumes that
1747 ;; if there are two fields on a line, then the first one is the
1748 ;; prompt, and the second one is an input field, and is front-sticky
1749 ;; (as input fields should be).
1753 "Goes to the beginning of line, then skips past the prompt, if any.
1755 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1756 prompt skip is done by skipping text matching the regular expression
1757 `comint-prompt-regexp', a buffer local variable."
1760 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1764 ;; These three functions are for entering text you don't want echoed or
1765 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1766 ;; Just enter m-x send-invisible and type in your line, or add
1767 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1770 "Read a single line of text from user without echoing, and return it.
1771 Prompt with argument PROMPT, a string. Optional argument STARS causes
1772 input to be echoed with '*' characters on the prompt line. Input ends with
1773 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1774 `inhibit-quit' is set because e.g. this function was called from a process
1775 filter and C-g is pressed, this function returns nil rather than a string).
1777 Note that the keystrokes comprising the text can still be recovered
1779 Once the caller uses the password, it can erase the password
1780 by doing (fillarray STRING 0)."
1792 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1795 ;; This function may get called from a process filter, where
1796 ;; inhibit-quit is set. In later versions of emacs read-char
1797 ;; may clear quit-flag itself and return C-g. That would make
1798 ;; it impossible to quit this loop in a simple way, so
1799 ;; re-enable it here (for backward-compatibility the check for
1800 ;; quit-flag below would still be necessary, so this seems
1801 ;; like the simplest way to do things).
1803 done t))
1817 ;; Emulate a true quit, except that we have to return a value.
1823 ans)))
1826 "Read a string without echoing.
1827 Then send it to the process running in the current buffer.
1828 The string is sent using `comint-input-sender'.
1829 Security bug: your string can still be temporarily recovered with
1845 "Prompt in the minibuffer for password and send without echoing.
1846 This function uses `send-invisible' to read and send a password to the buffer's
1847 process if STRING contains a password prompt defined by
1848 `comint-password-prompt-regexp'.
1850 This function could be in the list `comint-output-filter-functions'."
1854 \f
1855 ;; Low-level process communication
1858 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1864 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1868 \f
1869 ;; Random input hackage
1872 "Delete all output from interpreter since last input.
1873 Does not delete the prompt."
1886 ;; Output message and put back prompt
1892 "Write output from interpreter since last input to FILENAME.
1893 Any prompt at the end of the output is not written.
1895 If the optional argument APPEND (the prefix argument when interactive)
1896 is non-nil, the output is appended to the file instead.
1898 If the optional argument MUSTBENEW is non-nil, check for an existing
1899 file with the same name. If MUSTBENEW is `excl', that means to get an
1900 error if the file already exists; never overwrite. If MUSTBENEW is
1901 neither nil nor `excl', that means ask for confirmation before
1902 overwriting, but do go ahead and overwrite the file if the user
1903 confirms. When interactive, MUSTBENEW is nil when appending, and t
1904 otherwise."
1908 "Append output to file: "
1910 current-prefix-arg
1916 append nil nil mustbenew)))
1919 "Display start of this batch of interpreter output at top of window.
1920 Sets mark to the value of point when this command is run."
1935 "Interrupt the current subjob.
1936 This command also kills the pending input
1937 between the process-mark and point."
1943 "Send kill signal to the current subjob.
1944 This command also kills the pending input
1945 between the process-mark and point."
1951 "Send quit signal to the current subjob.
1952 This command also kills the pending input
1953 between the process-mark and point."
1959 "Stop the current subjob.
1960 This command also kills the pending input
1961 between the process-mark and point.
1963 WARNING: if there is no current subjob, you can end up suspending
1964 the top-level process running in the buffer. If you accidentally do
1966 is not a problem with most shells, since they ignore this signal.)"
1972 "Send CONT signal to process buffer's process group.
1973 Useful if you accidentally suspend the top-level process."
1978 "Kill all text from last stuff output by interpreter to point."
1985 "Delete ARG characters forward or send an EOF to subprocess.
1986 Sends an EOF only if point is at the end of the buffer and there is no input."
1994 "Send an EOF to the current buffer's process."
2001 "Search backward through buffer for input fields that match REGEXP.
2002 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2003 fields are identified by lines that match `comint-prompt-regexp'.
2005 With prefix argument N, search for Nth previous match.
2006 If N is negative, find the next or Nth next match."
2009 ;; Use comint-prompt-regexp
2019 ;; Use input fields
2033 "Search forward through buffer for input fields that match REGEXP.
2034 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2035 fields are identified by lines that match `comint-prompt-regexp'.
2037 With prefix argument N, search for Nth following match.
2038 If N is negative, find the previous or Nth previous match."
2044 "Move to end of Nth next prompt in the buffer.
2045 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2046 the beginning of the Nth next `input' field, otherwise, it means the Nth
2047 occurance of text matching `comint-prompt-regexp'."
2050 ;; Use comint-prompt-regexp
2055 ;; Use input fields
2064 ;; Ran off the end of the buffer.
2074 "Move to end of Nth previous prompt in the buffer.
2075 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2076 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2077 occurance of text matching `comint-prompt-regexp'."
2080 \f
2081 ;; Support for source-file processing commands.
2082 ;;============================================================================
2083 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2084 ;; commands that process files of source text (e.g. loading or compiling
2085 ;; files). So the corresponding process-in-a-buffer modes have commands
2086 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2087 ;; for defining these commands.
2088 ;;
2089 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2090 ;; and Soar, in that they don't know anything about file extensions.
2091 ;; So the compile/load interface gets the wrong default occasionally.
2092 ;; The load-file/compile-file default mechanism could be smarter -- it
2093 ;; doesn't know about the relationship between filename extensions and
2094 ;; whether the file is source or executable. If you compile foo.lisp
2095 ;; with compile-file, then the next load-file should use foo.bin for
2096 ;; the default, not foo.lisp. This is tricky to do right, particularly
2097 ;; because the extension for executable files varies so much (.o, .bin,
2098 ;; .lbin, .mo, .vo, .ao, ...).
2101 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2102 ;; commands.
2103 ;;
2104 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2105 ;; want to save the buffer before issuing any process requests to the command
2106 ;; interpreter.
2107 ;;
2108 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2109 ;; for the file to process.
2111 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2112 ;;============================================================================
2113 ;; This function computes the defaults for the load-file and compile-file
2114 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2115 ;;
2116 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2117 ;; source-file processing command. NIL if there hasn't been one yet.
2118 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2119 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2120 ;; Typically, (lisp-mode) or (scheme-mode).
2121 ;;
2122 ;; If the command is given while the cursor is inside a string, *and*
2123 ;; the string is an existing filename, *and* the filename is not a directory,
2124 ;; then the string is taken as default. This allows you to just position
2125 ;; your cursor over a string that's a filename and have it taken as default.
2126 ;;
2127 ;; If the command is given in a file buffer whose major mode is in
2128 ;; SOURCE-MODES, then the the filename is the default file, and the
2129 ;; file's directory is the default directory.
2130 ;;
2131 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2132 ;; then the default directory & file are what was used in the last source-file
2133 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2134 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2135 ;; is the cwd, with no default file. (\"no default file\" = nil)
2136 ;;
2137 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2138 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2139 ;; for Soar programs, etc.
2140 ;;
2141 ;; The function returns a pair: (default-directory . default-file).
2152 ;; (COMINT-CHECK-SOURCE fname)
2153 ;;============================================================================
2154 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2155 ;; process-in-a-buffer modes), this function can be called on the filename.
2156 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2157 ;; is queried to see if he wants to save the buffer before proceeding with
2158 ;; the load or compile.
2165 ;; save BUFF.
2172 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2173 ;;============================================================================
2174 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2175 ;; commands that process source files (like loading or compiling a file).
2176 ;; It prompts for the filename, provides a default, if there is one,
2177 ;; and returns the result filename.
2178 ;;
2179 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2180 ;;
2181 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2182 ;; from the last source processing command. SOURCE-MODES is a list of major
2183 ;; modes used to determine what file buffers contain source files. (These
2184 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2185 ;; then the filename reader will only accept a file that exists.
2186 ;;
2187 ;; A typical use:
2188 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2189 ;; '(lisp-mode) t))
2191 ;; This is pretty stupid about strings. It decides we're in a string
2192 ;; if there's a quote on both sides of point on the current line.
2194 "Return string around POINT that starts the current line, or nil."
2221 prompt deffile)
2222 prompt)
2223 defdir
2225 mustmatch-p)))
2228 ;; I am somewhat divided on this string-default feature. It seems
2229 ;; to violate the principle-of-least-astonishment, in that it makes
2230 ;; the default harder to predict, so you actually have to look and see
2231 ;; what the default really is before choosing it. This can trip you up.
2232 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2233 ;; on this.
2234 ;; -Olin
2236 \f
2237 ;; Simple process query facility.
2238 ;; ===========================================================================
2239 ;; This function is for commands that want to send a query to the process
2240 ;; and show the response to the user. For example, a command to get the
2241 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2242 ;; to an inferior Common Lisp process.
2243 ;;
2244 ;; This simple facility just sends strings to the inferior process and pops
2245 ;; up a window for the process buffer so you can see what the process
2246 ;; responds with. We don't do anything fancy like try to intercept what the
2247 ;; process responds with and put it in a pop-up window or on the message
2248 ;; line. We just display the buffer. Low tech. Simple. Works good.
2250 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2251 ;; a window for the inferior process so that its response can be seen.
2261 ;; Try to position the proc window so you can see the answer.
2262 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2263 ;; I don't know why. Wizards invited to improve it.
2272 \f
2273 ;; Filename/command/history completion in a buffer
2274 ;; ===========================================================================
2275 ;; Useful completion functions, courtesy of the Ergo group.
2277 ;; Six commands:
2278 ;; comint-dynamic-complete Complete or expand command, filename,
2279 ;; history at point.
2280 ;; comint-dynamic-complete-filename Complete filename at point.
2281 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2282 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2283 ;; replace with expanded/completed name.
2284 ;; comint-dynamic-simple-complete Complete stub given candidates.
2286 ;; These are not installed in the comint-mode keymap. But they are
2287 ;; available for people who want them. Shell-mode installs them:
2288 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2289 ;; (define-key shell-mode-map "\M-?"
2290 ;; 'comint-dynamic-list-filename-completions)))
2291 ;;
2292 ;; Commands like this are fine things to put in load hooks if you
2293 ;; want them present in specific modes.
2296 "*If non-nil, automatically list possibilities on partial completion.
2297 This mirrors the optional behavior of tcsh."
2302 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2303 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2304 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2305 This mirrors the optional behavior of tcsh."
2310 "*If non-nil, use shortest completion if characters cannot be added.
2311 This mirrors the optional behavior of tcsh.
2313 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2318 "*List of suffixes to be disregarded during file completion.
2319 This mirrors the optional behavior of bash and tcsh.
2321 Note that this applies to `comint-dynamic-complete-filename' only."
2326 "Prefix prepended to absolute file names taken from process input.
2327 This is used by comint's and shell's completion functions, and by shell's
2332 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2334 "String of characters valid in a file name.
2335 Note that all non-ASCII characters are considered valid in a file name
2336 regardless of what this variable says.
2347 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2350 directory)))
2354 "Return the word of WORD-CHARS at point, or nil if non is found.
2355 Word constituents are considered to be those in WORD-CHARS, which is like the
2357 plus all non-ASCII characters."
2361 ;;(memq (char-after (point)) shell-file-name-quote-list)
2365 ;; Don't go forward over a word-char (this can happen if we're at bob).
2368 ;; Set match-data to match the entire string.
2374 "Return FILENAME with environment variables substituted.
2375 Supports additional environment variable syntax of the command
2376 interpreter (e.g., the percent notation of cmd.exe on NT)."
2380 env-var-val)
2389 name))
2392 "Return the filename at point, or nil if non is found.
2393 Environment variables are substituted. See `comint-word'."
2400 "Return FILENAME with magic characters quoted.
2401 Magic characters are those in `comint-file-name-quote-list'."
2403 filename
2410 filename))))
2413 "Return FILENAME with quoted characters unquoted."
2415 filename
2421 filename)))
2425 "Dynamically perform completion at point.
2426 Calls the functions in `comint-dynamic-complete-functions' to perform
2427 completion until a function returns non-nil, at which point completion is
2428 assumed to have occurred."
2434 "Dynamically complete the filename at point.
2435 Completes if after a filename. See `comint-match-partial-filename' and
2436 `comint-dynamic-complete-as-filename'.
2437 This function is similar to `comint-replace-by-expanded-filename', except that
2438 it won't change parts of the filename already entered in the buffer; it just
2439 adds completion characters to the end of the filename. A completions listing
2440 may be shown in a help buffer if completion is ambiguous.
2442 Completion is dependent on the value of `comint-completion-addsuffix',
2443 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2444 completions listing is dependent on the value of `comint-completion-autolist'.
2446 Returns t if successful."
2454 "Dynamically complete at point as a filename.
2455 See `comint-dynamic-complete-filename'. Returns t if successful."
2458 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2459 ;; I think it was originally bound to solve file completion problems,
2460 ;; but subsequent changes may have made this unnecessary. sm.
2461 ;;(file-name-handler-alist nil)
2496 ;; We inserted a unique completion.
2503 ;; It's not unique, but user wants shortest match.
2509 ;; It's not unique, list possible completions.
2514 success))
2518 "Dynamically expand and complete the filename at point.
2519 Replace the filename with an expanded, canonicalised and completed replacement.
2522 removed, and the filename is made absolute instead of relative. For expansion
2523 see `expand-file-name' and `substitute-in-file-name'. For completion see
2524 `comint-dynamic-complete-filename'."
2531 "Dynamically complete STUB from CANDIDATES list.
2532 This function inserts completion characters at point by completing STUB from
2533 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2534 if completion is ambiguous.
2536 Returns nil if no completion was inserted.
2537 Returns `sole' if completed with the only completion match.
2538 Returns `shortest' if completed with the shortest of the completion matches.
2539 Returns `partial' if completed as far as possible with the completion matches.
2540 Returns `listed' if a completion listing was shown.
2542 See also `comint-dynamic-complete-filename'."
2551 nil)
2562 ;; Insert the longest substring.
2567 ;; It's not unique, but user wants shortest match.
2573 ;; It's not unique, list possible completions.
2582 "List in help buffer possible completions of the filename at point."
2585 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2586 ;; I think it was originally bound to solve file completion problems,
2587 ;; but subsequent changes may have made this unnecessary. sm.
2588 ;;(file-name-handler-alist nil)
2601 "List in help buffer sorted COMPLETIONS.
2602 Typing SPC flushes the help buffer."
2616 ;; If the user does mouse-choose-completion with the mouse,
2617 ;; execute the command, then delete the completion window.
2624 \f
2626 "After fetching a line from input history, this fetches the following line.
2627 In other words, this recalls the input line after the line you recalled last.
2628 You can use this to repeat a sequence of input lines."
2637 "Accumulate a line to send as input along with more lines.
2638 This inserts a newline so that you can enter more text
2640 to send all the accumulated input, at once.
2641 The entire accumulated text becomes one item in the input history
2642 when you send it."
2651 "Move point to the process mark.
2652 The process mark separates output, and input already sent,
2653 from input that has not yet been sent."
2661 "Move point to beginning of line (after prompt) or to the process mark.
2662 The first time you use this command, it moves to the beginning of the line
2663 \(but after the prompt, if any). If you repeat it again immediately,
2664 it moves point to the process mark.
2666 The process mark separates the process output, along with input already sent,
2667 from input that has not yet been sent. Ordinarily, the process mark
2668 is at the beginning of the current input line; but if you have
2670 the process mark is at the beginning of the accumulated input."
2677 "Set the process mark at point."
2684 \f
2685 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2687 ;; This little add-on for comint is intended to make it easy to get
2688 ;; output from currently active comint buffers into another buffer,
2689 ;; or buffers, and then go back to using the comint shell.
2690 ;;
2691 ;; My particular use is SQL interpreters; I want to be able to execute a
2692 ;; query using the process associated with a comint-buffer, and save that
2693 ;; somewhere else. Because the process might have state (for example, it
2694 ;; could be in an uncommitted transaction), just running starting a new
2695 ;; process and having it execute the query and then finish, would not
2696 ;; work. I'm sure there are other uses as well, although in many cases
2697 ;; starting a new process is the simpler, and thus preferable, approach.
2698 ;;
2699 ;; The basic implementation is as follows: comint-redirect changes the
2700 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2701 ;; its own filter. The filter puts the output into the designated buffer,
2702 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2703 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2704 ;; sees the stop regexp, it restores the old filter functions, and runs
2705 ;; comint-redirect-hook.
2706 ;;
2707 ;; Each comint buffer may only use one redirection at a time, but any number
2708 ;; of different comint buffers may be simultaneously redirected.
2709 ;;
2710 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2711 ;; correct prompt for your interpreter, or that you supply a regexp that says
2712 ;; when the redirection is finished. Otherwise, redirection will continue
2713 ;; indefinitely. The code now does a sanity check to ensure that it can find
2714 ;; a prompt in the comint buffer; however, it is still important to ensure that
2715 ;; this prompt is set correctly.
2716 ;;
2717 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2718 ;; perhaps it should prompt for a terminating string (with an
2719 ;; appropriate magic default by examining what we think is the prompt)?
2720 ;;
2722 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2723 ;; Variables
2724 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2727 "*If non-nil, print messages each time the redirection filter is invoked.
2728 Also print a message when redirection is completed."
2732 ;; Directly analagous to comint-preoutput-filter-functions
2734 "List of functions to call before inserting redirected process output.
2735 Each function gets one argument, a string containing the text received
2736 from the subprocess. It should return the string to insert, perhaps
2737 the same string that was received, or perhaps a modified or transformed
2738 string.
2740 The functions on the list are called sequentially, and each one is given
2741 the string returned by the previous one. The string returned by the
2746 ;; Internal variables
2752 "Regular expression that determines when to stop redirection in Comint.
2753 When the redirection filter function is given output that matches this regexp,
2757 "If non-nil, the text that ends a redirection is included in it.
2758 More precisely, the text that matches `comint-redirect-finished-regexp'
2759 and therefore terminates an output redirection is inserted in the
2772 "If non-nil, check that redirection is likely to complete successfully.
2773 More precisely, before starting a redirection, verify that the
2774 regular expression `comint-redirect-finished-regexp' that controls
2775 when to terminate it actually matches some text already in the process
2776 buffer. The idea is that this regular expression should match a prompt
2777 string, and that there ought to be at least one copy of your prompt string
2781 "The process filter that was in place when redirection is started.
2782 When redirection is completed, the process filter is restored to
2785 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2786 ;; Functions
2787 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2790 comint-buffer
2791 finished-regexp
2793 "Set up for output redirection.
2794 This function sets local variables that are used by `comint-redirect-filter'
2795 to perform redirection.
2797 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2798 in the output matches FINISHED-REGEXP.
2800 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2801 original comint buffer.
2803 This function is called by `comint-redirect-send-command-to-process',
2804 and does not normally need to be invoked by the end user or programmer."
2828 "End a Comint redirection. See `comint-redirect-send-command'."
2830 ;; Restore the process filter
2832 comint-redirect-original-filter-function)
2833 ;; Restore the mode line
2835 ;; Set the completed flag
2838 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2839 ;; that it really occurs.
2843 "Filter function which redirects output from PROCESS to a buffer or buffers.
2844 The variable `comint-redirect-output-buffer' says which buffer(s) to
2845 place output in.
2847 INPUT-STRING is the input from the comint process.
2849 This function runs as a process filter, and does not need to be invoked by the
2850 end user."
2854 ;; If we have to echo output, give it to the original filter function
2856 comint-redirect-original-filter-function
2858 process input-string)))))
2862 "Comint filter function which redirects comint output to a buffer or buffers.
2863 The variable `comint-redirect-output-buffer' says which buffer(s) to
2864 place output in.
2866 INPUT-STRING is the input from the comint process.
2868 This function does not need to be invoked by the end user."
2871 comint-redirect-output-buffer
2875 ;; If there are any filter functions, give them a chance to modify the string
2882 ;; Clobber `comint-redirect-finished-regexp'
2888 ;; Send output to all registered buffers
2892 ;; Set this buffer to the output buffer
2894 ;; Go to the end of the buffer
2896 ;; Insert the output
2898 output-buffer-list))
2900 ;; Message
2905 ;; If we see the prompt, tidy up
2906 ;; We'll look for the prompt in the original string, so nobody can
2907 ;; clobber it
2914 ;; Echo input?
2916 filtered-input-string
2919 ;;;###autoload
2921 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2922 With prefix arg, echo output in process buffer.
2924 If NO-DISPLAY is non-nil, do not show the output buffer."
2932 ;;;###autoload
2935 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2936 With prefix arg, echo output in process buffer.
2938 If NO-DISPLAY is non-nil, do not show the output buffer."
2943 process))
2945 ;; Change to the process buffer
2948 ;; Make sure there's a prompt in the current process buffer
2955 ;;;;;;;;;;;;;;;;;;;;;
2956 ;; Set up for redirection
2957 ;;;;;;;;;;;;;;;;;;;;;
2959 ;; Output Buffer
2960 output-buffer
2961 ;; Comint Buffer
2963 ;; Finished Regexp
2964 comint-prompt-regexp
2965 ;; Echo input
2966 echo)
2968 ;;;;;;;;;;;;;;;;;;;;;
2969 ;; Set the filter
2970 ;;;;;;;;;;;;;;;;;;;;;
2971 ;; Save the old filter
2976 ;;;;;;;;;;;;;;;;;;;;;
2977 ;; Send the command
2978 ;;;;;;;;;;;;;;;;;;;;;
2983 ;;;;;;;;;;;;;;;;;;;;;
2984 ;; Show the output
2985 ;;;;;;;;;;;;;;;;;;;;;
2991 output-buffer))))))
2993 ;;;###autoload
2995 "Send COMMAND to current process.
2996 Return a list of expressions in the output which match REGEXP.
2997 REGEXP-GROUP is the regular expression group in REGEXP to use."
3000 command regexp regexp-group))
3002 ;;;###autoload
3004 "Send COMMAND to PROCESS.
3005 Return a list of expressions in the output which match REGEXP.
3006 REGEXP-GROUP is the regular expression group in REGEXP to use."
3008 results)
3013 output-buffer process nil t)
3014 ;; Wait for the process to complete
3018 ;; Collect the output
3021 ;; Skip past the command, if it was echoed
3029 results)))
3030 results)))
3035 "^Empty input ring$"
3036 "^No history$"
3039 \f
3040 ;; Converting process modes to use comint mode
3041 ;; ===========================================================================
3042 ;; The code in the Emacs 19 distribution has all been modified to use comint
3043 ;; where needed. However, there are `third-party' packages out there that
3044 ;; still use the old shell mode. Here's a guide to conversion.
3045 ;;
3046 ;; Renaming variables
3047 ;; Most of the work is renaming variables and functions. These are the common
3048 ;; ones:
3049 ;; Local variables:
3050 ;; last-input-start comint-last-input-start
3051 ;; last-input-end comint-last-input-end
3052 ;; shell-prompt-pattern comint-prompt-regexp
3053 ;; shell-set-directory-error-hook <no equivalent>
3054 ;; Miscellaneous:
3055 ;; shell-set-directory <unnecessary>
3056 ;; shell-mode-map comint-mode-map
3057 ;; Commands:
3058 ;; shell-send-input comint-send-input
3059 ;; shell-send-eof comint-delchar-or-maybe-eof
3060 ;; kill-shell-input comint-kill-input
3061 ;; interrupt-shell-subjob comint-interrupt-subjob
3062 ;; stop-shell-subjob comint-stop-subjob
3063 ;; quit-shell-subjob comint-quit-subjob
3064 ;; kill-shell-subjob comint-kill-subjob
3065 ;; kill-output-from-shell comint-delete-output
3066 ;; show-output-from-shell comint-show-output
3067 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3068 ;;
3069 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3070 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3071 ;; Comint mode does not provide functionality equivalent to
3072 ;; shell-set-directory-error-hook; it is gone.
3073 ;;
3074 ;; comint-last-input-start is provided for modes which want to munge
3075 ;; the buffer after input is sent, perhaps because the inferior
3076 ;; insists on echoing the input. The LAST-INPUT-START variable in
3077 ;; the old shell package was used to implement a history mechanism,
3078 ;; but you should think twice before using comint-last-input-start
3079 ;; for this; the input history ring often does the job better.
3080 ;;
3081 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3082 ;; *not* create the comint-mode local variables in your foo-mode function.
3083 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3084 ;; necessary comint-specific local variables. Then create the
3085 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3086 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3087 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3088 ;; get-old-input) that need to be different from the defaults. Call
3089 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3090 ;; comint-mode will take care of it. The following example, from shell.el,
3091 ;; is typical:
3092 ;;
3093 ;; (defvar shell-mode-map '())
3094 ;; (cond ((not shell-mode-map)
3095 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3096 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3097 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3098 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3099 ;; (define-key shell-mode-map "\M-?"
3100 ;; 'comint-dynamic-list-filename-completions)))
3101 ;;
3102 ;; (defun shell-mode ()
3103 ;; (interactive)
3104 ;; (comint-mode)
3105 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3106 ;; (setq major-mode 'shell-mode)
3107 ;; (setq mode-name "Shell")
3108 ;; (use-local-map shell-mode-map)
3109 ;; (make-local-variable 'shell-directory-stack)
3110 ;; (setq shell-directory-stack nil)
3111 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3112 ;; (run-hooks 'shell-mode-hook))
3113 ;;
3114 ;;
3115 ;; Completion for comint-mode users
3116 ;;
3117 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3118 ;; hook to add completion functions to. Functions on this list should return
3119 ;; non-nil if completion occurs (i.e., further completion should not occur).
3120 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3121 ;; completion job.
3122 \f
3125 ;; comint.el ends here