| blob | 72e536c0d0881eb3a26dc621bac420810e0e665f |
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-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'."
227 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
231 "*If non-nil, don't add input matching the last on the input ring.
232 This mirrors the optional behavior of bash.
234 This variable is buffer-local."
239 "*If non-nil, name of the file to read/write input history.
240 See also `comint-read-input-ring' and `comint-write-input-ring'.
242 This variable is buffer-local, and is a good thing to set in mode hooks."
244 file)
248 "*Controls whether input to interpreter causes window to scroll.
249 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
250 If `this', scroll only the selected window.
252 The default is nil.
254 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
262 "*Controls whether interpreter output causes window to scroll.
263 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
264 If `this', scroll only the selected window.
265 If `others', scroll only those that are not the selected window.
267 The default is nil.
269 See variable `comint-scroll-show-maximum-output' and function
270 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
279 "*Controls how interpreter output causes window to scroll.
280 If non-nil, then show the maximum output when the window is scrolled.
282 See variable `comint-scroll-to-bottom-on-output' and function
283 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
288 "*The maximum size in lines for comint buffers.
289 Comint buffers are truncated from the top to be no greater than this number, if
290 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
304 "*If non-nil, assume that the subprocess echoes any input.
305 If so, delete one copy of the input so that only one copy eventually
306 appears in the buffer.
308 This variable is buffer-local."
312 ;; AIX puts the name of the person being su'd to in front of the prompt.
313 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
314 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
315 ;; ssh-add prints a prompt like `Enter passphrase: '.
316 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
321 "*Regexp matching prompts for passwords in the inferior process.
322 This is used by `comint-watch-for-password-prompt'."
326 ;; Here are the per-interpreter hooks.
328 "Function that returns old text in comint mode.
329 This function is called when return is typed while the point is in old
330 text. It returns the text to be submitted as process input. The
331 default is `comint-get-old-input-default', which either grabs the
332 current input field or grabs the current line and strips off leading
333 text matching `comint-prompt-regexp', depending on the value of
338 "List of functions called to perform completion.
339 Functions should return non-nil if completion was performed.
340 See also `comint-dynamic-complete'.
346 "Predicate for filtering additions to input history.
347 Takes one argument, the input. If non-nil, the input may be saved on the input
351 "Functions to call before input is sent to the process.
352 These functions get one argument, a string containing the text to send.
357 "Functions to call after output is inserted into the buffer.
358 One possible function is `comint-postoutput-scroll-to-bottom'.
359 These functions get one argument, a string containing the text as originally
360 inserted. Note that this might not be the same as the buffer contents between
361 `comint-last-output-start' and the buffer's `process-mark', if other filter
362 functions have already modified the buffer.
364 See also `comint-preoutput-filter-functions'.
369 "Function to actually send to PROCESS the STRING submitted by user.
370 Usually this is just `comint-simple-send', but if your mode needs to
371 massage the input string, put a different function here.
372 `comint-simple-send' just sends the string plus a newline.
376 "*Non-nil means go to the end of the line before sending input.
377 See `comint-send-input'."
381 ;; Note: If it is decided to purge comint-prompt-regexp from the source
382 ;; entirely, searching for uses of this variable will help to identify
383 ;; places that need attention.
385 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
386 If nil, then program output and user-input are given different `field'
387 properties, which emacs commands can use to distinguish them (in
388 particular, common movement commands such as begining-of-line respect
389 field boundaries in a natural way)."
394 "Called upon entry into `comint-mode'
395 This is run before the process is cranked up."
400 "Called each time a process is exec'd by `comint-exec'.
401 This is called after the process is cranked up. It is useful for things that
402 must be done each time a process is executed in a comint mode buffer (e.g.,
403 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
404 executed once when the buffer is created."
411 "Non-nil if communications via pty; false if by pipe. Buffer local.
423 "Last input ring index which you copied.
427 "Non-nil if you are accumulating input lines to send as input together.
446 "Major mode for interacting with an inferior interpreter.
447 Interpreter name is same as buffer name, sans the asterisks.
448 Return at end of buffer sends line as input.
449 Return not at end copies rest of line to end and sends it.
450 Setting variable `comint-eol-on-send' means jump to the end of the line
451 before submitting new input.
453 This mode is customised to create major modes such as Inferior Lisp
454 mode, Shell mode, etc. This can be done by setting the hooks
455 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
456 and `comint-get-old-input' to appropriate functions, and the variable
457 `comint-prompt-regexp' to the appropriate regular expression.
459 An input history is maintained of size `comint-input-ring-size', and
460 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
461 Input ring history expansion can be achieved with the commands
463 Input ring expansion is controlled by the variable `comint-input-autoexpand',
464 and addition is controlled by the variable `comint-input-ignoredups'.
466 Commands with no default key bindings include `send-invisible',
467 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
468 `comint-magic-space'.
470 Input to, and output from, the subprocess can cause the window to scroll to
471 the end of the buffer. See variables `comint-output-filter-functions',
472 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
473 and `comint-scroll-to-bottom-on-output'.
476 to continue it.
480 Entry to this mode runs the hooks on `comint-mode-hook'."
528 ;; This behavior is not useful in comint buffers, and is annoying
532 nil
533 ;; Keys:
563 ;; Mouse Buttons:
565 ;; Menu bars:
566 ;; completion:
577 ;; Input history:
618 ;; Signals
633 ;; Put them in the menu bar:
635 menu-bar-final-items))
636 )
639 "Return t if there is a living process associated w/buffer BUFFER.
640 Living means the status is `open', `run', or `stop'.
641 BUFFER can be either a buffer or the name of one."
645 ;;;###autoload
647 "Make a comint process NAME in BUFFER, running PROGRAM.
648 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
649 PROGRAM should be either a string denoting an executable program to create
650 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
651 connection to be opened via `open-network-stream'. If there is already a
652 running process in that buffer, it is not restarted. Optional third arg
653 STARTFILE is the name of a file to send the contents of to the process.
655 If PROGRAM is a string, any more args are arguments to PROGRAM."
659 ;; If no process, or nuked process, crank up a new one and put buffer in
660 ;; comint mode. Otherwise, leave buffer and existing process alone.
665 buffer)
667 ;;;###autoload
669 "Make a comint process NAME in a buffer, running PROGRAM.
670 The name of the buffer is made by surrounding NAME with `*'s.
671 PROGRAM should be either a string denoting an executable program to create
672 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
673 connection to be opened via `open-network-stream'. If there is already a
674 running process in that buffer, it is not restarted. Optional third arg
675 STARTFILE is the name of a file to send the contents of to the process.
677 If PROGRAM is a string, any more args are arguments to PROGRAM."
680 ;;;###autoload
682 "Run PROGRAM in a comint buffer and switch to it.
683 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
684 The file name is used to make a symbol name, such as `comint-sh-hook', and any
685 hooks on this symbol are run in the buffer.
686 See `make-comint' and `comint-exec'."
693 "Start up a process in buffer BUFFER for comint modes.
694 Blasts any old process running in the buffer. Doesn't set the buffer mode.
695 You can use this to cheaply run a series of processes in the same comint
696 buffer. The hook `comint-exec-hook' is run after each exec."
701 ;; Crank up a new process
709 ;; Jump to the end, and set the process mark.
712 ;; Feed it the startfile.
714 ;;This is guaranteed to wait long enough
715 ;;but has bad results if the comint does not prompt at all
716 ;; (while (= size (buffer-size))
717 ;; (sleep-for 1))
718 ;;I hope 1 second is enough!
726 buffer)))
728 ;; This auxiliary function cranks up the process for comint-exec in
729 ;; the appropriate environment.
734 ;; If using termcap, we specify `emacs' as the terminal type
735 ;; because that lets us specify a width.
736 ;; If using terminfo, we specify `dumb' because that is
737 ;; a defined terminal type. `emacs' is not a defined terminal type
738 ;; and there is no way for us to define it here.
739 ;; Some programs that use terminfo get very confused
740 ;; if TERM is not a valid terminal type.
747 process-environment))
750 default-directory
752 proc decoding encoding changed)
754 ;; If the command has slashes, make sure we
755 ;; first look relative to the current directory.
761 ;; If start-process decided to use some coding system for decoding
762 ;; data sent from the process and the coding system doesn't
763 ;; specify EOL conversion, we had better convert CRLF to LF.
766 changed t))
767 ;; Even if start-process left the coding system for encoding data
768 ;; sent from the process undecided, we had better use the same one
769 ;; as what we use for decoding. But, we should suppress EOL
770 ;; conversion.
773 changed t))
776 proc))
780 "In a comint buffer, set the current input to the clicked-on previous input."
783 ;; Ignore non-input overlays
787 ;; do we have input in this area?
792 ;; Can't use kill-region as it sets this-command
797 ;; fall back to the user's previous definition if we aren't
798 ;; on previous input region.
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."
1142 ;; This seems a bit complex. We look for references such as !!, !-num,
1143 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1144 ;; If that wasn't enough, the plings can be suffixed with argument
1145 ;; range specifiers.
1146 ;; Argument ranges are complex too, so we hive off the input line,
1147 ;; referenced with plings, with the range string to `comint-args'.
1151 ;; The history is quoted, or we're in quotes.
1154 ;; We cannot know the interpreter's idea of input line numbers.
1158 ;; Just a number of args from `number' lines backward.
1167 t t)
1173 ;; Just a number of args from the previous input line.
1177 t t)
1181 ;; Most recent input starting with or containing (possibly
1182 ;; protected) string, maybe just a number of args. Phew.
1200 t t)
1203 ;; Quick substitution on the previous input line.
1220 "Expand input history references before point and insert ARG spaces.
1221 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1225 \f
1227 "Return t if the number of quotes between BEG and END is odd.
1228 Quotes are single and double."
1234 "Return number of matches for REGEXP from BEG to END."
1241 count))
1244 ;; From STRING, return the args depending on the range specified in the text
1245 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1246 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1262 ;; Return a list of arguments from ARG. Break it up at the
1263 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1278 comint-delimiter-argument-list)))
1281 args)))
1284 "Return from STRING the NTH to MTH arguments.
1285 NTH and/or MTH can be nil, which means the last argument.
1286 Returned arguments are separated by single spaces.
1287 We assume whitespace separates arguments, except within quotes
1288 and except for a space or tab that immediately follows a backslash.
1289 Also, a run of one or more of a single character
1290 in `comint-delimiter-argument-list' is a separate argument.
1291 Argument 0 is the command name."
1292 ;; The first line handles ordinary characters and backslash-sequences
1293 ;; (except with w32 msdos-like shells, where backslashes are valid).
1294 ;; The second matches "-quoted strings.
1295 ;; The third matches '-quoted strings.
1296 ;; The fourth matches `-quoted strings.
1297 ;; This seems to fit the syntax of BASH 2.0.
1308 beg str value quotes)
1309 ;; Build a list of all the args until we have as many as we want.
1313 ;; It's contiguous, part of the same arg.
1316 ;; It's a new separate arg.
1318 ;; Put the previous arg, if there was one, onto ARGS.
1335 \f
1336 ;;
1337 ;; Input processing stuff
1338 ;;
1340 "Add CMD to the input history.
1341 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1347 cmd))))
1351 "Send input to process.
1352 After the process output mark, sends all text from the process mark to
1353 point as input to the process. Before the process output mark, calls value
1354 of variable `comint-get-old-input' to retrieve old input, copies it to the
1355 process mark, and sends it. If variable `comint-process-echoes' is nil,
1356 a terminal newline is also inserted into the buffer and sent to the process
1357 \(if it is non-nil, all text from the process mark to point is deleted,
1358 since it is assumed the remote process will re-echo it).
1360 Any history reference may be expanded depending on the value of the variable
1361 `comint-input-autoexpand'. The list of function names contained in the value
1362 of `comint-input-filter-functions' is called on the input before sending it.
1363 The input is entered into the input history ring, if the value of variable
1364 `comint-input-filter' returns non-nil when called on the input.
1366 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1367 end of line before sending the input.
1369 The values of `comint-get-old-input', `comint-input-filter-functions', and
1370 `comint-input-filter' are chosen according to the command interpreter running
1371 in the buffer. E.g.,
1373 If the interpreter is the csh,
1374 comint-get-old-input is the default: either return the current
1375 field, or take the current line and discard any
1376 initial string matching regexp `comint-prompt-regexp', depending
1377 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1380 comint-input-filter is the default: returns t if the input isn't all white
1381 space.
1383 If the comint is Lucid Common Lisp,
1384 comint-get-old-input snarfs the sexp ending at point.
1385 comint-input-filter-functions does nothing.
1386 comint-input-filter returns nil if the input matches input-filter-regexp,
1387 which matches (1) all whitespace (2) :a, :c, etc.
1389 Similarly for Soar, Scheme, etc."
1391 ;; Note that the input string does not include its terminal newline.
1401 copy)))
1403 ;; Just whatever's already there
1404 intxt
1405 ;; Expand and leave it visible in buffer
1409 input
1410 ;; This is messy 'cos ultimately the original
1411 ;; functions used do insertion, rather than return
1412 ;; strings. We have to expand, then insert back.
1418 copy))))
1432 ;; Make an overlay for the input field
1435 ;; Give old user input a field property of `input', to
1436 ;; distinguish it from both process output and unsent
1437 ;; input. The terminating newline is put into a special
1438 ;; `boundary' field to make cursor movement between input
1439 ;; and output fields smoother.
1446 ;; Make an overlay for the terminating newline
1455 ;; Update the markers before we send the input
1456 ;; in case we get output amidst sending the input.
1460 ;; clear the "accumulation" marker
1463 ;; This used to call comint-output-filter-functions,
1464 ;; but that scrolled the buffer in undesirable ways.
1468 "List of functions to call before inserting Comint output into the buffer.
1469 Each function gets one argument, a string containing the text received
1470 from the subprocess. It should return the string to insert, perhaps
1471 the same string that was received, or perhaps a modified or transformed
1472 string.
1474 The functions on the list are called sequentially, and each one is
1475 given the string returned by the previous one. The string returned by
1476 the last function is the text that is actually inserted in the
1477 redirection buffer.
1481 ;; When non-nil, this is the last overlay used for output.
1482 ;; It is kept around so that we can extend it instead of creating
1483 ;; multiple contiguous overlays for multiple contiguous output chunks.
1486 ;; When non-nil, this is an overlay over the last recognized prompt in
1487 ;; the buffer; it is used when highlighting the prompt.
1490 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1491 ;; Any further output will then create a new comint-last-prompt-overlay.
1497 ;; The purpose of using this filter for comint processes
1498 ;; is to keep comint-last-input-end from moving forward
1499 ;; when output is inserted.
1502 ;; First check for killed buffer or no input.
1505 ;; Run preoutput filters
1511 ;; Insert STRING
1513 ;; Avoid the overhead of save-excursion, since we just
1514 ;; fiddle with the point
1517 ;; The point should float after any insertion we do
1520 ;; We temporarly remove any buffer narrowing, in case the
1521 ;; process mark is outside of the restriction
1528 ;; insert-before-markers is a bad thing. XXX
1529 ;;
1530 ;; It is used here to force window-point markers (used to
1531 ;; store the value of point in non-selected windows) to
1532 ;; advance, but it also screws up any other markers that we
1533 ;; don't _want_ to advance, such as the start-marker of some
1534 ;; of the overlays we create.
1535 ;;
1536 ;; We work around the problem with the overlays by
1537 ;; explicitly adjusting them after we do the insertion, but
1538 ;; in the future this problem should be solved correctly, by
1539 ;; using `insert', and making the insertion-type of
1540 ;; window-point markers settable (via a buffer-local
1541 ;; variable). In comint buffers, this variable would be set
1542 ;; to `t', to cause point in non-select windows to advance.
1544 ;; Fixup markers and overlays that got screwed up because we
1545 ;; used `insert-before-markers'.
1547 ;; comint-last-output-start
1549 ;; comint-last-input-end
1554 ;; No overlays we create are set to advance upon insertion
1555 ;; (at the start/end), so we assume that any overlay which
1556 ;; is at the current point was incorrectly advanced by
1557 ;; insert-before-markers. First fixup overlays that might
1558 ;; start at point:
1563 old-point
1565 ;; Then do overlays that might end at point:
1570 old-point))))
1572 ;; Advance process-mark
1576 ;; We check to see if the last overlay used for output is
1577 ;; adjacent to the new input, and if so, just extend it.
1581 ;; Extend comint-last-output-overlay to include the
1582 ;; most recent output
1586 ;; Create a new overlay
1594 ;; Highlight the prompt, where we define `prompt' to mean
1595 ;; the most recent output that doesn't end with a newline.
1597 ;; Need to create or move the prompt overlay (in the case
1598 ;; where there is no prompt ((bolp) == t), we still do
1599 ;; this if there's already an existing overlay).
1602 ;; Just move an existing overlay
1605 ;; Need to create the overlay
1616 "Go to the end of buffer in all windows showing it.
1617 Movement occurs if point in the selected window is not after the process mark,
1618 and `this-command' is an insertion command. Insertion commands recognised
1619 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1620 Depends on the value of `comint-scroll-to-bottom-on-input'.
1622 This function should be a pre-command hook."
1625 hilit-yank)))
1641 nil t))))))
1644 "Go to the end of buffer in all windows showing it.
1645 Does not scroll if the current line is the last line in the buffer.
1646 Depends on the value of `comint-scroll-to-bottom-on-output' and
1647 `comint-scroll-show-maximum-output'.
1649 This function should be in the list `comint-output-filter-functions'."
1663 ;; Maybe user wants point to jump to end.
1666 ;; If point was at the end, keep it at end.
1670 ;; Optionally scroll so that the text
1671 ;; ends at the bottom of the window.
1678 nil t))
1682 "Truncate the buffer to `comint-buffer-maximum-size'.
1683 This function could be on `comint-output-filter-functions' or bound to a key."
1692 "Strip trailing `^M' characters from the current output group.
1693 This function could be on `comint-output-filter-functions' or bound to a key."
1706 "Put the end of the buffer at the bottom of the window."
1712 "Default for `comint-get-old-input'.
1713 Returns either the current field, or the current line with any initial
1714 text matching `comint-prompt-regexp' stripped off, depending on the
1715 value of `comint-use-prompt-regexp-instead-of-fields'."
1723 ;; Return the contents of the field at the current point.
1730 "Insert after prompt old input at point as new input to be edited.
1731 Calls `comint-get-old-input' to get old input."
1741 "Skip past the text matching regexp `comint-prompt-regexp'.
1742 If this takes us past the end of the current line, don't skip at all."
1749 "Return t if point is after the process output marker."
1754 "Default function for sending to PROC input STRING.
1755 This just sends STRING plus a newline. To override this,
1756 set the hook `comint-input-sender'."
1761 "Returns the buffer position of the beginning of the line, after any prompt.
1762 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1763 prompt skip is done by skipping text matching the regular expression
1764 `comint-prompt-regexp', a buffer local variable."
1766 ;; Use comint-prompt-regexp
1771 ;; Use input fields. Note that, unlike the behavior of
1772 ;; `line-beginning-position' inside a field, this function will
1773 ;; return the position of the end of a prompt, even if the point is
1774 ;; already inside the prompt. In order to do this, it assumes that
1775 ;; if there are two fields on a line, then the first one is the
1776 ;; prompt, and the second one is an input field, and is front-sticky
1777 ;; (as input fields should be).
1781 "Goes to the beginning of line, then skips past the prompt, if any.
1783 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1784 prompt skip is done by skipping text matching the regular expression
1785 `comint-prompt-regexp', a buffer local variable."
1788 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1792 ;; These three functions are for entering text you don't want echoed or
1793 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1794 ;; Just enter m-x send-invisible and type in your line, or add
1795 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1798 "Read a single line of text from user without echoing, and return it.
1799 Prompt with argument PROMPT, a string. Optional argument STARS causes
1800 input to be echoed with '*' characters on the prompt line. Input ends with
1801 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1802 `inhibit-quit' is set because e.g. this function was called from a process
1803 filter and C-g is pressed, this function returns nil rather than a string).
1805 Note that the keystrokes comprising the text can still be recovered
1807 Once the caller uses the password, it can erase the password
1808 by doing (fillarray STRING 0)."
1820 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1823 ;; This function may get called from a process filter, where
1824 ;; inhibit-quit is set. In later versions of emacs read-char
1825 ;; may clear quit-flag itself and return C-g. That would make
1826 ;; it impossible to quit this loop in a simple way, so
1827 ;; re-enable it here (for backward-compatibility the check for
1828 ;; quit-flag below would still be necessary, so this seems
1829 ;; like the simplest way to do things).
1831 done t))
1845 ;; Emulate a true quit, except that we have to return a value.
1851 ans)))
1854 "Read a string without echoing.
1855 Then send it to the process running in the current buffer.
1856 The string is sent using `comint-input-sender'.
1857 Security bug: your string can still be temporarily recovered with
1873 "Prompt in the minibuffer for password and send without echoing.
1874 This function uses `send-invisible' to read and send a password to the buffer's
1875 process if STRING contains a password prompt defined by
1876 `comint-password-prompt-regexp'.
1878 This function could be in the list `comint-output-filter-functions'."
1882 \f
1883 ;; Low-level process communication
1886 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1896 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1904 \f
1905 ;; Random input hackage
1908 "Delete all output from interpreter since last input.
1909 Does not delete the prompt."
1922 ;; Output message and put back prompt
1928 "Write output from interpreter since last input to FILENAME.
1929 Any prompt at the end of the output is not written.
1931 If the optional argument APPEND (the prefix argument when interactive)
1932 is non-nil, the output is appended to the file instead.
1934 If the optional argument MUSTBENEW is non-nil, check for an existing
1935 file with the same name. If MUSTBENEW is `excl', that means to get an
1936 error if the file already exists; never overwrite. If MUSTBENEW is
1937 neither nil nor `excl', that means ask for confirmation before
1938 overwriting, but do go ahead and overwrite the file if the user
1939 confirms. When interactive, MUSTBENEW is nil when appending, and t
1940 otherwise."
1944 "Append output to file: "
1946 current-prefix-arg
1952 append nil nil mustbenew)))
1954 ;; This function exists for the benefit of the menu; from the keyboard,
1955 ;; users can just use `comint-write-output' with a prefix arg.
1957 "Append output from interpreter since last input to FILENAME.
1958 Any prompt at the end of the output is not written."
1963 "Display start of this batch of interpreter output at top of window.
1964 Sets mark to the value of point when this command is run."
1979 "Interrupt the current subjob.
1980 This command also kills the pending input
1981 between the process-mark and point."
1987 "Send kill signal to the current subjob.
1988 This command also kills the pending input
1989 between the process-mark and point."
1995 "Send quit signal to the current subjob.
1996 This command also kills the pending input
1997 between the process-mark and point."
2003 "Stop the current subjob.
2004 This command also kills the pending input
2005 between the process-mark and point.
2007 WARNING: if there is no current subjob, you can end up suspending
2008 the top-level process running in the buffer. If you accidentally do
2010 is not a problem with most shells, since they ignore this signal.)"
2016 "Send CONT signal to process buffer's process group.
2017 Useful if you accidentally suspend the top-level process."
2022 "Kill all text from last stuff output by interpreter to point."
2029 "Delete ARG characters forward or send an EOF to subprocess.
2030 Sends an EOF only if point is at the end of the buffer and there is no input."
2038 "Send an EOF to the current buffer's process."
2045 "Search backward through buffer for input fields that match REGEXP.
2046 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2047 fields are identified by lines that match `comint-prompt-regexp'.
2049 With prefix argument N, search for Nth previous match.
2050 If N is negative, find the next or Nth next match."
2053 ;; Use comint-prompt-regexp
2063 ;; Use input fields
2077 "Search forward through buffer for input fields that match REGEXP.
2078 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2079 fields are identified by lines that match `comint-prompt-regexp'.
2081 With prefix argument N, search for Nth following match.
2082 If N is negative, find the previous or Nth previous match."
2088 "Move to end of Nth next prompt in the buffer.
2089 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2090 the beginning of the Nth next `input' field, otherwise, it means the Nth
2091 occurance of text matching `comint-prompt-regexp'."
2094 ;; Use comint-prompt-regexp
2099 ;; Use input fields
2108 ;; Ran off the end of the buffer.
2118 "Move to end of Nth previous prompt in the buffer.
2119 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2120 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2121 occurance of text matching `comint-prompt-regexp'."
2124 \f
2125 ;; Support for source-file processing commands.
2126 ;;============================================================================
2127 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2128 ;; commands that process files of source text (e.g. loading or compiling
2129 ;; files). So the corresponding process-in-a-buffer modes have commands
2130 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2131 ;; for defining these commands.
2132 ;;
2133 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2134 ;; and Soar, in that they don't know anything about file extensions.
2135 ;; So the compile/load interface gets the wrong default occasionally.
2136 ;; The load-file/compile-file default mechanism could be smarter -- it
2137 ;; doesn't know about the relationship between filename extensions and
2138 ;; whether the file is source or executable. If you compile foo.lisp
2139 ;; with compile-file, then the next load-file should use foo.bin for
2140 ;; the default, not foo.lisp. This is tricky to do right, particularly
2141 ;; because the extension for executable files varies so much (.o, .bin,
2142 ;; .lbin, .mo, .vo, .ao, ...).
2145 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2146 ;; commands.
2147 ;;
2148 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2149 ;; want to save the buffer before issuing any process requests to the command
2150 ;; interpreter.
2151 ;;
2152 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2153 ;; for the file to process.
2155 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2156 ;;============================================================================
2157 ;; This function computes the defaults for the load-file and compile-file
2158 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2159 ;;
2160 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2161 ;; source-file processing command. NIL if there hasn't been one yet.
2162 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2163 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2164 ;; Typically, (lisp-mode) or (scheme-mode).
2165 ;;
2166 ;; If the command is given while the cursor is inside a string, *and*
2167 ;; the string is an existing filename, *and* the filename is not a directory,
2168 ;; then the string is taken as default. This allows you to just position
2169 ;; your cursor over a string that's a filename and have it taken as default.
2170 ;;
2171 ;; If the command is given in a file buffer whose major mode is in
2172 ;; SOURCE-MODES, then the the filename is the default file, and the
2173 ;; file's directory is the default directory.
2174 ;;
2175 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2176 ;; then the default directory & file are what was used in the last source-file
2177 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2178 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2179 ;; is the cwd, with no default file. (\"no default file\" = nil)
2180 ;;
2181 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2182 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2183 ;; for Soar programs, etc.
2184 ;;
2185 ;; The function returns a pair: (default-directory . default-file).
2196 ;; (COMINT-CHECK-SOURCE fname)
2197 ;;============================================================================
2198 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2199 ;; process-in-a-buffer modes), this function can be called on the filename.
2200 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2201 ;; is queried to see if he wants to save the buffer before proceeding with
2202 ;; the load or compile.
2209 ;; save BUFF.
2216 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2217 ;;============================================================================
2218 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2219 ;; commands that process source files (like loading or compiling a file).
2220 ;; It prompts for the filename, provides a default, if there is one,
2221 ;; and returns the result filename.
2222 ;;
2223 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2224 ;;
2225 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2226 ;; from the last source processing command. SOURCE-MODES is a list of major
2227 ;; modes used to determine what file buffers contain source files. (These
2228 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2229 ;; then the filename reader will only accept a file that exists.
2230 ;;
2231 ;; A typical use:
2232 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2233 ;; '(lisp-mode) t))
2235 ;; This is pretty stupid about strings. It decides we're in a string
2236 ;; if there's a quote on both sides of point on the current line.
2238 "Return string around POINT that starts the current line, or nil."
2265 prompt deffile)
2266 prompt)
2267 defdir
2269 mustmatch-p)))
2272 ;; I am somewhat divided on this string-default feature. It seems
2273 ;; to violate the principle-of-least-astonishment, in that it makes
2274 ;; the default harder to predict, so you actually have to look and see
2275 ;; what the default really is before choosing it. This can trip you up.
2276 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2277 ;; on this.
2278 ;; -Olin
2280 \f
2281 ;; Simple process query facility.
2282 ;; ===========================================================================
2283 ;; This function is for commands that want to send a query to the process
2284 ;; and show the response to the user. For example, a command to get the
2285 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2286 ;; to an inferior Common Lisp process.
2287 ;;
2288 ;; This simple facility just sends strings to the inferior process and pops
2289 ;; up a window for the process buffer so you can see what the process
2290 ;; responds with. We don't do anything fancy like try to intercept what the
2291 ;; process responds with and put it in a pop-up window or on the message
2292 ;; line. We just display the buffer. Low tech. Simple. Works good.
2294 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2295 ;; a window for the inferior process so that its response can be seen.
2305 ;; Try to position the proc window so you can see the answer.
2306 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2307 ;; I don't know why. Wizards invited to improve it.
2316 \f
2317 ;; Filename/command/history completion in a buffer
2318 ;; ===========================================================================
2319 ;; Useful completion functions, courtesy of the Ergo group.
2321 ;; Six commands:
2322 ;; comint-dynamic-complete Complete or expand command, filename,
2323 ;; history at point.
2324 ;; comint-dynamic-complete-filename Complete filename at point.
2325 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2326 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2327 ;; replace with expanded/completed name.
2328 ;; comint-dynamic-simple-complete Complete stub given candidates.
2330 ;; These are not installed in the comint-mode keymap. But they are
2331 ;; available for people who want them. Shell-mode installs them:
2332 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2333 ;; (define-key shell-mode-map "\M-?"
2334 ;; 'comint-dynamic-list-filename-completions)))
2335 ;;
2336 ;; Commands like this are fine things to put in load hooks if you
2337 ;; want them present in specific modes.
2340 "*If non-nil, automatically list possibilities on partial completion.
2341 This mirrors the optional behavior of tcsh."
2346 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2347 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2348 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2349 This mirrors the optional behavior of tcsh."
2358 "*If non-nil, use shortest completion if characters cannot be added.
2359 This mirrors the optional behavior of tcsh.
2361 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2366 "*List of suffixes to be disregarded during file completion.
2367 This mirrors the optional behavior of bash and tcsh.
2369 Note that this applies to `comint-dynamic-complete-filename' only."
2374 "Prefix prepended to absolute file names taken from process input.
2375 This is used by comint's and shell's completion functions, and by shell's
2380 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2382 "String of characters valid in a file name.
2383 Note that all non-ASCII characters are considered valid in a file name
2384 regardless of what this variable says.
2395 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2398 directory)))
2402 "Return the word of WORD-CHARS at point, or nil if non is found.
2403 Word constituents are considered to be those in WORD-CHARS, which is like the
2405 plus all non-ASCII characters."
2409 ;;(memq (char-after (point)) shell-file-name-quote-list)
2413 ;; Don't go forward over a word-char (this can happen if we're at bob).
2416 ;; Set match-data to match the entire string.
2422 "Return FILENAME with environment variables substituted.
2423 Supports additional environment variable syntax of the command
2424 interpreter (e.g., the percent notation of cmd.exe on NT)."
2428 env-var-val)
2437 name))
2440 "Return the filename at point, or nil if non is found.
2441 Environment variables are substituted. See `comint-word'."
2448 "Return FILENAME with magic characters quoted.
2449 Magic characters are those in `comint-file-name-quote-list'."
2451 filename
2458 filename))))
2461 "Return FILENAME with quoted characters unquoted."
2463 filename
2469 filename)))
2473 "Dynamically perform completion at point.
2474 Calls the functions in `comint-dynamic-complete-functions' to perform
2475 completion until a function returns non-nil, at which point completion is
2476 assumed to have occurred."
2482 "Dynamically complete the filename at point.
2483 Completes if after a filename. See `comint-match-partial-filename' and
2484 `comint-dynamic-complete-as-filename'.
2485 This function is similar to `comint-replace-by-expanded-filename', except that
2486 it won't change parts of the filename already entered in the buffer; it just
2487 adds completion characters to the end of the filename. A completions listing
2488 may be shown in a help buffer if completion is ambiguous.
2490 Completion is dependent on the value of `comint-completion-addsuffix',
2491 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2492 completions listing is dependent on the value of `comint-completion-autolist'.
2494 Returns t if successful."
2502 "Dynamically complete at point as a filename.
2503 See `comint-dynamic-complete-filename'. Returns t if successful."
2506 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2507 ;; I think it was originally bound to solve file completion problems,
2508 ;; but subsequent changes may have made this unnecessary. sm.
2509 ;;(file-name-handler-alist nil)
2544 ;; We inserted a unique completion.
2551 ;; It's not unique, but user wants shortest match.
2557 ;; It's not unique, list possible completions.
2562 success))
2566 "Dynamically expand and complete the filename at point.
2567 Replace the filename with an expanded, canonicalised and completed replacement.
2570 removed, and the filename is made absolute instead of relative. For expansion
2571 see `expand-file-name' and `substitute-in-file-name'. For completion see
2572 `comint-dynamic-complete-filename'."
2579 "Dynamically complete STUB from CANDIDATES list.
2580 This function inserts completion characters at point by completing STUB from
2581 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2582 if completion is ambiguous.
2584 Returns nil if no completion was inserted.
2585 Returns `sole' if completed with the only completion match.
2586 Returns `shortest' if completed with the shortest of the completion matches.
2587 Returns `partial' if completed as far as possible with the completion matches.
2588 Returns `listed' if a completion listing was shown.
2590 See also `comint-dynamic-complete-filename'."
2599 nil)
2610 ;; Insert the longest substring.
2615 ;; It's not unique, but user wants shortest match.
2621 ;; It's not unique, list possible completions.
2630 "List in help buffer possible completions of the filename at point."
2633 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2634 ;; I think it was originally bound to solve file completion problems,
2635 ;; but subsequent changes may have made this unnecessary. sm.
2636 ;;(file-name-handler-alist nil)
2649 "List in help buffer sorted COMPLETIONS.
2650 Typing SPC flushes the help buffer."
2664 ;; If the user does mouse-choose-completion with the mouse,
2665 ;; execute the command, then delete the completion window.
2672 \f
2674 "After fetching a line from input history, this fetches the following line.
2675 In other words, this recalls the input line after the line you recalled last.
2676 You can use this to repeat a sequence of input lines."
2685 "Accumulate a line to send as input along with more lines.
2686 This inserts a newline so that you can enter more text
2688 to send all the accumulated input, at once.
2689 The entire accumulated text becomes one item in the input history
2690 when you send it."
2699 "Move point to the process mark.
2700 The process mark separates output, and input already sent,
2701 from input that has not yet been sent."
2710 "Move point to beginning of line (after prompt) or to the process mark.
2711 The first time you use this command, it moves to the beginning of the line
2712 \(but after the prompt, if any). If you repeat it again immediately,
2713 it moves point to the process mark.
2715 The process mark separates the process output, along with input already sent,
2716 from input that has not yet been sent. Ordinarily, the process mark
2717 is at the beginning of the current input line; but if you have
2719 the process mark is at the beginning of the accumulated input."
2726 "Set the process mark at point."
2733 \f
2734 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2736 ;; This little add-on for comint is intended to make it easy to get
2737 ;; output from currently active comint buffers into another buffer,
2738 ;; or buffers, and then go back to using the comint shell.
2739 ;;
2740 ;; My particular use is SQL interpreters; I want to be able to execute a
2741 ;; query using the process associated with a comint-buffer, and save that
2742 ;; somewhere else. Because the process might have state (for example, it
2743 ;; could be in an uncommitted transaction), just running starting a new
2744 ;; process and having it execute the query and then finish, would not
2745 ;; work. I'm sure there are other uses as well, although in many cases
2746 ;; starting a new process is the simpler, and thus preferable, approach.
2747 ;;
2748 ;; The basic implementation is as follows: comint-redirect changes the
2749 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2750 ;; its own filter. The filter puts the output into the designated buffer,
2751 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2752 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2753 ;; sees the stop regexp, it restores the old filter functions, and runs
2754 ;; comint-redirect-hook.
2755 ;;
2756 ;; Each comint buffer may only use one redirection at a time, but any number
2757 ;; of different comint buffers may be simultaneously redirected.
2758 ;;
2759 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2760 ;; correct prompt for your interpreter, or that you supply a regexp that says
2761 ;; when the redirection is finished. Otherwise, redirection will continue
2762 ;; indefinitely. The code now does a sanity check to ensure that it can find
2763 ;; a prompt in the comint buffer; however, it is still important to ensure that
2764 ;; this prompt is set correctly.
2765 ;;
2766 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2767 ;; perhaps it should prompt for a terminating string (with an
2768 ;; appropriate magic default by examining what we think is the prompt)?
2769 ;;
2771 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2772 ;; Variables
2773 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2776 "*If non-nil, print messages each time the redirection filter is invoked.
2777 Also print a message when redirection is completed."
2781 ;; Directly analagous to comint-preoutput-filter-functions
2783 "List of functions to call before inserting redirected process output.
2784 Each function gets one argument, a string containing the text received
2785 from the subprocess. It should return the string to insert, perhaps
2786 the same string that was received, or perhaps a modified or transformed
2787 string.
2789 The functions on the list are called sequentially, and each one is given
2790 the string returned by the previous one. The string returned by the
2795 ;; Internal variables
2801 "Regular expression that determines when to stop redirection in Comint.
2802 When the redirection filter function is given output that matches this regexp,
2806 "If non-nil, the text that ends a redirection is included in it.
2807 More precisely, the text that matches `comint-redirect-finished-regexp'
2808 and therefore terminates an output redirection is inserted in the
2821 "If non-nil, check that redirection is likely to complete successfully.
2822 More precisely, before starting a redirection, verify that the
2823 regular expression `comint-redirect-finished-regexp' that controls
2824 when to terminate it actually matches some text already in the process
2825 buffer. The idea is that this regular expression should match a prompt
2826 string, and that there ought to be at least one copy of your prompt string
2830 "The process filter that was in place when redirection is started.
2831 When redirection is completed, the process filter is restored to
2834 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2835 ;; Functions
2836 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2839 comint-buffer
2840 finished-regexp
2842 "Set up for output redirection.
2843 This function sets local variables that are used by `comint-redirect-filter'
2844 to perform redirection.
2846 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2847 in the output matches FINISHED-REGEXP.
2849 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2850 original comint buffer.
2852 This function is called by `comint-redirect-send-command-to-process',
2853 and does not normally need to be invoked by the end user or programmer."
2877 "End a Comint redirection. See `comint-redirect-send-command'."
2879 ;; Restore the process filter
2881 comint-redirect-original-filter-function)
2882 ;; Restore the mode line
2884 ;; Set the completed flag
2887 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2888 ;; that it really occurs.
2892 "Filter function which redirects output from PROCESS to a buffer or buffers.
2893 The variable `comint-redirect-output-buffer' says which buffer(s) to
2894 place output in.
2896 INPUT-STRING is the input from the comint process.
2898 This function runs as a process filter, and does not need to be invoked by the
2899 end user."
2903 ;; If we have to echo output, give it to the original filter function
2905 comint-redirect-original-filter-function
2907 process input-string)))))
2911 "Comint filter function which redirects comint output to a buffer or buffers.
2912 The variable `comint-redirect-output-buffer' says which buffer(s) to
2913 place output in.
2915 INPUT-STRING is the input from the comint process.
2917 This function does not need to be invoked by the end user."
2920 comint-redirect-output-buffer
2924 ;; If there are any filter functions, give them a chance to modify the string
2931 ;; Clobber `comint-redirect-finished-regexp'
2937 ;; Send output to all registered buffers
2941 ;; Set this buffer to the output buffer
2943 ;; Go to the end of the buffer
2945 ;; Insert the output
2947 output-buffer-list))
2949 ;; Message
2954 ;; If we see the prompt, tidy up
2955 ;; We'll look for the prompt in the original string, so nobody can
2956 ;; clobber it
2963 ;; Echo input?
2965 filtered-input-string
2968 ;;;###autoload
2970 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2971 With prefix arg, echo output in process buffer.
2973 If NO-DISPLAY is non-nil, do not show the output buffer."
2981 ;;;###autoload
2984 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2985 With prefix arg, echo output in process buffer.
2987 If NO-DISPLAY is non-nil, do not show the output buffer."
2992 process))
2994 ;; Change to the process buffer
2997 ;; Make sure there's a prompt in the current process buffer
3004 ;;;;;;;;;;;;;;;;;;;;;
3005 ;; Set up for redirection
3006 ;;;;;;;;;;;;;;;;;;;;;
3008 ;; Output Buffer
3009 output-buffer
3010 ;; Comint Buffer
3012 ;; Finished Regexp
3013 comint-prompt-regexp
3014 ;; Echo input
3015 echo)
3017 ;;;;;;;;;;;;;;;;;;;;;
3018 ;; Set the filter
3019 ;;;;;;;;;;;;;;;;;;;;;
3020 ;; Save the old filter
3025 ;;;;;;;;;;;;;;;;;;;;;
3026 ;; Send the command
3027 ;;;;;;;;;;;;;;;;;;;;;
3032 ;;;;;;;;;;;;;;;;;;;;;
3033 ;; Show the output
3034 ;;;;;;;;;;;;;;;;;;;;;
3040 output-buffer))))))
3042 ;;;###autoload
3044 "Send COMMAND to current process.
3045 Return a list of expressions in the output which match REGEXP.
3046 REGEXP-GROUP is the regular expression group in REGEXP to use."
3049 command regexp regexp-group))
3051 ;;;###autoload
3053 "Send COMMAND to PROCESS.
3054 Return a list of expressions in the output which match REGEXP.
3055 REGEXP-GROUP is the regular expression group in REGEXP to use."
3057 results)
3062 output-buffer process nil t)
3063 ;; Wait for the process to complete
3067 ;; Collect the output
3070 ;; Skip past the command, if it was echoed
3078 results)))
3079 results)))
3084 "^Empty input ring$"
3085 "^No history$"
3088 \f
3089 ;; Converting process modes to use comint mode
3090 ;; ===========================================================================
3091 ;; The code in the Emacs 19 distribution has all been modified to use comint
3092 ;; where needed. However, there are `third-party' packages out there that
3093 ;; still use the old shell mode. Here's a guide to conversion.
3094 ;;
3095 ;; Renaming variables
3096 ;; Most of the work is renaming variables and functions. These are the common
3097 ;; ones:
3098 ;; Local variables:
3099 ;; last-input-start comint-last-input-start
3100 ;; last-input-end comint-last-input-end
3101 ;; shell-prompt-pattern comint-prompt-regexp
3102 ;; shell-set-directory-error-hook <no equivalent>
3103 ;; Miscellaneous:
3104 ;; shell-set-directory <unnecessary>
3105 ;; shell-mode-map comint-mode-map
3106 ;; Commands:
3107 ;; shell-send-input comint-send-input
3108 ;; shell-send-eof comint-delchar-or-maybe-eof
3109 ;; kill-shell-input comint-kill-input
3110 ;; interrupt-shell-subjob comint-interrupt-subjob
3111 ;; stop-shell-subjob comint-stop-subjob
3112 ;; quit-shell-subjob comint-quit-subjob
3113 ;; kill-shell-subjob comint-kill-subjob
3114 ;; kill-output-from-shell comint-delete-output
3115 ;; show-output-from-shell comint-show-output
3116 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3117 ;;
3118 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3119 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3120 ;; Comint mode does not provide functionality equivalent to
3121 ;; shell-set-directory-error-hook; it is gone.
3122 ;;
3123 ;; comint-last-input-start is provided for modes which want to munge
3124 ;; the buffer after input is sent, perhaps because the inferior
3125 ;; insists on echoing the input. The LAST-INPUT-START variable in
3126 ;; the old shell package was used to implement a history mechanism,
3127 ;; but you should think twice before using comint-last-input-start
3128 ;; for this; the input history ring often does the job better.
3129 ;;
3130 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3131 ;; *not* create the comint-mode local variables in your foo-mode function.
3132 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3133 ;; necessary comint-specific local variables. Then create the
3134 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3135 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3136 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3137 ;; get-old-input) that need to be different from the defaults. Call
3138 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3139 ;; comint-mode will take care of it. The following example, from shell.el,
3140 ;; is typical:
3141 ;;
3142 ;; (defvar shell-mode-map '())
3143 ;; (cond ((not shell-mode-map)
3144 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3145 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3146 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3147 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3148 ;; (define-key shell-mode-map "\M-?"
3149 ;; 'comint-dynamic-list-filename-completions)))
3150 ;;
3151 ;; (defun shell-mode ()
3152 ;; (interactive)
3153 ;; (comint-mode)
3154 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3155 ;; (setq major-mode 'shell-mode)
3156 ;; (setq mode-name "Shell")
3157 ;; (use-local-map shell-mode-map)
3158 ;; (make-local-variable 'shell-directory-stack)
3159 ;; (setq shell-directory-stack nil)
3160 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3161 ;; (run-hooks 'shell-mode-hook))
3162 ;;
3163 ;;
3164 ;; Completion for comint-mode users
3165 ;;
3166 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3167 ;; hook to add completion functions to. Functions on this list should return
3168 ;; non-nil if completion occurs (i.e., further completion should not occur).
3169 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3170 ;; completion job.
3171 \f
3174 ;; comint.el ends here