| blob | 213a0673106868bf09f622ff39dd9eb13ac5d8fb |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu> 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-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-delete-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 ;; comint-last-output-overlay overlay
144 ;;
145 ;; Comint mode non-buffer local variables:
146 ;; comint-completion-addsuffix boolean/cons For file name
147 ;; comint-completion-autolist boolean completion behavior
148 ;; comint-completion-recexact boolean ...
151 "General command interpreter in a window stuff."
155 "Completion facilities in comint"
159 "Source finding facilities in comint"
164 "Regexp to recognise prompts in the inferior process.
167 This variable is only used if the variable
168 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
170 Good choices:
181 "List of characters to recognise as separate arguments in input.
182 Strings comprising a character in this list will separate the arguments
183 surrounding them, and also be regarded as arguments in their own right (unlike
184 whitespace). See `comint-arguments'.
185 Defaults to the empty list.
192 "*If non-nil, expand input command history references on completion.
193 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
195 If the value is `input', then the expansion is seen on input.
196 If the value is `history', then the expansion is only when inserting
197 into the buffer's input ring. See also `comint-magic-space' and
198 `comint-dynamic-complete'.
200 This variable is buffer-local."
208 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
209 The face used is `comint-highlight-input'."
214 "Face to use to highlight input when `comint-highlight-input' is non-nil."
218 "*If non-nil, highlight program prompts.
219 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'."
303 "*If non-nil, assume that the subprocess echoes any input.
304 If so, delete one copy of the input so that only one copy eventually
305 appears in the buffer.
307 This variable is buffer-local."
311 ;; AIX puts the name of the person being su'd to in front of the prompt.
312 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
313 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
314 ;; ssh-add prints a prompt like `Enter passphrase: '.
315 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
320 "*Regexp matching prompts for passwords in the inferior process.
321 This is used by `comint-watch-for-password-prompt'."
325 ;; Here are the per-interpreter hooks.
327 "Function that returns old text in comint mode.
328 This function is called when return is typed while the point is in old
329 text. It returns the text to be submitted as process input. The
330 default is `comint-get-old-input-default', which either grabs the
331 current input field or grabs the current line and strips off leading
332 text matching `comint-prompt-regexp', depending on the value of
337 "List of functions called to perform completion.
338 Functions should return non-nil if completion was performed.
339 See also `comint-dynamic-complete'.
345 "Predicate for filtering additions to input history.
346 Takes one argument, the input. If non-nil, the input may be saved on the input
350 "Functions to call before input is sent to the process.
351 These functions get one argument, a string containing the text to send.
356 "Functions to call after output is inserted into the buffer.
357 One possible function is `comint-postoutput-scroll-to-bottom'.
358 These functions get one argument, a string containing the text as originally
359 inserted. Note that this might not be the same as the buffer contents between
360 `comint-last-output-start' and the buffer's `process-mark', if other filter
361 functions have already modified the buffer.
363 See also `comint-preoutput-filter-functions'.
368 "Function to actually send to PROCESS the STRING submitted by user.
369 Usually this is just `comint-simple-send', but if your mode needs to
370 massage the input string, put a different function here.
371 `comint-simple-send' just sends the string plus a newline.
375 "*Non-nil means go to the end of the line before sending input.
376 See `comint-send-input'."
380 ;; Note: If it is decided to purge comint-prompt-regexp from the source
381 ;; entirely, searching for uses of this variable will help to identify
382 ;; places that need attention.
384 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
385 If nil, then program output and user-input are given different `field'
386 properties, which emacs commands can use to distinguish them (in
387 particular, common movement commands such as begining-of-line respect
388 field boundaries in a natural way)."
393 "Called upon entry into `comint-mode'
394 This is run before the process is cranked up."
399 "Called each time a process is exec'd by `comint-exec'.
400 This is called after the process is cranked up. It is useful for things that
401 must be done each time a process is executed in a comint mode buffer (e.g.,
402 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
403 executed once when the buffer is created."
410 "Non-nil if communications via pty; false if by pipe. Buffer local.
422 "Last input ring index which you copied.
426 "Non-nil if you are accumulating input lines to send as input together.
445 "Major mode for interacting with an inferior interpreter.
446 Interpreter name is same as buffer name, sans the asterisks.
447 Return at end of buffer sends line as input.
448 Return not at end copies rest of line to end and sends it.
449 Setting variable `comint-eol-on-send' means jump to the end of the line
450 before submitting new input.
452 This mode is customised to create major modes such as Inferior Lisp
453 mode, Shell mode, etc. This can be done by setting the hooks
454 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
455 and `comint-get-old-input' to appropriate functions, and the variable
456 `comint-prompt-regexp' to the appropriate regular expression.
458 An input history is maintained of size `comint-input-ring-size', and
459 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
460 Input ring history expansion can be achieved with the commands
462 Input ring expansion is controlled by the variable `comint-input-autoexpand',
463 and addition is controlled by the variable `comint-input-ignoredups'.
465 Commands with no default key bindings include `send-invisible',
466 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
467 `comint-magic-space'.
469 Input to, and output from, the subprocess can cause the window to scroll to
470 the end of the buffer. See variables `comint-output-filter-functions',
471 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
472 and `comint-scroll-to-bottom-on-output'.
475 to continue it.
479 Entry to this mode runs the hooks on `comint-mode-hook'."
527 ;; This behavior is not useful in comint buffers, and is annoying
531 nil
532 ;; Keys:
562 ;; Mouse Buttons:
564 ;; Menu bars:
565 ;; completion:
576 ;; Input history:
617 ;; Signals
632 ;; Put them in the menu bar:
634 menu-bar-final-items))
635 )
638 "Return t if there is a living process associated w/buffer BUFFER.
639 Living means the status is `open', `run', or `stop'.
640 BUFFER can be either a buffer or the name of one."
644 ;;;###autoload
646 "Make a comint process NAME in BUFFER, running PROGRAM.
647 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
648 PROGRAM should be either a string denoting an executable program to create
649 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
650 connection to be opened via `open-network-stream'. If there is already a
651 running process in that buffer, it is not restarted. Optional third arg
652 STARTFILE is the name of a file to send the contents of to the process.
654 If PROGRAM is a string, any more args are arguments to PROGRAM."
658 ;; If no process, or nuked process, crank up a new one and put buffer in
659 ;; comint mode. Otherwise, leave buffer and existing process alone.
664 buffer)
666 ;;;###autoload
668 "Make a comint process NAME in a buffer, running PROGRAM.
669 The name of the buffer is made by surrounding NAME with `*'s.
670 PROGRAM should be either a string denoting an executable program to create
671 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
672 connection to be opened via `open-network-stream'. If there is already a
673 running process in that buffer, it is not restarted. Optional third arg
674 STARTFILE is the name of a file to send the contents of to the process.
676 If PROGRAM is a string, any more args are arguments to PROGRAM."
679 ;;;###autoload
681 "Run PROGRAM in a comint buffer and switch to it.
682 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
683 The file name is used to make a symbol name, such as `comint-sh-hook', and any
684 hooks on this symbol are run in the buffer.
685 See `make-comint' and `comint-exec'."
692 "Start up a process in buffer BUFFER for comint modes.
693 Blasts any old process running in the buffer. Doesn't set the buffer mode.
694 You can use this to cheaply run a series of processes in the same comint
695 buffer. The hook `comint-exec-hook' is run after each exec."
700 ;; Crank up a new process
708 ;; Jump to the end, and set the process mark.
711 ;; Feed it the startfile.
713 ;;This is guaranteed to wait long enough
714 ;;but has bad results if the comint does not prompt at all
715 ;; (while (= size (buffer-size))
716 ;; (sleep-for 1))
717 ;;I hope 1 second is enough!
725 buffer)))
727 ;; This auxiliary function cranks up the process for comint-exec in
728 ;; the appropriate environment.
733 ;; If using termcap, we specify `emacs' as the terminal type
734 ;; because that lets us specify a width.
735 ;; If using terminfo, we specify `dumb' because that is
736 ;; a defined terminal type. `emacs' is not a defined terminal type
737 ;; and there is no way for us to define it here.
738 ;; Some programs that use terminfo get very confused
739 ;; if TERM is not a valid terminal type.
746 process-environment))
749 default-directory
751 proc decoding encoding changed)
753 ;; If the command has slashes, make sure we
754 ;; first look relative to the current directory.
760 ;; If start-process decided to use some coding system for decoding
761 ;; data sent from the process and the coding system doesn't
762 ;; specify EOL conversion, we had better convert CRLF to LF.
765 changed t))
766 ;; Even if start-process left the coding system for encoding data
767 ;; sent from the process undecided, we had better use the same one
768 ;; as what we use for decoding. But, we should suppress EOL
769 ;; conversion.
772 changed t))
775 proc))
779 "In a comint buffer, set the current input to the clicked-on previous input."
782 ;; Ignore non-input overlays
786 ;; Do we have input in this area?
791 ;; Can't use kill-region as it sets this-command
796 ;; Fall back to the global definition.
802 \f
803 ;; Input history processing in a buffer
804 ;; ===========================================================================
805 ;; Useful input history functions, courtesy of the Ergo group.
807 ;; Eleven commands:
808 ;; comint-dynamic-list-input-ring List history in help buffer.
809 ;; comint-previous-input Previous input...
810 ;; comint-previous-matching-input ...matching a string.
811 ;; comint-previous-matching-input-from-input ... matching the current input.
812 ;; comint-next-input Next input...
813 ;; comint-next-matching-input ...matching a string.
814 ;; comint-next-matching-input-from-input ... matching the current input.
815 ;; comint-backward-matching-input Backwards input...
816 ;; comint-forward-matching-input ...matching a string.
817 ;; comint-replace-by-expanded-history Expand history at point;
818 ;; replace with expanded history.
819 ;; comint-magic-space Expand history and insert space.
820 ;;
821 ;; Three functions:
822 ;; comint-read-input-ring Read into comint-input-ring...
823 ;; comint-write-input-ring Write to comint-input-ring-file-name.
824 ;; comint-replace-by-expanded-history-before-point Workhorse function.
827 "Sets the buffer's `comint-input-ring' from a history file.
828 The name of the file is given by the variable `comint-input-ring-file-name'.
829 The history ring is of size `comint-input-ring-size', regardless of file size.
830 If `comint-input-ring-file-name' is nil this function does nothing.
832 If the optional argument SILENT is non-nil, we say nothing about a
833 failure to read the history file.
835 This function is useful for major mode commands and mode hooks.
837 The commands stored in the history file are separated by the
838 `comint-input-ring-separator', and entries that match
839 `comint-input-history-ignore' are ignored. The most recent command
840 comes last.
842 See also `comint-input-ignoredups' and `comint-write-input-ring'."
845 nil)
849 comint-input-ring-file-name)))
862 ;; Save restriction in case file is already visited...
863 ;; Watch for those date stamps in history files!
883 comint-input-ring-index nil)))))
886 "Writes the buffer's `comint-input-ring' to a history file.
887 The name of the file is given by the variable `comint-input-ring-file-name'.
888 The original contents of the file are lost if `comint-input-ring' is not empty.
889 If `comint-input-ring-file-name' is nil this function does nothing.
891 Useful within process sentinels.
893 See also `comint-read-input-ring'."
897 nil)
905 ;; Write it all out into a buffer first. Much faster, but messier,
906 ;; than writing it one line at a time.
918 "List in help buffer the buffer's input history."
927 ;; We have to build up a list ourselves from the ring vector.
931 ;; Change "completion" to "history reference"
932 ;; to make the display accurate.
948 ;; Return list of regexp and prefix arg using PROMPT.
956 regexp)
960 ;; First make sure there is a ring and that we are after the process mark
967 ;; arg of zero resets search from beginning, and uses arg of 1
971 arg)))
974 ;; Index to start a directional search, starting at comint-input-ring-index
976 ;; If a search is running, offset by 1 in direction of arg
979 ;; For a new search, start from beginning or end, as appropriate
985 "Return the string ARG places along the input ring.
986 Moves relative to `comint-input-ring-index'."
990 arg)))
993 "Cycle backwards through input history."
998 "Cycle forwards through input history."
1003 "Return the string matching REGEXP ARG places along the input ring.
1004 Moves relative to `comint-input-ring-index'."
1009 "Return the index matching REGEXP ARG places along the input ring.
1010 Moves relative to START, or `comint-input-ring-index'."
1019 ;; Do the whole search as many times as the argument says.
1021 ;; Step once.
1024 ;; If we haven't reached a match, step some more.
1028 ;; If we have gone all the way around in this search.
1031 ;; Now that we know which ring element to use, if we found it, return that.
1033 n)))
1036 "Search backwards through input history for match for REGEXP.
1037 \(Previous history elements are earlier commands.)
1038 With prefix argument N, search for Nth previous match.
1039 If N is negative, find the next or Nth next match."
1043 ;; Has a match been found?
1049 ;; Can't use kill-region as it sets this-command
1056 "Search forwards through input history for match for REGEXP.
1057 \(Later history elements are more recent commands.)
1058 With prefix argument N, search for Nth following match.
1059 If N is negative, find the previous or Nth previous match."
1064 "Search backwards through input history for match for current input.
1065 \(Previous history elements are earlier commands.)
1066 With prefix argument N, search for Nth previous match.
1067 If N is negative, search forwards for the -Nth following match."
1070 comint-next-matching-input-from-input)))
1071 ;; Starting a new search
1077 comint-input-ring-index nil))
1080 arg))
1083 "Search forwards through input history for match for current input.
1084 \(Following history elements are more recent commands.)
1085 With prefix argument N, search for Nth following match.
1086 If N is negative, search backwards for the -Nth previous match."
1092 "Expand input command history references before point.
1093 Expansion is dependent on the value of `comint-input-autoexpand'.
1095 This function depends on the buffer's idea of the input history, which may not
1096 match the command interpreter's idea, assuming it has one.
1098 Assumes history syntax is like typical Un*x shells'. However, since emacs
1099 cannot know the interpreter's idea of input line numbers, assuming it has one,
1100 it cannot expand absolute input line number references.
1102 If the optional argument SILENT is non-nil, never complain
1103 even if history reference seems erroneous.
1105 If the optional argument START is non-nil, that specifies the
1106 start of the text to scan for history references, rather
1107 than the logical beginning of line.
1109 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1111 Returns t if successful."
1115 ;; Use comint-prompt-regexp
1119 ;; Use input fields. User input that hasn't been entered
1120 ;; yet, at the end of the buffer, has a nil `field' property.
1123 ;; Looks like there might be history references in the command.
1130 "Expand directory stack reference before point.
1131 See `comint-replace-by-expanded-history'. Returns t if successful.
1133 If the optional argument START is non-nil, that specifies the
1134 start of the text to scan for history references, rather
1135 than the logical beginning of line."
1143 ;; This seems a bit complex. We look for references such as !!, !-num,
1144 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1145 ;; If that wasn't enough, the plings can be suffixed with argument
1146 ;; range specifiers.
1147 ;; Argument ranges are complex too, so we hive off the input line,
1148 ;; referenced with plings, with the range string to `comint-args'.
1152 ;; The history is quoted, or we're in quotes.
1155 ;; We cannot know the interpreter's idea of input line numbers.
1159 ;; Just a number of args from `number' lines backward.
1168 t t)
1174 ;; Just a number of args from the previous input line.
1178 t t)
1182 ;; Most recent input starting with or containing (possibly
1183 ;; protected) string, maybe just a number of args. Phew.
1201 t t)
1204 ;; Quick substitution on the previous input line.
1221 "Expand input history references before point and insert ARG spaces.
1222 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1226 \f
1228 "Return t if the number of quotes between BEG and END is odd.
1229 Quotes are single and double."
1235 "Return number of matches for REGEXP from BEG to END."
1242 count))
1245 ;; From STRING, return the args depending on the range specified in the text
1246 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1247 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1263 ;; Return a list of arguments from ARG. Break it up at the
1264 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1279 comint-delimiter-argument-list)))
1282 args)))
1285 "Return from STRING the NTH to MTH arguments.
1286 NTH and/or MTH can be nil, which means the last argument.
1287 Returned arguments are separated by single spaces.
1288 We assume whitespace separates arguments, except within quotes
1289 and except for a space or tab that immediately follows a backslash.
1290 Also, a run of one or more of a single character
1291 in `comint-delimiter-argument-list' is a separate argument.
1292 Argument 0 is the command name."
1293 ;; The first line handles ordinary characters and backslash-sequences
1294 ;; (except with w32 msdos-like shells, where backslashes are valid).
1295 ;; The second matches "-quoted strings.
1296 ;; The third matches '-quoted strings.
1297 ;; The fourth matches `-quoted strings.
1298 ;; This seems to fit the syntax of BASH 2.0.
1309 beg str value quotes)
1310 ;; Build a list of all the args until we have as many as we want.
1314 ;; It's contiguous, part of the same arg.
1317 ;; It's a new separate arg.
1319 ;; Put the previous arg, if there was one, onto ARGS.
1336 \f
1337 ;;
1338 ;; Input processing stuff
1339 ;;
1341 "Add CMD to the input history.
1342 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1348 cmd))))
1352 "Send input to process.
1353 After the process output mark, sends all text from the process mark to
1354 point as input to the process. Before the process output mark, calls value
1355 of variable `comint-get-old-input' to retrieve old input, copies it to the
1356 process mark, and sends it. If variable `comint-process-echoes' is nil,
1357 a terminal newline is also inserted into the buffer and sent to the process
1358 \(if it is non-nil, all text from the process mark to point is deleted,
1359 since it is assumed the remote process will re-echo it).
1361 Any history reference may be expanded depending on the value of the variable
1362 `comint-input-autoexpand'. The list of function names contained in the value
1363 of `comint-input-filter-functions' is called on the input before sending it.
1364 The input is entered into the input history ring, if the value of variable
1365 `comint-input-filter' returns non-nil when called on the input.
1367 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1368 end of line before sending the input.
1370 The values of `comint-get-old-input', `comint-input-filter-functions', and
1371 `comint-input-filter' are chosen according to the command interpreter running
1372 in the buffer. E.g.,
1374 If the interpreter is the csh,
1375 comint-get-old-input is the default: either return the current
1376 field, or take the current line and discard any
1377 initial string matching regexp `comint-prompt-regexp', depending
1378 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1381 comint-input-filter is the default: returns t if the input isn't all white
1382 space.
1384 If the comint is Lucid Common Lisp,
1385 comint-get-old-input snarfs the sexp ending at point.
1386 comint-input-filter-functions does nothing.
1387 comint-input-filter returns nil if the input matches input-filter-regexp,
1388 which matches (1) all whitespace (2) :a, :c, etc.
1390 Similarly for Soar, Scheme, etc."
1392 ;; Note that the input string does not include its terminal newline.
1402 copy)))
1404 ;; Just whatever's already there
1405 intxt
1406 ;; Expand and leave it visible in buffer
1410 input
1411 ;; This is messy 'cos ultimately the original
1412 ;; functions used do insertion, rather than return
1413 ;; strings. We have to expand, then insert back.
1419 copy))))
1433 ;; Make an overlay for the input field
1436 ;; Give old user input a field property of `input', to
1437 ;; distinguish it from both process output and unsent
1438 ;; input. The terminating newline is put into a special
1439 ;; `boundary' field to make cursor movement between input
1440 ;; and output fields smoother.
1447 ;; Make an overlay for the terminating newline
1456 ;; Update the markers before we send the input
1457 ;; in case we get output amidst sending the input.
1461 ;; clear the "accumulation" marker
1464 ;; This used to call comint-output-filter-functions,
1465 ;; but that scrolled the buffer in undesirable ways.
1469 "List of functions to call before inserting Comint output into the buffer.
1470 Each function gets one argument, a string containing the text received
1471 from the subprocess. It should return the string to insert, perhaps
1472 the same string that was received, or perhaps a modified or transformed
1473 string.
1475 The functions on the list are called sequentially, and each one is
1476 given the string returned by the previous one. The string returned by
1477 the last function is the text that is actually inserted in the
1478 redirection buffer.
1482 ;; When non-nil, this is the last overlay used for output.
1483 ;; It is kept around so that we can extend it instead of creating
1484 ;; multiple contiguous overlays for multiple contiguous output chunks.
1487 ;; When non-nil, this is an overlay over the last recognized prompt in
1488 ;; the buffer; it is used when highlighting the prompt.
1491 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1492 ;; Any further output will then create a new comint-last-prompt-overlay.
1499 "Handle carriage control characters in comint output.
1500 Translate carriage return/linefeed sequences to linefeeds.
1501 Make single carriage returns delete to the beginning of the line.
1502 Make backspaces delete the previous character.
1504 This function should be in the list `comint-output-filter-functions'."
1506 ;; We first check to see if STRING contains any magic characters, to
1507 ;; avoid overhead in the common case where it does not
1515 ;; CR LF -> LF
1516 ;; Note that this won't work properly when the CR and LF
1517 ;; are in different output chunks, but this is probably an
1518 ;; exceedingly rare case (because they are generally
1519 ;; written as a unit), and to delay interpretation of a
1520 ;; trailing CR in a chunk would result in odd interactive
1521 ;; behavior (and this case is probably far more common).
1525 ;; bare CR -> delete preceding line
1529 ;; BS -> delete preceding character
1536 ;; The purpose of using this filter for comint processes
1537 ;; is to keep comint-last-input-end from moving forward
1538 ;; when output is inserted.
1541 ;; First check for killed buffer or no input.
1544 ;; Run preoutput filters
1550 ;; Insert STRING
1552 ;; Avoid the overhead of save-excursion, since we just
1553 ;; fiddle with the point
1556 ;; The point should float after any insertion we do
1559 ;; We temporarly remove any buffer narrowing, in case the
1560 ;; process mark is outside of the restriction
1567 ;; insert-before-markers is a bad thing. XXX
1568 ;;
1569 ;; It is used here to force window-point markers (used to
1570 ;; store the value of point in non-selected windows) to
1571 ;; advance, but it also screws up any other markers that we
1572 ;; don't _want_ to advance, such as the start-marker of some
1573 ;; of the overlays we create.
1574 ;;
1575 ;; We work around the problem with the overlays by
1576 ;; explicitly adjusting them after we do the insertion, but
1577 ;; in the future this problem should be solved correctly, by
1578 ;; using `insert', and making the insertion-type of
1579 ;; window-point markers settable (via a buffer-local
1580 ;; variable). In comint buffers, this variable would be set
1581 ;; to `t', to cause point in non-select windows to advance.
1583 ;; Fixup markers and overlays that got screwed up because we
1584 ;; used `insert-before-markers'.
1586 ;; comint-last-output-start
1588 ;; comint-last-input-end
1593 ;; No overlays we create are set to advance upon insertion
1594 ;; (at the start/end), so we assume that any overlay which
1595 ;; is at the current point was incorrectly advanced by
1596 ;; insert-before-markers. First fixup overlays that might
1597 ;; start at point:
1602 old-point
1604 ;; Then do overlays that might end at point:
1609 old-point))))
1611 ;; Advance process-mark
1615 ;; We check to see if the last overlay used for output is
1616 ;; adjacent to the new input, and if so, just extend it.
1620 ;; Extend comint-last-output-overlay to include the
1621 ;; most recent output
1625 ;; Create a new overlay
1633 ;; Highlight the prompt, where we define `prompt' to mean
1634 ;; the most recent output that doesn't end with a newline.
1636 ;; Need to create or move the prompt overlay (in the case
1637 ;; where there is no prompt ((bolp) == t), we still do
1638 ;; this if there's already an existing overlay).
1641 ;; Just move an existing overlay
1644 ;; Need to create the overlay
1655 "Go to the end of buffer in all windows showing it.
1656 Movement occurs if point in the selected window is not after the process mark,
1657 and `this-command' is an insertion command. Insertion commands recognised
1658 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1659 Depends on the value of `comint-scroll-to-bottom-on-input'.
1661 This function should be a pre-command hook."
1664 hilit-yank)))
1680 nil t))))))
1683 "Go to the end of buffer in all windows showing it.
1684 Does not scroll if the current line is the last line in the buffer.
1685 Depends on the value of `comint-scroll-to-bottom-on-output' and
1686 `comint-scroll-show-maximum-output'.
1688 This function should be in the list `comint-output-filter-functions'."
1702 ;; Maybe user wants point to jump to end.
1705 ;; If point was at the end, keep it at end.
1709 ;; Optionally scroll so that the text
1710 ;; ends at the bottom of the window.
1717 nil t))
1721 "Truncate the buffer to `comint-buffer-maximum-size'.
1722 This function could be on `comint-output-filter-functions' or bound to a key."
1731 "Strip trailing `^M' characters from the current output group.
1732 This function could be on `comint-output-filter-functions' or bound to a key."
1745 "Put the end of the buffer at the bottom of the window."
1751 "Default for `comint-get-old-input'.
1752 Returns either the current field, or the current line with any initial
1753 text matching `comint-prompt-regexp' stripped off, depending on the
1754 value of `comint-use-prompt-regexp-instead-of-fields'."
1762 ;; Return the contents of the field at the current point.
1769 "Insert after prompt old input at point as new input to be edited.
1770 Calls `comint-get-old-input' to get old input."
1780 "Skip past the text matching regexp `comint-prompt-regexp'.
1781 If this takes us past the end of the current line, don't skip at all."
1788 "Return t if point is after the process output marker."
1793 "Default function for sending to PROC input STRING.
1794 This just sends STRING plus a newline. To override this,
1795 set the hook `comint-input-sender'."
1800 "Returns the buffer position of the beginning of the line, after any prompt.
1801 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1802 prompt skip is done by skipping text matching the regular expression
1803 `comint-prompt-regexp', a buffer local variable."
1805 ;; Use comint-prompt-regexp
1810 ;; Use input fields. Note that, unlike the behavior of
1811 ;; `line-beginning-position' inside a field, this function will
1812 ;; return the position of the end of a prompt, even if the point is
1813 ;; already inside the prompt. In order to do this, it assumes that
1814 ;; if there are two fields on a line, then the first one is the
1815 ;; prompt, and the second one is an input field, and is front-sticky
1816 ;; (as input fields should be).
1820 "Goes to the beginning of line, then skips past the prompt, if any.
1822 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1823 prompt skip is done by skipping text matching the regular expression
1824 `comint-prompt-regexp', a buffer local variable."
1827 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1831 ;; These three functions are for entering text you don't want echoed or
1832 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1833 ;; Just enter m-x send-invisible and type in your line, or add
1834 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1837 "Read a single line of text from user without echoing, and return it.
1838 Prompt with argument PROMPT, a string. Optional argument STARS causes
1839 input to be echoed with '*' characters on the prompt line. Input ends with
1840 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1841 `inhibit-quit' is set because e.g. this function was called from a process
1842 filter and C-g is pressed, this function returns nil rather than a string).
1844 Note that the keystrokes comprising the text can still be recovered
1846 Once the caller uses the password, it can erase the password
1847 by doing (fillarray STRING 0)."
1859 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1862 ;; This function may get called from a process filter, where
1863 ;; inhibit-quit is set. In later versions of emacs read-char
1864 ;; may clear quit-flag itself and return C-g. That would make
1865 ;; it impossible to quit this loop in a simple way, so
1866 ;; re-enable it here (for backward-compatibility the check for
1867 ;; quit-flag below would still be necessary, so this seems
1868 ;; like the simplest way to do things).
1870 done t))
1884 ;; Emulate a true quit, except that we have to return a value.
1890 ans)))
1893 "Read a string without echoing.
1894 Then send it to the process running in the current buffer.
1895 The string is sent using `comint-input-sender'.
1896 Security bug: your string can still be temporarily recovered with
1912 "Prompt in the minibuffer for password and send without echoing.
1913 This function uses `send-invisible' to read and send a password to the buffer's
1914 process if STRING contains a password prompt defined by
1915 `comint-password-prompt-regexp'.
1917 This function could be in the list `comint-output-filter-functions'."
1921 \f
1922 ;; Low-level process communication
1925 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1935 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1943 \f
1944 ;; Random input hackage
1947 "Delete all output from interpreter since last input.
1948 Does not delete the prompt."
1961 ;; Output message and put back prompt
1967 "Write output from interpreter since last input to FILENAME.
1968 Any prompt at the end of the output is not written.
1970 If the optional argument APPEND (the prefix argument when interactive)
1971 is non-nil, the output is appended to the file instead.
1973 If the optional argument MUSTBENEW is non-nil, check for an existing
1974 file with the same name. If MUSTBENEW is `excl', that means to get an
1975 error if the file already exists; never overwrite. If MUSTBENEW is
1976 neither nil nor `excl', that means ask for confirmation before
1977 overwriting, but do go ahead and overwrite the file if the user
1978 confirms. When interactive, MUSTBENEW is nil when appending, and t
1979 otherwise."
1983 "Append output to file: "
1985 current-prefix-arg
1991 append nil nil mustbenew)))
1993 ;; This function exists for the benefit of the menu; from the keyboard,
1994 ;; users can just use `comint-write-output' with a prefix arg.
1996 "Append output from interpreter since last input to FILENAME.
1997 Any prompt at the end of the output is not written."
2002 "Display start of this batch of interpreter output at top of window.
2003 Sets mark to the value of point when this command is run."
2018 "Interrupt the current subjob.
2019 This command also kills the pending input
2020 between the process-mark and point."
2026 "Send kill signal to the current subjob.
2027 This command also kills the pending input
2028 between the process-mark and point."
2034 "Send quit signal to the current subjob.
2035 This command also kills the pending input
2036 between the process-mark and point."
2042 "Stop the current subjob.
2043 This command also kills the pending input
2044 between the process-mark and point.
2046 WARNING: if there is no current subjob, you can end up suspending
2047 the top-level process running in the buffer. If you accidentally do
2049 is not a problem with most shells, since they ignore this signal.)"
2055 "Send CONT signal to process buffer's process group.
2056 Useful if you accidentally suspend the top-level process."
2061 "Kill all text from last stuff output by interpreter to point."
2068 "Delete ARG characters forward or send an EOF to subprocess.
2069 Sends an EOF only if point is at the end of the buffer and there is no input."
2077 "Send an EOF to the current buffer's process."
2084 "Search backward through buffer for input fields that match REGEXP.
2085 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2086 fields are identified by lines that match `comint-prompt-regexp'.
2088 With prefix argument N, search for Nth previous match.
2089 If N is negative, find the next or Nth next match."
2092 ;; Use comint-prompt-regexp
2102 ;; Use input fields
2116 "Search forward through buffer for input fields that match REGEXP.
2117 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2118 fields are identified by lines that match `comint-prompt-regexp'.
2120 With prefix argument N, search for Nth following match.
2121 If N is negative, find the previous or Nth previous match."
2127 "Move to end of Nth next prompt in the buffer.
2128 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2129 the beginning of the Nth next `input' field, otherwise, it means the Nth
2130 occurance of text matching `comint-prompt-regexp'."
2133 ;; Use comint-prompt-regexp
2138 ;; Use input fields
2147 ;; Ran off the end of the buffer.
2157 "Move to end of Nth previous prompt in the buffer.
2158 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2159 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2160 occurance of text matching `comint-prompt-regexp'."
2163 \f
2164 ;; Support for source-file processing commands.
2165 ;;============================================================================
2166 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2167 ;; commands that process files of source text (e.g. loading or compiling
2168 ;; files). So the corresponding process-in-a-buffer modes have commands
2169 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2170 ;; for defining these commands.
2171 ;;
2172 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2173 ;; and Soar, in that they don't know anything about file extensions.
2174 ;; So the compile/load interface gets the wrong default occasionally.
2175 ;; The load-file/compile-file default mechanism could be smarter -- it
2176 ;; doesn't know about the relationship between filename extensions and
2177 ;; whether the file is source or executable. If you compile foo.lisp
2178 ;; with compile-file, then the next load-file should use foo.bin for
2179 ;; the default, not foo.lisp. This is tricky to do right, particularly
2180 ;; because the extension for executable files varies so much (.o, .bin,
2181 ;; .lbin, .mo, .vo, .ao, ...).
2184 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2185 ;; commands.
2186 ;;
2187 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2188 ;; want to save the buffer before issuing any process requests to the command
2189 ;; interpreter.
2190 ;;
2191 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2192 ;; for the file to process.
2194 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2195 ;;============================================================================
2196 ;; This function computes the defaults for the load-file and compile-file
2197 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2198 ;;
2199 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2200 ;; source-file processing command. NIL if there hasn't been one yet.
2201 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2202 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2203 ;; Typically, (lisp-mode) or (scheme-mode).
2204 ;;
2205 ;; If the command is given while the cursor is inside a string, *and*
2206 ;; the string is an existing filename, *and* the filename is not a directory,
2207 ;; then the string is taken as default. This allows you to just position
2208 ;; your cursor over a string that's a filename and have it taken as default.
2209 ;;
2210 ;; If the command is given in a file buffer whose major mode is in
2211 ;; SOURCE-MODES, then the the filename is the default file, and the
2212 ;; file's directory is the default directory.
2213 ;;
2214 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2215 ;; then the default directory & file are what was used in the last source-file
2216 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2217 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2218 ;; is the cwd, with no default file. (\"no default file\" = nil)
2219 ;;
2220 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2221 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2222 ;; for Soar programs, etc.
2223 ;;
2224 ;; The function returns a pair: (default-directory . default-file).
2235 ;; (COMINT-CHECK-SOURCE fname)
2236 ;;============================================================================
2237 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2238 ;; process-in-a-buffer modes), this function can be called on the filename.
2239 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2240 ;; is queried to see if he wants to save the buffer before proceeding with
2241 ;; the load or compile.
2248 ;; save BUFF.
2255 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2256 ;;============================================================================
2257 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2258 ;; commands that process source files (like loading or compiling a file).
2259 ;; It prompts for the filename, provides a default, if there is one,
2260 ;; and returns the result filename.
2261 ;;
2262 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2263 ;;
2264 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2265 ;; from the last source processing command. SOURCE-MODES is a list of major
2266 ;; modes used to determine what file buffers contain source files. (These
2267 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2268 ;; then the filename reader will only accept a file that exists.
2269 ;;
2270 ;; A typical use:
2271 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2272 ;; '(lisp-mode) t))
2274 ;; This is pretty stupid about strings. It decides we're in a string
2275 ;; if there's a quote on both sides of point on the current line.
2277 "Return string around POINT that starts the current line, or nil."
2304 prompt deffile)
2305 prompt)
2306 defdir
2308 mustmatch-p)))
2311 ;; I am somewhat divided on this string-default feature. It seems
2312 ;; to violate the principle-of-least-astonishment, in that it makes
2313 ;; the default harder to predict, so you actually have to look and see
2314 ;; what the default really is before choosing it. This can trip you up.
2315 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2316 ;; on this.
2317 ;; -Olin
2319 \f
2320 ;; Simple process query facility.
2321 ;; ===========================================================================
2322 ;; This function is for commands that want to send a query to the process
2323 ;; and show the response to the user. For example, a command to get the
2324 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2325 ;; to an inferior Common Lisp process.
2326 ;;
2327 ;; This simple facility just sends strings to the inferior process and pops
2328 ;; up a window for the process buffer so you can see what the process
2329 ;; responds with. We don't do anything fancy like try to intercept what the
2330 ;; process responds with and put it in a pop-up window or on the message
2331 ;; line. We just display the buffer. Low tech. Simple. Works good.
2333 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2334 ;; a window for the inferior process so that its response can be seen.
2344 ;; Try to position the proc window so you can see the answer.
2345 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2346 ;; I don't know why. Wizards invited to improve it.
2355 \f
2356 ;; Filename/command/history completion in a buffer
2357 ;; ===========================================================================
2358 ;; Useful completion functions, courtesy of the Ergo group.
2360 ;; Six commands:
2361 ;; comint-dynamic-complete Complete or expand command, filename,
2362 ;; history at point.
2363 ;; comint-dynamic-complete-filename Complete filename at point.
2364 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2365 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2366 ;; replace with expanded/completed name.
2367 ;; comint-dynamic-simple-complete Complete stub given candidates.
2369 ;; These are not installed in the comint-mode keymap. But they are
2370 ;; available for people who want them. Shell-mode installs them:
2371 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2372 ;; (define-key shell-mode-map "\M-?"
2373 ;; 'comint-dynamic-list-filename-completions)))
2374 ;;
2375 ;; Commands like this are fine things to put in load hooks if you
2376 ;; want them present in specific modes.
2379 "*If non-nil, automatically list possibilities on partial completion.
2380 This mirrors the optional behavior of tcsh."
2385 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2386 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2387 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2388 This mirrors the optional behavior of tcsh."
2397 "*If non-nil, use shortest completion if characters cannot be added.
2398 This mirrors the optional behavior of tcsh.
2400 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2405 "*List of suffixes to be disregarded during file completion.
2406 This mirrors the optional behavior of bash and tcsh.
2408 Note that this applies to `comint-dynamic-complete-filename' only."
2413 "Prefix prepended to absolute file names taken from process input.
2414 This is used by comint's and shell's completion functions, and by shell's
2419 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2421 "String of characters valid in a file name.
2422 Note that all non-ASCII characters are considered valid in a file name
2423 regardless of what this variable says.
2434 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2437 directory)))
2441 "Return the word of WORD-CHARS at point, or nil if non is found.
2442 Word constituents are considered to be those in WORD-CHARS, which is like the
2444 plus all non-ASCII characters."
2448 ;;(memq (char-after (point)) shell-file-name-quote-list)
2452 ;; Don't go forward over a word-char (this can happen if we're at bob).
2455 ;; Set match-data to match the entire string.
2461 "Return FILENAME with environment variables substituted.
2462 Supports additional environment variable syntax of the command
2463 interpreter (e.g., the percent notation of cmd.exe on NT)."
2467 env-var-val)
2476 name))
2479 "Return the filename at point, or nil if non is found.
2480 Environment variables are substituted. See `comint-word'."
2487 "Return FILENAME with magic characters quoted.
2488 Magic characters are those in `comint-file-name-quote-list'."
2490 filename
2497 filename))))
2500 "Return FILENAME with quoted characters unquoted."
2502 filename
2508 filename)))
2512 "Dynamically perform completion at point.
2513 Calls the functions in `comint-dynamic-complete-functions' to perform
2514 completion until a function returns non-nil, at which point completion is
2515 assumed to have occurred."
2521 "Dynamically complete the filename at point.
2522 Completes if after a filename. See `comint-match-partial-filename' and
2523 `comint-dynamic-complete-as-filename'.
2524 This function is similar to `comint-replace-by-expanded-filename', except that
2525 it won't change parts of the filename already entered in the buffer; it just
2526 adds completion characters to the end of the filename. A completions listing
2527 may be shown in a help buffer if completion is ambiguous.
2529 Completion is dependent on the value of `comint-completion-addsuffix',
2530 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2531 completions listing is dependent on the value of `comint-completion-autolist'.
2533 Returns t if successful."
2541 "Dynamically complete at point as a filename.
2542 See `comint-dynamic-complete-filename'. Returns t if successful."
2545 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2546 ;; I think it was originally bound to solve file completion problems,
2547 ;; but subsequent changes may have made this unnecessary. sm.
2548 ;;(file-name-handler-alist nil)
2583 ;; We inserted a unique completion.
2590 ;; It's not unique, but user wants shortest match.
2596 ;; It's not unique, list possible completions.
2601 success))
2605 "Dynamically expand and complete the filename at point.
2606 Replace the filename with an expanded, canonicalised and completed replacement.
2609 removed, and the filename is made absolute instead of relative. For expansion
2610 see `expand-file-name' and `substitute-in-file-name'. For completion see
2611 `comint-dynamic-complete-filename'."
2618 "Dynamically complete STUB from CANDIDATES list.
2619 This function inserts completion characters at point by completing STUB from
2620 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2621 if completion is ambiguous.
2623 Returns nil if no completion was inserted.
2624 Returns `sole' if completed with the only completion match.
2625 Returns `shortest' if completed with the shortest of the completion matches.
2626 Returns `partial' if completed as far as possible with the completion matches.
2627 Returns `listed' if a completion listing was shown.
2629 See also `comint-dynamic-complete-filename'."
2638 nil)
2649 ;; Insert the longest substring.
2654 ;; It's not unique, but user wants shortest match.
2660 ;; It's not unique, list possible completions.
2669 "List in help buffer possible completions of the filename at point."
2672 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2673 ;; I think it was originally bound to solve file completion problems,
2674 ;; but subsequent changes may have made this unnecessary. sm.
2675 ;;(file-name-handler-alist nil)
2688 "List in help buffer sorted COMPLETIONS.
2689 Typing SPC flushes the help buffer."
2703 ;; If the user does mouse-choose-completion with the mouse,
2704 ;; execute the command, then delete the completion window.
2711 \f
2713 "After fetching a line from input history, this fetches the following line.
2714 In other words, this recalls the input line after the line you recalled last.
2715 You can use this to repeat a sequence of input lines."
2724 "Accumulate a line to send as input along with more lines.
2725 This inserts a newline so that you can enter more text
2727 to send all the accumulated input, at once.
2728 The entire accumulated text becomes one item in the input history
2729 when you send it."
2738 "Move point to the process mark.
2739 The process mark separates output, and input already sent,
2740 from input that has not yet been sent."
2749 "Move point to beginning of line (after prompt) or to the process mark.
2750 The first time you use this command, it moves to the beginning of the line
2751 \(but after the prompt, if any). If you repeat it again immediately,
2752 it moves point to the process mark.
2754 The process mark separates the process output, along with input already sent,
2755 from input that has not yet been sent. Ordinarily, the process mark
2756 is at the beginning of the current input line; but if you have
2758 the process mark is at the beginning of the accumulated input."
2765 "Set the process mark at point."
2772 \f
2773 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2775 ;; This little add-on for comint is intended to make it easy to get
2776 ;; output from currently active comint buffers into another buffer,
2777 ;; or buffers, and then go back to using the comint shell.
2778 ;;
2779 ;; My particular use is SQL interpreters; I want to be able to execute a
2780 ;; query using the process associated with a comint-buffer, and save that
2781 ;; somewhere else. Because the process might have state (for example, it
2782 ;; could be in an uncommitted transaction), just running starting a new
2783 ;; process and having it execute the query and then finish, would not
2784 ;; work. I'm sure there are other uses as well, although in many cases
2785 ;; starting a new process is the simpler, and thus preferable, approach.
2786 ;;
2787 ;; The basic implementation is as follows: comint-redirect changes the
2788 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2789 ;; its own filter. The filter puts the output into the designated buffer,
2790 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2791 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2792 ;; sees the stop regexp, it restores the old filter functions, and runs
2793 ;; comint-redirect-hook.
2794 ;;
2795 ;; Each comint buffer may only use one redirection at a time, but any number
2796 ;; of different comint buffers may be simultaneously redirected.
2797 ;;
2798 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2799 ;; correct prompt for your interpreter, or that you supply a regexp that says
2800 ;; when the redirection is finished. Otherwise, redirection will continue
2801 ;; indefinitely. The code now does a sanity check to ensure that it can find
2802 ;; a prompt in the comint buffer; however, it is still important to ensure that
2803 ;; this prompt is set correctly.
2804 ;;
2805 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2806 ;; perhaps it should prompt for a terminating string (with an
2807 ;; appropriate magic default by examining what we think is the prompt)?
2808 ;;
2810 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2811 ;; Variables
2812 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2815 "*If non-nil, print messages each time the redirection filter is invoked.
2816 Also print a message when redirection is completed."
2820 ;; Directly analagous to comint-preoutput-filter-functions
2822 "List of functions to call before inserting redirected process output.
2823 Each function gets one argument, a string containing the text received
2824 from the subprocess. It should return the string to insert, perhaps
2825 the same string that was received, or perhaps a modified or transformed
2826 string.
2828 The functions on the list are called sequentially, and each one is given
2829 the string returned by the previous one. The string returned by the
2834 ;; Internal variables
2840 "Regular expression that determines when to stop redirection in Comint.
2841 When the redirection filter function is given output that matches this regexp,
2845 "If non-nil, the text that ends a redirection is included in it.
2846 More precisely, the text that matches `comint-redirect-finished-regexp'
2847 and therefore terminates an output redirection is inserted in the
2860 "If non-nil, check that redirection is likely to complete successfully.
2861 More precisely, before starting a redirection, verify that the
2862 regular expression `comint-redirect-finished-regexp' that controls
2863 when to terminate it actually matches some text already in the process
2864 buffer. The idea is that this regular expression should match a prompt
2865 string, and that there ought to be at least one copy of your prompt string
2869 "The process filter that was in place when redirection is started.
2870 When redirection is completed, the process filter is restored to
2873 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2874 ;; Functions
2875 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2878 comint-buffer
2879 finished-regexp
2881 "Set up for output redirection.
2882 This function sets local variables that are used by `comint-redirect-filter'
2883 to perform redirection.
2885 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2886 in the output matches FINISHED-REGEXP.
2888 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2889 original comint buffer.
2891 This function is called by `comint-redirect-send-command-to-process',
2892 and does not normally need to be invoked by the end user or programmer."
2916 "End a Comint redirection. See `comint-redirect-send-command'."
2918 ;; Restore the process filter
2920 comint-redirect-original-filter-function)
2921 ;; Restore the mode line
2923 ;; Set the completed flag
2926 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2927 ;; that it really occurs.
2931 "Filter function which redirects output from PROCESS to a buffer or buffers.
2932 The variable `comint-redirect-output-buffer' says which buffer(s) to
2933 place output in.
2935 INPUT-STRING is the input from the comint process.
2937 This function runs as a process filter, and does not need to be invoked by the
2938 end user."
2942 ;; If we have to echo output, give it to the original filter function
2944 comint-redirect-original-filter-function
2946 process input-string)))))
2950 "Comint filter function which redirects comint output to a buffer or buffers.
2951 The variable `comint-redirect-output-buffer' says which buffer(s) to
2952 place output in.
2954 INPUT-STRING is the input from the comint process.
2956 This function does not need to be invoked by the end user."
2959 comint-redirect-output-buffer
2963 ;; If there are any filter functions, give them a chance to modify the string
2970 ;; Clobber `comint-redirect-finished-regexp'
2976 ;; Send output to all registered buffers
2980 ;; Set this buffer to the output buffer
2982 ;; Go to the end of the buffer
2984 ;; Insert the output
2986 output-buffer-list))
2988 ;; Message
2993 ;; If we see the prompt, tidy up
2994 ;; We'll look for the prompt in the original string, so nobody can
2995 ;; clobber it
3002 ;; Echo input?
3004 filtered-input-string
3007 ;;;###autoload
3009 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3010 With prefix arg, echo output in process buffer.
3012 If NO-DISPLAY is non-nil, do not show the output buffer."
3020 ;;;###autoload
3023 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3024 With prefix arg, echo output in process buffer.
3026 If NO-DISPLAY is non-nil, do not show the output buffer."
3031 process))
3033 ;; Change to the process buffer
3036 ;; Make sure there's a prompt in the current process buffer
3043 ;;;;;;;;;;;;;;;;;;;;;
3044 ;; Set up for redirection
3045 ;;;;;;;;;;;;;;;;;;;;;
3047 ;; Output Buffer
3048 output-buffer
3049 ;; Comint Buffer
3051 ;; Finished Regexp
3052 comint-prompt-regexp
3053 ;; Echo input
3054 echo)
3056 ;;;;;;;;;;;;;;;;;;;;;
3057 ;; Set the filter
3058 ;;;;;;;;;;;;;;;;;;;;;
3059 ;; Save the old filter
3064 ;;;;;;;;;;;;;;;;;;;;;
3065 ;; Send the command
3066 ;;;;;;;;;;;;;;;;;;;;;
3071 ;;;;;;;;;;;;;;;;;;;;;
3072 ;; Show the output
3073 ;;;;;;;;;;;;;;;;;;;;;
3079 output-buffer))))))
3081 ;;;###autoload
3083 "Send COMMAND to current process.
3084 Return a list of expressions in the output which match REGEXP.
3085 REGEXP-GROUP is the regular expression group in REGEXP to use."
3088 command regexp regexp-group))
3090 ;;;###autoload
3092 "Send COMMAND to PROCESS.
3093 Return a list of expressions in the output which match REGEXP.
3094 REGEXP-GROUP is the regular expression group in REGEXP to use."
3096 results)
3101 output-buffer process nil t)
3102 ;; Wait for the process to complete
3106 ;; Collect the output
3109 ;; Skip past the command, if it was echoed
3117 results)))
3118 results)))
3123 "^Empty input ring$"
3124 "^No history$"
3127 \f
3128 ;; Converting process modes to use comint mode
3129 ;; ===========================================================================
3130 ;; The code in the Emacs 19 distribution has all been modified to use comint
3131 ;; where needed. However, there are `third-party' packages out there that
3132 ;; still use the old shell mode. Here's a guide to conversion.
3133 ;;
3134 ;; Renaming variables
3135 ;; Most of the work is renaming variables and functions. These are the common
3136 ;; ones:
3137 ;; Local variables:
3138 ;; last-input-start comint-last-input-start
3139 ;; last-input-end comint-last-input-end
3140 ;; shell-prompt-pattern comint-prompt-regexp
3141 ;; shell-set-directory-error-hook <no equivalent>
3142 ;; Miscellaneous:
3143 ;; shell-set-directory <unnecessary>
3144 ;; shell-mode-map comint-mode-map
3145 ;; Commands:
3146 ;; shell-send-input comint-send-input
3147 ;; shell-send-eof comint-delchar-or-maybe-eof
3148 ;; kill-shell-input comint-kill-input
3149 ;; interrupt-shell-subjob comint-interrupt-subjob
3150 ;; stop-shell-subjob comint-stop-subjob
3151 ;; quit-shell-subjob comint-quit-subjob
3152 ;; kill-shell-subjob comint-kill-subjob
3153 ;; kill-output-from-shell comint-delete-output
3154 ;; show-output-from-shell comint-show-output
3155 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3156 ;;
3157 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3158 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3159 ;; Comint mode does not provide functionality equivalent to
3160 ;; shell-set-directory-error-hook; it is gone.
3161 ;;
3162 ;; comint-last-input-start is provided for modes which want to munge
3163 ;; the buffer after input is sent, perhaps because the inferior
3164 ;; insists on echoing the input. The LAST-INPUT-START variable in
3165 ;; the old shell package was used to implement a history mechanism,
3166 ;; but you should think twice before using comint-last-input-start
3167 ;; for this; the input history ring often does the job better.
3168 ;;
3169 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3170 ;; *not* create the comint-mode local variables in your foo-mode function.
3171 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3172 ;; necessary comint-specific local variables. Then create the
3173 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3174 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3175 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3176 ;; get-old-input) that need to be different from the defaults. Call
3177 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3178 ;; comint-mode will take care of it. The following example, from shell.el,
3179 ;; is typical:
3180 ;;
3181 ;; (defvar shell-mode-map '())
3182 ;; (cond ((not shell-mode-map)
3183 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3184 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3185 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3186 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3187 ;; (define-key shell-mode-map "\M-?"
3188 ;; 'comint-dynamic-list-filename-completions)))
3189 ;;
3190 ;; (defun shell-mode ()
3191 ;; (interactive)
3192 ;; (comint-mode)
3193 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3194 ;; (setq major-mode 'shell-mode)
3195 ;; (setq mode-name "Shell")
3196 ;; (use-local-map shell-mode-map)
3197 ;; (make-local-variable 'shell-directory-stack)
3198 ;; (setq shell-directory-stack nil)
3199 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3200 ;; (run-hooks 'shell-mode-hook))
3201 ;;
3202 ;;
3203 ;; Completion for comint-mode users
3204 ;;
3205 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3206 ;; hook to add completion functions to. Functions on this list should return
3207 ;; non-nil if completion occurs (i.e., further completion should not occur).
3208 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3209 ;; completion job.
3210 \f
3213 ;; comint.el ends here