| blob | 126f05b1a795a0d3c667b2adb0a3250daa309364 |
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, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; 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 ;;
144 ;; Comint mode non-buffer local variables:
145 ;; comint-completion-addsuffix boolean/cons For file name
146 ;; comint-completion-autolist boolean completion behavior
147 ;; comint-completion-recexact boolean ...
150 "General command interpreter in a window stuff."
154 "Completion facilities in comint"
158 "Source finding facilities in comint"
163 "Regexp to recognise prompts in the inferior process.
166 This variable is only used if the variable
167 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
169 Good choices:
180 "List of characters to recognise as separate arguments in input.
181 Strings comprising a character in this list will separate the arguments
182 surrounding them, and also be regarded as arguments in their own right (unlike
183 whitespace). See `comint-arguments'.
184 Defaults to the empty list.
191 "*If non-nil, expand input command history references on completion.
192 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
194 If the value is `input', then the expansion is seen on input.
195 If the value is `history', then the expansion is only when inserting
196 into the buffer's input ring. See also `comint-magic-space' and
197 `comint-dynamic-complete'.
199 This variable is buffer-local."
207 "Face to use to highlight user input."
213 "Face to use to highlight prompts."
217 "*If non-nil, don't add input matching the last on the input ring.
218 This mirrors the optional behavior of bash.
220 This variable is buffer-local."
225 "*If non-nil, name of the file to read/write input history.
226 See also `comint-read-input-ring' and `comint-write-input-ring'.
228 This variable is buffer-local, and is a good thing to set in mode hooks."
230 file)
234 "*Controls whether input to interpreter causes window to scroll.
235 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
236 If `this', scroll only the selected window.
238 The default is nil.
240 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
248 "*Controls whether interpreter output 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.
251 If `others', scroll only those that are not the selected window.
253 The default is nil.
255 See variable `comint-scroll-show-maximum-output' and function
256 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
265 "*Controls how interpreter output causes window to scroll.
266 If non-nil, then show the maximum output when the window is scrolled.
268 See variable `comint-scroll-to-bottom-on-output' and function
269 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
274 "*The maximum size in lines for comint buffers.
275 Comint buffers are truncated from the top to be no greater than this number, if
276 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
290 "*If non-nil, assume that the subprocess echoes any input.
291 If so, delete one copy of the input so that only one copy eventually
292 appears in the buffer.
294 This variable is buffer-local."
298 ;; AIX puts the name of the person being su'd to in front of the prompt.
299 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
300 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
301 ;; ssh-add prints a prompt like `Enter passphrase: '.
302 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
309 "*Regexp matching prompts for passwords in the inferior process.
310 This is used by `comint-watch-for-password-prompt'."
314 ;; Here are the per-interpreter hooks.
316 "Function that returns old text in comint mode.
317 This function is called when return is typed while the point is in old
318 text. It returns the text to be submitted as process input. The
319 default is `comint-get-old-input-default', which either grabs the
320 current input field or grabs the current line and strips off leading
321 text matching `comint-prompt-regexp', depending on the value of
326 "List of functions called to perform completion.
327 Functions should return non-nil if completion was performed.
328 See also `comint-dynamic-complete'.
334 "Predicate for filtering additions to input history.
335 Takes one argument, the input. If non-nil, the input may be saved on the input
339 "Functions to call before input is sent to the process.
340 These functions get one argument, a string containing the text to send.
342 You can use `add-hook' to add functions to this list
346 "Functions to call after output is inserted into the buffer.
347 One possible function is `comint-postoutput-scroll-to-bottom'.
348 These functions get one argument, a string containing the text as originally
349 inserted. Note that this might not be the same as the buffer contents between
350 `comint-last-output-start' and the buffer's `process-mark', if other filter
351 functions have already modified the buffer.
353 See also `comint-preoutput-filter-functions'.
355 You can use `add-hook' to add functions to this list
362 "Function to actually send to PROCESS the STRING submitted by user.
363 Usually this is just `comint-simple-send', but if your mode needs to
364 massage the input string, put a different function here.
365 `comint-simple-send' just sends the string plus a newline.
366 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
370 "*Non-nil means go to the end of the line before sending input.
371 See `comint-send-input'."
375 ;; Note: If it is decided to purge comint-prompt-regexp from the source
376 ;; entirely, searching for uses of this variable will help to identify
377 ;; places that need attention.
379 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
380 If nil, then program output and user-input are given different `field'
381 properties, which emacs commands can use to distinguish them (in
382 particular, common movement commands such as begining-of-line respect
383 field boundaries in a natural way)."
388 "Called upon entry into `comint-mode'
389 This is run before the process is cranked up."
394 "Called each time a process is exec'd by `comint-exec'.
395 This is called after the process is cranked up. It is useful for things that
396 must be done each time a process is executed in a comint mode buffer (e.g.,
397 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
398 executed once when the buffer is created."
405 "Non-nil if communications via pty; false if by pipe. Buffer local.
417 "Last input ring index which you copied.
421 "Non-nil if you are accumulating input lines to send as input together.
440 "Major mode for interacting with an inferior interpreter.
441 Interpreter name is same as buffer name, sans the asterisks.
442 Return at end of buffer sends line as input.
443 Return not at end copies rest of line to end and sends it.
444 Setting variable `comint-eol-on-send' means jump to the end of the line
445 before submitting new input.
447 This mode is customised to create major modes such as Inferior Lisp
448 mode, Shell mode, etc. This can be done by setting the hooks
449 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
450 and `comint-get-old-input' to appropriate functions, and the variable
451 `comint-prompt-regexp' to the appropriate regular expression.
453 An input history is maintained of size `comint-input-ring-size', and
454 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
455 Input ring history expansion can be achieved with the commands
457 Input ring expansion is controlled by the variable `comint-input-autoexpand',
458 and addition is controlled by the variable `comint-input-ignoredups'.
460 Commands with no default key bindings include `send-invisible',
461 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
462 `comint-magic-space'.
464 Input to, and output from, the subprocess can cause the window to scroll to
465 the end of the buffer. See variables `comint-output-filter-functions',
466 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
467 and `comint-scroll-to-bottom-on-output'.
470 to continue it.
474 Entry to this mode runs the hooks on `comint-mode-hook'."
504 ;; This makes it really work to keep point at the bottom.
514 ;; This behavior is not useful in comint buffers, and is annoying
518 nil
519 ;; Keys:
550 ;; Mouse Buttons:
552 ;; Menu bars:
553 ;; completion:
564 ;; Input history:
605 ;; Signals
620 ;; Put them in the menu bar:
622 menu-bar-final-items))
623 )
626 "Return t if there is a living process associated w/buffer BUFFER.
627 Living means the status is `open', `run', or `stop'.
628 BUFFER can be either a buffer or the name of one."
632 ;;;###autoload
634 "Make a comint process NAME in BUFFER, running PROGRAM.
635 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
636 PROGRAM should be either a string denoting an executable program to create
637 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
638 connection to be opened via `open-network-stream'. If there is already a
639 running process in that buffer, it is not restarted. Optional third arg
640 STARTFILE is the name of a file to send the contents of to the process.
642 If PROGRAM is a string, any more args are arguments to PROGRAM."
646 ;; If no process, or nuked process, crank up a new one and put buffer in
647 ;; comint mode. Otherwise, leave buffer and existing process alone.
653 buffer)
655 ;;;###autoload
657 "Make a comint process NAME in a buffer, running PROGRAM.
658 The name of the buffer is made by surrounding NAME with `*'s.
659 PROGRAM should be either a string denoting an executable program to create
660 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
661 connection to be opened via `open-network-stream'. If there is already a
662 running process in that buffer, it is not restarted. Optional third arg
663 STARTFILE is the name of a file to send the contents of to the process.
665 If PROGRAM is a string, any more args are arguments to PROGRAM."
668 ;;;###autoload
670 "Run PROGRAM in a comint buffer and switch to it.
671 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
672 The file name is used to make a symbol name, such as `comint-sh-hook', and any
673 hooks on this symbol are run in the buffer.
674 See `make-comint' and `comint-exec'."
681 "Start up a process in buffer BUFFER for comint modes.
682 Blasts any old process running in the buffer. Doesn't set the buffer mode.
683 You can use this to cheaply run a series of processes in the same comint
684 buffer. The hook `comint-exec-hook' is run after each exec."
689 ;; Crank up a new process
697 ;; Jump to the end, and set the process mark.
700 ;; Feed it the startfile.
702 ;;This is guaranteed to wait long enough
703 ;;but has bad results if the comint does not prompt at all
704 ;; (while (= size (buffer-size))
705 ;; (sleep-for 1))
706 ;;I hope 1 second is enough!
714 buffer)))
716 ;; This auxiliary function cranks up the process for comint-exec in
717 ;; the appropriate environment.
722 ;; If using termcap, we specify `emacs' as the terminal type
723 ;; because that lets us specify a width.
724 ;; If using terminfo, we specify `dumb' because that is
725 ;; a defined terminal type. `emacs' is not a defined terminal type
726 ;; and there is no way for us to define it here.
727 ;; Some programs that use terminfo get very confused
728 ;; if TERM is not a valid terminal type.
729 ;; ;; There is similar code in compile.el.
736 process-environment))
739 default-directory
741 proc decoding encoding changed)
743 ;; If the command has slashes, make sure we
744 ;; first look relative to the current directory.
750 ;; If start-process decided to use some coding system for decoding
751 ;; data sent from the process and the coding system doesn't
752 ;; specify EOL conversion, we had better convert CRLF to LF.
755 changed t))
756 ;; Even if start-process left the coding system for encoding data
757 ;; sent from the process undecided, we had better use the same one
758 ;; as what we use for decoding. But, we should suppress EOL
759 ;; conversion.
762 changed t))
765 proc))
769 "In a comint buffer, set the current input to the clicked-on previous input."
773 ;; No input at POS, fall back to the global definition.
778 ;; There's previous input at POS, insert it at the end of the buffer.
780 ;; First delete any old unsent input at the end
785 ;; Insert the clicked-upon input
791 \f
792 ;; Input history processing in a buffer
793 ;; ===========================================================================
794 ;; Useful input history functions, courtesy of the Ergo group.
796 ;; Eleven commands:
797 ;; comint-dynamic-list-input-ring List history in help buffer.
798 ;; comint-previous-input Previous input...
799 ;; comint-previous-matching-input ...matching a string.
800 ;; comint-previous-matching-input-from-input ... matching the current input.
801 ;; comint-next-input Next input...
802 ;; comint-next-matching-input ...matching a string.
803 ;; comint-next-matching-input-from-input ... matching the current input.
804 ;; comint-backward-matching-input Backwards input...
805 ;; comint-forward-matching-input ...matching a string.
806 ;; comint-replace-by-expanded-history Expand history at point;
807 ;; replace with expanded history.
808 ;; comint-magic-space Expand history and insert space.
809 ;;
810 ;; Three functions:
811 ;; comint-read-input-ring Read into comint-input-ring...
812 ;; comint-write-input-ring Write to comint-input-ring-file-name.
813 ;; comint-replace-by-expanded-history-before-point Workhorse function.
816 "Sets the buffer's `comint-input-ring' from a history file.
817 The name of the file is given by the variable `comint-input-ring-file-name'.
818 The history ring is of size `comint-input-ring-size', regardless of file size.
819 If `comint-input-ring-file-name' is nil this function does nothing.
821 If the optional argument SILENT is non-nil, we say nothing about a
822 failure to read the history file.
824 This function is useful for major mode commands and mode hooks.
826 The commands stored in the history file are separated by the
827 `comint-input-ring-separator', and entries that match
828 `comint-input-history-ignore' are ignored. The most recent command
829 comes last.
831 See also `comint-input-ignoredups' and `comint-write-input-ring'."
834 nil)
838 comint-input-ring-file-name)))
851 ;; Save restriction in case file is already visited...
852 ;; Watch for those date stamps in history files!
872 comint-input-ring-index nil)))))
875 "Writes the buffer's `comint-input-ring' to a history file.
876 The name of the file is given by the variable `comint-input-ring-file-name'.
877 The original contents of the file are lost if `comint-input-ring' is not empty.
878 If `comint-input-ring-file-name' is nil this function does nothing.
880 Useful within process sentinels.
882 See also `comint-read-input-ring'."
886 nil)
894 ;; Write it all out into a buffer first. Much faster, but messier,
895 ;; than writing it one line at a time.
909 "Choose the input history entry that point is in or next to."
926 "List in help buffer the buffer's input history."
935 ;; We have to build up a list ourselves from the ring vector.
939 ;; Change "completion" to "history reference"
940 ;; to make the display accurate.
961 ;; Return list of regexp and prefix arg using PROMPT.
969 regexp)
973 ;; First make sure there is a ring and that we are after the process mark
980 ;; arg of zero resets search from beginning, and uses arg of 1
984 arg)))
987 ;; Index to start a directional search, starting at comint-input-ring-index
989 ;; If a search is running, offset by 1 in direction of arg
992 ;; For a new search, start from beginning or end, as appropriate
998 "Return the string ARG places along the input ring.
999 Moves relative to `comint-input-ring-index'."
1003 arg)))
1006 "Cycle backwards through input history."
1011 "Cycle forwards through input history."
1016 "Return the string matching REGEXP ARG places along the input ring.
1017 Moves relative to `comint-input-ring-index'."
1022 "Return the index matching REGEXP ARG places along the input ring.
1023 Moves relative to START, or `comint-input-ring-index'."
1032 ;; Do the whole search as many times as the argument says.
1034 ;; Step once.
1037 ;; If we haven't reached a match, step some more.
1041 ;; If we have gone all the way around in this search.
1044 ;; Now that we know which ring element to use, if we found it, return that.
1046 n)))
1049 "Search backwards through input history for match for REGEXP.
1050 \(Previous history elements are earlier commands.)
1051 With prefix argument N, search for Nth previous match.
1052 If N is negative, find the next or Nth next match."
1056 ;; Has a match been found?
1062 ;; Can't use kill-region as it sets this-command
1069 "Search forwards through input history for match for REGEXP.
1070 \(Later history elements are more recent commands.)
1071 With prefix argument N, search for Nth following match.
1072 If N is negative, find the previous or Nth previous match."
1077 "Search backwards through input history for match for current input.
1078 \(Previous history elements are earlier commands.)
1079 With prefix argument N, search for Nth previous match.
1080 If N is negative, search forwards for the -Nth following match."
1083 comint-next-matching-input-from-input)))
1084 ;; Starting a new search
1090 comint-input-ring-index nil))
1093 arg))
1096 "Search forwards through input history for match for current input.
1097 \(Following history elements are more recent commands.)
1098 With prefix argument N, search for Nth following match.
1099 If N is negative, search backwards for the -Nth previous match."
1105 "Expand input command history references before point.
1106 Expansion is dependent on the value of `comint-input-autoexpand'.
1108 This function depends on the buffer's idea of the input history, which may not
1109 match the command interpreter's idea, assuming it has one.
1111 Assumes history syntax is like typical Un*x shells'. However, since emacs
1112 cannot know the interpreter's idea of input line numbers, assuming it has one,
1113 it cannot expand absolute input line number references.
1115 If the optional argument SILENT is non-nil, never complain
1116 even if history reference seems erroneous.
1118 If the optional argument START is non-nil, that specifies the
1119 start of the text to scan for history references, rather
1120 than the logical beginning of line.
1122 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1124 Returns t if successful."
1128 ;; Use comint-prompt-regexp
1132 ;; Use input fields. User input that hasn't been entered
1133 ;; yet, at the end of the buffer, has a nil `field' property.
1136 ;; Looks like there might be history references in the command.
1143 "Expand directory stack reference before point.
1144 See `comint-replace-by-expanded-history'. Returns t if successful.
1146 If the optional argument START is non-nil, that specifies the
1147 start of the text to scan for history references, rather
1148 than the logical beginning of line."
1156 ;; This seems a bit complex. We look for references such as !!, !-num,
1157 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1158 ;; If that wasn't enough, the plings can be suffixed with argument
1159 ;; range specifiers.
1160 ;; Argument ranges are complex too, so we hive off the input line,
1161 ;; referenced with plings, with the range string to `comint-args'.
1165 ;; The history is quoted, or we're in quotes.
1168 ;; We cannot know the interpreter's idea of input line numbers.
1172 ;; Just a number of args from `number' lines backward.
1181 t t)
1187 ;; Just a number of args from the previous input line.
1191 t t)
1195 ;; Most recent input starting with or containing (possibly
1196 ;; protected) string, maybe just a number of args. Phew.
1214 t t)
1217 ;; Quick substitution on the previous input line.
1234 "Expand input history references before point and insert ARG spaces.
1235 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1239 \f
1241 "Return t if the number of quotes between BEG and END is odd.
1242 Quotes are single and double."
1248 "Return number of matches for REGEXP from BEG to END."
1255 count))
1258 ;; From STRING, return the args depending on the range specified in the text
1259 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1260 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1276 ;; Return a list of arguments from ARG. Break it up at the
1277 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1292 comint-delimiter-argument-list)))
1295 args)))
1298 "Return from STRING the NTH to MTH arguments.
1299 NTH and/or MTH can be nil, which means the last argument.
1300 Returned arguments are separated by single spaces.
1301 We assume whitespace separates arguments, except within quotes
1302 and except for a space or tab that immediately follows a backslash.
1303 Also, a run of one or more of a single character
1304 in `comint-delimiter-argument-list' is a separate argument.
1305 Argument 0 is the command name."
1306 ;; The first line handles ordinary characters and backslash-sequences
1307 ;; (except with w32 msdos-like shells, where backslashes are valid).
1308 ;; The second matches "-quoted strings.
1309 ;; The third matches '-quoted strings.
1310 ;; The fourth matches `-quoted strings.
1311 ;; This seems to fit the syntax of BASH 2.0.
1322 beg str value quotes)
1323 ;; Build a list of all the args until we have as many as we want.
1327 ;; It's contiguous, part of the same arg.
1330 ;; It's a new separate arg.
1332 ;; Put the previous arg, if there was one, onto ARGS.
1349 \f
1350 ;;
1351 ;; Input processing stuff
1352 ;;
1354 "Add CMD to the input history.
1355 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1361 cmd))))
1365 "Send input to process.
1366 After the process output mark, sends all text from the process mark to
1367 point as input to the process. Before the process output mark, calls
1368 value of variable `comint-get-old-input' to retrieve old input, copies
1369 it to the process mark, and sends it. A terminal newline is also
1370 inserted into the buffer and sent to the process.
1372 Any history reference may be expanded depending on the value of the variable
1373 `comint-input-autoexpand'. The list of function names contained in the value
1374 of `comint-input-filter-functions' is called on the input before sending it.
1375 The input is entered into the input history ring, if the value of variable
1376 `comint-input-filter' returns non-nil when called on the input.
1378 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1379 end of line before sending the input.
1381 After the input has been sent, if `comint-process-echoes' is non-nil,
1382 then comint-send-input waits to see if the process outputs a string
1383 matching the input, and if so, deletes that part of the output.
1385 The values of `comint-get-old-input', `comint-input-filter-functions', and
1386 `comint-input-filter' are chosen according to the command interpreter running
1387 in the buffer. E.g.,
1389 If the interpreter is the csh,
1390 comint-get-old-input is the default:
1391 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1392 either return the current input field, if point is on an input
1393 field, or the current line, if point is on an output field.
1394 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1395 return the current line with any initial string matching the
1396 regexp `comint-prompt-regexp' removed.
1399 comint-input-filter is the default: returns t if the input isn't all white
1400 space.
1402 If the comint is Lucid Common Lisp,
1403 comint-get-old-input snarfs the sexp ending at point.
1404 comint-input-filter-functions does nothing.
1405 comint-input-filter returns nil if the input matches input-filter-regexp,
1406 which matches (1) all whitespace (2) :a, :c, etc.
1408 Similarly for Soar, Scheme, etc."
1410 ;; Note that the input string does not include its terminal newline.
1420 copy)))
1422 ;; Just whatever's already there
1423 intxt
1424 ;; Expand and leave it visible in buffer
1428 input
1429 ;; This is messy 'cos ultimately the original
1430 ;; functions used do insertion, rather than return
1431 ;; strings. We have to expand, then insert back.
1437 copy))))
1451 ;; Set text-properties for the input field
1453 beg end
1455 font-lock-face comint-highlight-input
1456 mouse-face highlight
1459 ;; Give old user input a field property of `input', to
1460 ;; distinguish it from both process output and unsent
1461 ;; input. The terminating newline is put into a special
1462 ;; `boundary' field to make cursor movement between input
1463 ;; and output fields smoother.
1466 ;; Cover the terminating newline
1469 field boundary
1470 inhibit-line-move-field-capture t))))
1476 ;; Update the markers before we send the input
1477 ;; in case we get output amidst sending the input.
1481 ;; clear the "accumulation" marker
1486 ;; Optionally delete echoed input (after checking it).
1489 comint-last-input-start)))
1490 ;; Wait for all input to be echoed:
1496 nil comint-last-input-start
1498 ;; Above difference is equivalent to
1499 ;; (+ comint-last-input-start
1500 ;; (- (point-max) comint-last-input-end))
1507 nil comint-last-input-start comint-last-input-end
1508 nil comint-last-input-end
1513 ;; This used to call comint-output-filter-functions,
1514 ;; but that scrolled the buffer in undesirable ways.
1518 "List of functions to call before inserting Comint output into the buffer.
1519 Each function gets one argument, a string containing the text received
1520 from the subprocess. It should return the string to insert, perhaps
1521 the same string that was received, or perhaps a modified or transformed
1522 string.
1524 The functions on the list are called sequentially, and each one is
1525 given the string returned by the previous one. The string returned by
1526 the last function is the text that is actually inserted in the
1527 redirection buffer.
1529 You can use `add-hook' to add functions to this list
1533 "If nil, comint will interpret `carriage control' characters in output.
1536 ;; When non-nil, this is an overlay over the last recognized prompt in
1537 ;; the buffer; it is used when highlighting the prompt.
1540 ;; `snapshot' any current comint-last-prompt-overlay, freezing its
1541 ;; attributes in place, even when more input comes a long and moves the
1542 ;; prompt overlay.
1551 "Interpret carriage control characters in the region from START to END.
1552 Translate carriage return/linefeed sequences to linefeeds.
1553 Make single carriage returns delete to the beginning of the line.
1554 Make backspaces delete the previous character."
1556 ;; First do a quick check to see if there are any applicable
1557 ;; characters, so we can avoid calling save-match-data and
1558 ;; save-restriction if not.
1566 ;; CR LF -> LF
1567 ;; Note that this won't work properly when the CR and LF
1568 ;; are in different output chunks, but this is probably an
1569 ;; exceedingly rare case (because they are generally
1570 ;; written as a unit), and to delay interpretation of a
1571 ;; trailing CR in a chunk would result in odd interactive
1572 ;; behavior (and this case is probably far more common).
1575 ;; bare CR -> delete preceding line
1579 ;; BS -> delete preceding character
1584 ;; The purpose of using this filter for comint processes
1585 ;; is to keep comint-last-input-end from moving forward
1586 ;; when output is inserted.
1589 ;; First check for killed buffer or no input.
1592 ;; Run preoutput filters
1603 ;; Insert STRING
1605 ;; Avoid the overhead of save-excursion, since we just
1606 ;; fiddle with the point
1609 ;; The point should float after any insertion we do
1612 ;; We temporarly remove any buffer narrowing, in case the
1613 ;; process mark is outside of the restriction
1620 ;; insert-before-markers is a bad thing. XXX
1621 ;;
1622 ;; It is used here to force window-point markers (used to
1623 ;; store the value of point in non-selected windows) to
1624 ;; advance, but it also screws up any other markers that we
1625 ;; don't _want_ to advance, such as the start-marker of some
1626 ;; of the overlays we create.
1627 ;;
1628 ;; We work around the problem with the overlays by
1629 ;; explicitly adjusting them after we do the insertion, but
1630 ;; in the future this problem should be solved correctly, by
1631 ;; using `insert', and making the insertion-type of
1632 ;; window-point markers settable (via a buffer-local
1633 ;; variable). In comint buffers, this variable would be set
1634 ;; to `t', to cause point in non-select windows to advance.
1636 ;; Fixup markers and overlays that got screwed up because we
1637 ;; used `insert-before-markers'.
1639 ;; comint-last-output-start
1641 ;; comint-last-input-end
1646 ;; No overlays we create are set to advance upon insertion
1647 ;; (at the start/end), so we assume that any overlay which
1648 ;; is at the current point was incorrectly advanced by
1649 ;; insert-before-markers. First fixup overlays that might
1650 ;; start at point:
1655 old-point
1657 ;; Then do overlays that might end at point:
1662 old-point))))
1664 ;; Advance process-mark
1668 ;; Interpret any carriage motion characters (newline, backspace)
1679 field output
1680 inhibit-line-move-field-capture t))))
1682 ;; Highlight the prompt, where we define `prompt' to mean
1683 ;; the most recent output that doesn't end with a newline.
1685 ;; Need to create or move the prompt overlay (in the case
1686 ;; where there is no prompt ((bolp) == t), we still do
1687 ;; this if there's already an existing overlay).
1690 ;; Just move an existing overlay
1693 ;; Need to create the overlay
1702 "Go to the end of buffer in all windows showing it.
1703 Movement occurs if point in the selected window is not after the process mark,
1704 and `this-command' is an insertion command. Insertion commands recognised
1705 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1706 Depends on the value of `comint-scroll-to-bottom-on-input'.
1708 This function should be a pre-command hook."
1711 hilit-yank)))
1727 nil t))))))
1730 "Go to the end of buffer in all windows showing it.
1731 Does not scroll if the current line is the last line in the buffer.
1732 Depends on the value of `comint-scroll-to-bottom-on-output' and
1733 `comint-scroll-show-maximum-output'.
1735 This function should be in the list `comint-output-filter-functions'."
1749 ;; Maybe user wants point to jump to end.
1752 ;; If point was at the end, keep it at end.
1756 ;; Optionally scroll so that the text
1757 ;; ends at the bottom of the window.
1764 nil t))
1768 "Truncate the buffer to `comint-buffer-maximum-size'.
1769 This function could be on `comint-output-filter-functions' or bound to a key."
1778 "Strip trailing `^M' characters from the current output group.
1779 This function could be on `comint-output-filter-functions' or bound to a key."
1792 "Put the end of the buffer at the bottom of the window."
1798 "Default for `comint-get-old-input'.
1799 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1800 return the current input field, if point is on an input field, or the
1801 current line, if point is on an output field.
1802 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1803 the current line with any initial string matching the regexp
1804 `comint-prompt-regexp' removed."
1812 "Insert after prompt old input at point as new input to be edited.
1813 Calls `comint-get-old-input' to get old input."
1823 "Skip past the text matching regexp `comint-prompt-regexp'.
1824 If this takes us past the end of the current line, don't skip at all."
1831 "Return t if point is after the process output marker."
1836 "Default function for sending to PROC input STRING.
1837 This just sends STRING plus a newline. To override this,
1838 set the hook `comint-input-sender'."
1846 "Returns the buffer position of the beginning of the line, after any prompt.
1847 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1848 prompt skip is done by skipping text matching the regular expression
1849 `comint-prompt-regexp', a buffer local variable."
1851 ;; Use comint-prompt-regexp
1856 ;; Use input fields. Note that, unlike the behavior of
1857 ;; `line-beginning-position' inside a field, this function will
1858 ;; return the position of the end of a prompt, even if the point is
1859 ;; already inside the prompt. In order to do this, it assumes that
1860 ;; if there are two fields on a line, then the first one is the
1861 ;; prompt, and the second one is an input field, and is front-sticky
1862 ;; (as input fields should be).
1866 "Goes to the beginning of line, then skips past the prompt, if any.
1868 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1869 prompt skip is done by skipping text matching the regular expression
1870 `comint-prompt-regexp', a buffer local variable."
1873 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1877 ;; These three functions are for entering text you don't want echoed or
1878 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1879 ;; Just enter m-x send-invisible and type in your line, or add
1880 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1883 "Read a single line of text from user without echoing, and return it.
1884 Prompt with argument PROMPT, a string. Optional argument STARS causes
1885 input to be echoed with '*' characters on the prompt line. Input ends with
1886 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1887 `inhibit-quit' is set because e.g. this function was called from a process
1888 filter and C-g is pressed, this function returns nil rather than a string).
1890 Note that the keystrokes comprising the text can still be recovered
1892 Once the caller uses the password, it can erase the password
1893 by doing (fillarray STRING 0)."
1905 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1908 ;; This function may get called from a process filter, where
1909 ;; inhibit-quit is set. In later versions of emacs read-char
1910 ;; may clear quit-flag itself and return C-g. That would make
1911 ;; it impossible to quit this loop in a simple way, so
1912 ;; re-enable it here (for backward-compatibility the check for
1913 ;; quit-flag below would still be necessary, so this seems
1914 ;; like the simplest way to do things).
1916 done t))
1930 ;; Emulate a true quit, except that we have to return a value.
1936 ans)))
1939 "Read a string without echoing.
1940 Then send it to the process running in the current buffer.
1941 The string is sent using `comint-input-sender'.
1942 Security bug: your string can still be temporarily recovered with
1958 "Prompt in the minibuffer for password and send without echoing.
1959 This function uses `send-invisible' to read and send a password to the buffer's
1960 process if STRING contains a password prompt defined by
1961 `comint-password-prompt-regexp'.
1963 This function could be in the list `comint-output-filter-functions'."
1969 \f
1970 ;; Low-level process communication
1973 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1983 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1992 \f
1993 ;; Random input hackage
1996 "Delete all output from interpreter since last input.
1997 Does not delete the prompt."
2010 ;; Output message and put back prompt
2016 "Write output from interpreter since last input to FILENAME.
2017 Any prompt at the end of the output is not written.
2019 If the optional argument APPEND (the prefix argument when interactive)
2020 is non-nil, the output is appended to the file instead.
2022 If the optional argument MUSTBENEW is non-nil, check for an existing
2023 file with the same name. If MUSTBENEW is `excl', that means to get an
2024 error if the file already exists; never overwrite. If MUSTBENEW is
2025 neither nil nor `excl', that means ask for confirmation before
2026 overwriting, but do go ahead and overwrite the file if the user
2027 confirms. When interactive, MUSTBENEW is nil when appending, and t
2028 otherwise."
2032 "Append output to file: "
2034 current-prefix-arg
2040 append nil nil mustbenew)))
2042 ;; This function exists for the benefit of the menu; from the keyboard,
2043 ;; users can just use `comint-write-output' with a prefix arg.
2045 "Append output from interpreter since last input to FILENAME.
2046 Any prompt at the end of the output is not written."
2051 "Display start of this batch of interpreter output at top of window.
2052 Sets mark to the value of point when this command is run."
2067 "Interrupt the current subjob.
2068 This command also kills the pending input
2069 between the process-mark and point."
2075 "Send kill signal to the current subjob.
2076 This command also kills the pending input
2077 between the process-mark and point."
2083 "Send quit signal to the current subjob.
2084 This command also kills the pending input
2085 between the process-mark and point."
2091 "Stop the current subjob.
2092 This command also kills the pending input
2093 between the process-mark and point.
2095 WARNING: if there is no current subjob, you can end up suspending
2096 the top-level process running in the buffer. If you accidentally do
2098 is not a problem with most shells, since they ignore this signal.)"
2104 "Send CONT signal to process buffer's process group.
2105 Useful if you accidentally suspend the top-level process."
2110 "Skip all pending input, from last stuff output by interpreter to point.
2111 This means mark it as if it had been sent as input, without sending it."
2123 "Kill all text from last stuff output by interpreter to point."
2130 "Delete ARG characters forward or send an EOF to subprocess.
2131 Sends an EOF only if point is at the end of the buffer and there is no input."
2139 "Send an EOF to the current buffer's process."
2146 "Search backward through buffer for input fields that match REGEXP.
2147 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2148 fields are identified by lines that match `comint-prompt-regexp'.
2150 With prefix argument N, search for Nth previous match.
2151 If N is negative, find the next or Nth next match."
2154 ;; Use comint-prompt-regexp
2164 ;; Use input fields
2178 "Search forward through buffer for input fields that match REGEXP.
2179 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2180 fields are identified by lines that match `comint-prompt-regexp'.
2182 With prefix argument N, search for Nth following match.
2183 If N is negative, find the previous or Nth previous match."
2189 "Move to end of Nth next prompt in the buffer.
2190 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2191 the beginning of the Nth next `input' field, otherwise, it means the Nth
2192 occurrence of text matching `comint-prompt-regexp'."
2195 ;; Use comint-prompt-regexp
2200 ;; Use input fields
2203 prev-pos)
2211 ;; Ran off the end of the buffer.
2213 ;; There's always an input field at the end of the
2214 ;; buffer, but it has a `field' property of nil.
2216 ;; stop iterating
2226 "Move to end of Nth previous prompt in the buffer.
2227 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2228 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2229 occurrence of text matching `comint-prompt-regexp'."
2233 ;; State used by `comint-insert-previous-argument' when cycling.
2239 ;; Needs fixing:
2240 ;; make comint-arguments understand negative indices as bash does
2242 "Insert the INDEXth argument from the previous comint command-line at point.
2243 Spaces are added at beginning and/or end of the inserted string if
2244 necessary to ensure that it's separated from adjacent arguments.
2245 Interactively, if no prefix argument is given, the last argument is inserted.
2246 Repeated interactive invocations will cycle through the same argument
2247 from progressively earlier commands (using the value of INDEX specified
2248 with the first command).
2249 This command is like `M-.' in bash."
2254 ;; Delete last input inserted by this command.
2258 ;; This is a non-repeat invocation, so initialize state.
2262 ;; First usage; initialize to a marker
2265 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2269 ;; Remember the beginning of what we insert, so we can delete it if
2270 ;; the command is repeated.
2272 ;; Insert the argument.
2275 ;; strip terminating '&'
2278 ;; Make next invocation return arg from previous input
2280 ;; Add a terminating space if necessary.
2284 \f
2285 ;; Support for source-file processing commands.
2286 ;;============================================================================
2287 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2288 ;; commands that process files of source text (e.g. loading or compiling
2289 ;; files). So the corresponding process-in-a-buffer modes have commands
2290 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2291 ;; for defining these commands.
2292 ;;
2293 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2294 ;; and Soar, in that they don't know anything about file extensions.
2295 ;; So the compile/load interface gets the wrong default occasionally.
2296 ;; The load-file/compile-file default mechanism could be smarter -- it
2297 ;; doesn't know about the relationship between filename extensions and
2298 ;; whether the file is source or executable. If you compile foo.lisp
2299 ;; with compile-file, then the next load-file should use foo.bin for
2300 ;; the default, not foo.lisp. This is tricky to do right, particularly
2301 ;; because the extension for executable files varies so much (.o, .bin,
2302 ;; .lbin, .mo, .vo, .ao, ...).
2305 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2306 ;; commands.
2307 ;;
2308 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2309 ;; want to save the buffer before issuing any process requests to the command
2310 ;; interpreter.
2311 ;;
2312 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2313 ;; for the file to process.
2315 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2316 ;;============================================================================
2317 ;; This function computes the defaults for the load-file and compile-file
2318 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2319 ;;
2320 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2321 ;; source-file processing command. nil if there hasn't been one yet.
2322 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2323 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2324 ;; Typically, (lisp-mode) or (scheme-mode).
2325 ;;
2326 ;; If the command is given while the cursor is inside a string, *and*
2327 ;; the string is an existing filename, *and* the filename is not a directory,
2328 ;; then the string is taken as default. This allows you to just position
2329 ;; your cursor over a string that's a filename and have it taken as default.
2330 ;;
2331 ;; If the command is given in a file buffer whose major mode is in
2332 ;; SOURCE-MODES, then the filename is the default file, and the
2333 ;; file's directory is the default directory.
2334 ;;
2335 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2336 ;; then the default directory & file are what was used in the last source-file
2337 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2338 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2339 ;; is the cwd, with no default file. (\"no default file\" = nil)
2340 ;;
2341 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2342 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2343 ;; for Soar programs, etc.
2344 ;;
2345 ;; The function returns a pair: (default-directory . default-file).
2356 ;; (COMINT-CHECK-SOURCE fname)
2357 ;;============================================================================
2358 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2359 ;; process-in-a-buffer modes), this function can be called on the filename.
2360 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2361 ;; is queried to see if he wants to save the buffer before proceeding with
2362 ;; the load or compile.
2369 ;; save BUFF.
2376 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2377 ;;============================================================================
2378 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2379 ;; commands that process source files (like loading or compiling a file).
2380 ;; It prompts for the filename, provides a default, if there is one,
2381 ;; and returns the result filename.
2382 ;;
2383 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2384 ;;
2385 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2386 ;; from the last source processing command. SOURCE-MODES is a list of major
2387 ;; modes used to determine what file buffers contain source files. (These
2388 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2389 ;; then the filename reader will only accept a file that exists.
2390 ;;
2391 ;; A typical use:
2392 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2393 ;; '(lisp-mode) t))
2395 ;; This is pretty stupid about strings. It decides we're in a string
2396 ;; if there's a quote on both sides of point on the current line.
2398 "Return string around POINT that starts the current line, or nil."
2425 prompt deffile)
2426 prompt)
2427 defdir
2429 mustmatch-p)))
2432 ;; I am somewhat divided on this string-default feature. It seems
2433 ;; to violate the principle-of-least-astonishment, in that it makes
2434 ;; the default harder to predict, so you actually have to look and see
2435 ;; what the default really is before choosing it. This can trip you up.
2436 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2437 ;; on this.
2438 ;; -Olin
2440 \f
2441 ;; Simple process query facility.
2442 ;; ===========================================================================
2443 ;; This function is for commands that want to send a query to the process
2444 ;; and show the response to the user. For example, a command to get the
2445 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2446 ;; to an inferior Common Lisp process.
2447 ;;
2448 ;; This simple facility just sends strings to the inferior process and pops
2449 ;; up a window for the process buffer so you can see what the process
2450 ;; responds with. We don't do anything fancy like try to intercept what the
2451 ;; process responds with and put it in a pop-up window or on the message
2452 ;; line. We just display the buffer. Low tech. Simple. Works good.
2454 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2455 ;; a window for the inferior process so that its response can be seen.
2465 ;; Try to position the proc window so you can see the answer.
2466 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2467 ;; I don't know why. Wizards invited to improve it.
2476 \f
2477 ;; Filename/command/history completion in a buffer
2478 ;; ===========================================================================
2479 ;; Useful completion functions, courtesy of the Ergo group.
2481 ;; Six commands:
2482 ;; comint-dynamic-complete Complete or expand command, filename,
2483 ;; history at point.
2484 ;; comint-dynamic-complete-filename Complete filename at point.
2485 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2486 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2487 ;; replace with expanded/completed name.
2488 ;; comint-dynamic-simple-complete Complete stub given candidates.
2490 ;; These are not installed in the comint-mode keymap. But they are
2491 ;; available for people who want them. Shell-mode installs them:
2492 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2493 ;; (define-key shell-mode-map "\M-?"
2494 ;; 'comint-dynamic-list-filename-completions)))
2495 ;;
2496 ;; Commands like this are fine things to put in load hooks if you
2497 ;; want them present in specific modes.
2500 "*If non-nil, automatically list possibilities on partial completion.
2501 This mirrors the optional behavior of tcsh."
2506 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2507 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2508 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2509 This mirrors the optional behavior of tcsh."
2518 "*If non-nil, use shortest completion if characters cannot be added.
2519 This mirrors the optional behavior of tcsh.
2521 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2526 "*List of suffixes to be disregarded during file completion.
2527 This mirrors the optional behavior of bash and tcsh.
2529 Note that this applies to `comint-dynamic-complete-filename' only."
2534 "Prefix prepended to absolute file names taken from process input.
2535 This is used by comint's and shell's completion functions, and by shell's
2540 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2542 "String of characters valid in a file name.
2543 Note that all non-ASCII characters are considered valid in a file name
2544 regardless of what this variable says.
2555 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2558 directory)))
2562 "Return the word of WORD-CHARS at point, or nil if non is found.
2563 Word constituents are considered to be those in WORD-CHARS, which is like the
2565 plus all non-ASCII characters."
2569 ;;(memq (char-after (point)) shell-file-name-quote-list)
2573 ;; Don't go forward over a word-char (this can happen if we're at bob).
2576 ;; Set match-data to match the entire string.
2582 "Return FILENAME with environment variables substituted.
2583 Supports additional environment variable syntax of the command
2584 interpreter (e.g., the percent notation of cmd.exe on NT)."
2588 env-var-val)
2597 name))
2600 "Return the filename at point, or nil if non is found.
2601 Environment variables are substituted. See `comint-word'."
2608 "Return FILENAME with magic characters quoted.
2609 Magic characters are those in `comint-file-name-quote-list'."
2611 filename
2618 filename))))
2621 "Return FILENAME with quoted characters unquoted."
2623 filename
2629 filename)))
2633 "Dynamically perform completion at point.
2634 Calls the functions in `comint-dynamic-complete-functions' to perform
2635 completion until a function returns non-nil, at which point completion is
2636 assumed to have occurred."
2642 "Dynamically complete the filename at point.
2643 Completes if after a filename. See `comint-match-partial-filename' and
2644 `comint-dynamic-complete-as-filename'.
2645 This function is similar to `comint-replace-by-expanded-filename', except that
2646 it won't change parts of the filename already entered in the buffer; it just
2647 adds completion characters to the end of the filename. A completions listing
2648 may be shown in a help buffer if completion is ambiguous.
2650 Completion is dependent on the value of `comint-completion-addsuffix',
2651 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2652 completions listing is dependent on the value of `comint-completion-autolist'.
2654 Returns t if successful."
2662 "Dynamically complete at point as a filename.
2663 See `comint-dynamic-complete-filename'. Returns t if successful."
2666 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2667 ;; I think it was originally bound to solve file completion problems,
2668 ;; but subsequent changes may have made this unnecessary. sm.
2669 ;;(file-name-handler-alist nil)
2704 ;; We inserted a unique completion.
2711 ;; It's not unique, but user wants shortest match.
2717 ;; It's not unique, list possible completions.
2722 success))
2726 "Dynamically expand and complete the filename at point.
2727 Replace the filename with an expanded, canonicalised and completed replacement.
2730 removed, and the filename is made absolute instead of relative. For expansion
2731 see `expand-file-name' and `substitute-in-file-name'. For completion see
2732 `comint-dynamic-complete-filename'."
2741 "Dynamically complete STUB from CANDIDATES list.
2742 This function inserts completion characters at point by completing STUB from
2743 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2744 if completion is ambiguous.
2746 Returns nil if no completion was inserted.
2747 Returns `sole' if completed with the only completion match.
2748 Returns `shortest' if completed with the shortest of the completion matches.
2749 Returns `partial' if completed as far as possible with the completion matches.
2750 Returns `listed' if a completion listing was shown.
2752 See also `comint-dynamic-complete-filename'."
2761 nil)
2772 ;; Insert the longest substring.
2777 ;; It's not unique, but user wants shortest match.
2783 ;; It's not unique, list possible completions.
2792 "List in help buffer possible completions of the filename at point."
2795 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2796 ;; I think it was originally bound to solve file completion problems,
2797 ;; but subsequent changes may have made this unnecessary. sm.
2798 ;;(file-name-handler-alist nil)
2810 ;; This is bound locally in a *Completions* buffer to the list of
2811 ;; completions displayed, and is used to detect the case where the same
2812 ;; command is repeatedly used without the set of completions changing.
2816 "List in help buffer sorted COMPLETIONS.
2817 Typing SPC flushes the help buffer."
2823 ;; The above tests are not sufficient to detect the case where we
2824 ;; should scroll, because the top-level interactive command may
2825 ;; not have displayed a completions window the last time it was
2826 ;; invoked, and there may be such a window left over from a
2827 ;; previous completion command with a different set of
2828 ;; completions. To detect that case, we also test that the set
2829 ;; of displayed completions is in fact the same as the previously
2830 ;; displayed set.
2834 ;; If this command was repeated, and
2835 ;; there's a fresh completion window with a live buffer,
2836 ;; and this command is repeated, scroll that window.
2853 completions)
2860 ;; If the user does mouse-choose-completion with the mouse,
2861 ;; execute the command, then delete the completion window.
2869 \f
2871 "After fetching a line from input history, this fetches the following line.
2872 In other words, this recalls the input line after the line you recalled last.
2873 You can use this to repeat a sequence of input lines."
2882 "Accumulate a line to send as input along with more lines.
2883 This inserts a newline so that you can enter more text
2885 to send all the accumulated input, at once.
2886 The entire accumulated text becomes one item in the input history
2887 when you send it."
2896 "Move point to the process mark.
2897 The process mark separates output, and input already sent,
2898 from input that has not yet been sent."
2907 "Move point to beginning of line (after prompt) or to the process mark.
2908 The first time you use this command, it moves to the beginning of the line
2909 \(but after the prompt, if any). If you repeat it again immediately,
2910 it moves point to the process mark.
2912 The process mark separates the process output, along with input already sent,
2913 from input that has not yet been sent. Ordinarily, the process mark
2914 is at the beginning of the current input line; but if you have
2916 the process mark is at the beginning of the accumulated input."
2923 "Set the process mark at point."
2930 \f
2931 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2933 ;; This little add-on for comint is intended to make it easy to get
2934 ;; output from currently active comint buffers into another buffer,
2935 ;; or buffers, and then go back to using the comint shell.
2936 ;;
2937 ;; My particular use is SQL interpreters; I want to be able to execute a
2938 ;; query using the process associated with a comint-buffer, and save that
2939 ;; somewhere else. Because the process might have state (for example, it
2940 ;; could be in an uncommitted transaction), just running starting a new
2941 ;; process and having it execute the query and then finish, would not
2942 ;; work. I'm sure there are other uses as well, although in many cases
2943 ;; starting a new process is the simpler, and thus preferable, approach.
2944 ;;
2945 ;; The basic implementation is as follows: comint-redirect changes the
2946 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2947 ;; its own filter. The filter puts the output into the designated buffer,
2948 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2949 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2950 ;; sees the stop regexp, it restores the old filter functions, and runs
2951 ;; comint-redirect-hook.
2952 ;;
2953 ;; Each comint buffer may only use one redirection at a time, but any number
2954 ;; of different comint buffers may be simultaneously redirected.
2955 ;;
2956 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2957 ;; correct prompt for your interpreter, or that you supply a regexp that says
2958 ;; when the redirection is finished. Otherwise, redirection will continue
2959 ;; indefinitely. The code now does a sanity check to ensure that it can find
2960 ;; a prompt in the comint buffer; however, it is still important to ensure that
2961 ;; this prompt is set correctly.
2962 ;;
2963 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2964 ;; perhaps it should prompt for a terminating string (with an
2965 ;; appropriate magic default by examining what we think is the prompt)?
2966 ;;
2968 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2969 ;; Variables
2970 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2973 "*If non-nil, print messages each time the redirection filter is invoked.
2974 Also print a message when redirection is completed."
2978 ;; Directly analagous to comint-preoutput-filter-functions
2980 "List of functions to call before inserting redirected process output.
2981 Each function gets one argument, a string containing the text received
2982 from the subprocess. It should return the string to insert, perhaps
2983 the same string that was received, or perhaps a modified or transformed
2984 string.
2986 The functions on the list are called sequentially, and each one is given
2987 the string returned by the previous one. The string returned by the
2988 last function is the text that is actually inserted in the redirection buffer.
2990 You can use `add-hook' to add functions to this list
2993 ;; Internal variables
2999 "Regular expression that determines when to stop redirection in Comint.
3000 When the redirection filter function is given output that matches this regexp,
3004 "If non-nil, the text that ends a redirection is included in it.
3005 More precisely, the text that matches `comint-redirect-finished-regexp'
3006 and therefore terminates an output redirection is inserted in the
3019 "If non-nil, check that redirection is likely to complete successfully.
3020 More precisely, before starting a redirection, verify that the
3021 regular expression `comint-redirect-finished-regexp' that controls
3022 when to terminate it actually matches some text already in the process
3023 buffer. The idea is that this regular expression should match a prompt
3024 string, and that there ought to be at least one copy of your prompt string
3028 "The process filter that was in place when redirection is started.
3029 When redirection is completed, the process filter is restored to
3032 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3033 ;; Functions
3034 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3037 comint-buffer
3038 finished-regexp
3040 "Set up for output redirection.
3041 This function sets local variables that are used by `comint-redirect-filter'
3042 to perform redirection.
3044 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3045 in the output matches FINISHED-REGEXP.
3047 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3048 original comint buffer.
3050 This function is called by `comint-redirect-send-command-to-process',
3051 and does not normally need to be invoked by the end user or programmer."
3075 "End a Comint redirection. See `comint-redirect-send-command'."
3077 ;; Restore the process filter
3079 comint-redirect-original-filter-function)
3080 ;; Restore the mode line
3082 ;; Set the completed flag
3085 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3086 ;; that it really occurs.
3090 "Filter function which redirects output from PROCESS to a buffer or buffers.
3091 The variable `comint-redirect-output-buffer' says which buffer(s) to
3092 place output in.
3094 INPUT-STRING is the input from the comint process.
3096 This function runs as a process filter, and does not need to be invoked by the
3097 end user."
3101 ;; If we have to echo output, give it to the original filter function
3103 comint-redirect-original-filter-function
3105 process input-string)))))
3109 "Comint filter function which redirects comint output to a buffer or buffers.
3110 The variable `comint-redirect-output-buffer' says which buffer(s) to
3111 place output in.
3113 INPUT-STRING is the input from the comint process.
3115 This function does not need to be invoked by the end user."
3118 comint-redirect-output-buffer
3122 ;; If there are any filter functions, give them a chance to modify the string
3126 ;; If a local value says "use the default value too",
3127 ;; do that.
3137 ;; Clobber `comint-redirect-finished-regexp'
3143 ;; Send output to all registered buffers
3147 ;; Set this buffer to the output buffer
3149 ;; Go to the end of the buffer
3151 ;; Insert the output
3153 output-buffer-list))
3155 ;; Message
3160 ;; If we see the prompt, tidy up
3161 ;; We'll look for the prompt in the original string, so nobody can
3162 ;; clobber it
3169 ;; Echo input?
3171 filtered-input-string
3174 ;;;###autoload
3176 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3177 With prefix arg, echo output in process buffer.
3179 If NO-DISPLAY is non-nil, do not show the output buffer."
3187 ;;;###autoload
3190 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3191 With prefix arg, echo output in process buffer.
3193 If NO-DISPLAY is non-nil, do not show the output buffer."
3198 process))
3200 ;; Change to the process buffer
3203 ;; Make sure there's a prompt in the current process buffer
3210 ;;;;;;;;;;;;;;;;;;;;;
3211 ;; Set up for redirection
3212 ;;;;;;;;;;;;;;;;;;;;;
3214 ;; Output Buffer
3215 output-buffer
3216 ;; Comint Buffer
3218 ;; Finished Regexp
3219 comint-prompt-regexp
3220 ;; Echo input
3221 echo)
3223 ;;;;;;;;;;;;;;;;;;;;;
3224 ;; Set the filter
3225 ;;;;;;;;;;;;;;;;;;;;;
3226 ;; Save the old filter
3231 ;;;;;;;;;;;;;;;;;;;;;
3232 ;; Send the command
3233 ;;;;;;;;;;;;;;;;;;;;;
3238 ;;;;;;;;;;;;;;;;;;;;;
3239 ;; Show the output
3240 ;;;;;;;;;;;;;;;;;;;;;
3246 output-buffer)))))))
3248 ;;;###autoload
3250 "Send COMMAND to current process.
3251 Return a list of expressions in the output which match REGEXP.
3252 REGEXP-GROUP is the regular expression group in REGEXP to use."
3255 command regexp regexp-group))
3257 ;;;###autoload
3259 "Send COMMAND to PROCESS.
3260 Return a list of expressions in the output which match REGEXP.
3261 REGEXP-GROUP is the regular expression group in REGEXP to use."
3263 results)
3268 output-buffer process nil t)
3269 ;; Wait for the process to complete
3273 ;; Collect the output
3276 ;; Skip past the command, if it was echoed
3284 results)))
3285 results)))
3290 "^Empty input ring$"
3291 "^No history$"
3295 \f
3296 ;; Converting process modes to use comint mode
3297 ;; ===========================================================================
3298 ;; The code in the Emacs 19 distribution has all been modified to use comint
3299 ;; where needed. However, there are `third-party' packages out there that
3300 ;; still use the old shell mode. Here's a guide to conversion.
3301 ;;
3302 ;; Renaming variables
3303 ;; Most of the work is renaming variables and functions. These are the common
3304 ;; ones:
3305 ;; Local variables:
3306 ;; last-input-start comint-last-input-start
3307 ;; last-input-end comint-last-input-end
3308 ;; shell-prompt-pattern comint-prompt-regexp
3309 ;; shell-set-directory-error-hook <no equivalent>
3310 ;; Miscellaneous:
3311 ;; shell-set-directory <unnecessary>
3312 ;; shell-mode-map comint-mode-map
3313 ;; Commands:
3314 ;; shell-send-input comint-send-input
3315 ;; shell-send-eof comint-delchar-or-maybe-eof
3316 ;; kill-shell-input comint-kill-input
3317 ;; interrupt-shell-subjob comint-interrupt-subjob
3318 ;; stop-shell-subjob comint-stop-subjob
3319 ;; quit-shell-subjob comint-quit-subjob
3320 ;; kill-shell-subjob comint-kill-subjob
3321 ;; kill-output-from-shell comint-delete-output
3322 ;; show-output-from-shell comint-show-output
3323 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3324 ;;
3325 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3326 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3327 ;; Comint mode does not provide functionality equivalent to
3328 ;; shell-set-directory-error-hook; it is gone.
3329 ;;
3330 ;; comint-last-input-start is provided for modes which want to munge
3331 ;; the buffer after input is sent, perhaps because the inferior
3332 ;; insists on echoing the input. The LAST-INPUT-START variable in
3333 ;; the old shell package was used to implement a history mechanism,
3334 ;; but you should think twice before using comint-last-input-start
3335 ;; for this; the input history ring often does the job better.
3336 ;;
3337 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3338 ;; *not* create the comint-mode local variables in your foo-mode function.
3339 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3340 ;; necessary comint-specific local variables. Then create the
3341 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3342 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3343 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3344 ;; get-old-input) that need to be different from the defaults. Call
3345 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3346 ;; comint-mode will take care of it. The following example, from shell.el,
3347 ;; is typical:
3348 ;;
3349 ;; (defvar shell-mode-map '())
3350 ;; (cond ((not shell-mode-map)
3351 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3352 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3353 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3354 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3355 ;; (define-key shell-mode-map "\M-?"
3356 ;; 'comint-dynamic-list-filename-completions)))
3357 ;;
3358 ;; (defun shell-mode ()
3359 ;; (interactive)
3360 ;; (comint-mode)
3361 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3362 ;; (setq major-mode 'shell-mode)
3363 ;; (setq mode-name "Shell")
3364 ;; (use-local-map shell-mode-map)
3365 ;; (make-local-variable 'shell-directory-stack)
3366 ;; (setq shell-directory-stack nil)
3367 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3368 ;; (run-hooks 'shell-mode-hook))
3369 ;;
3370 ;;
3371 ;; Completion for comint-mode users
3372 ;;
3373 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3374 ;; hook to add completion functions to. Functions on this list should return
3375 ;; non-nil if completion occurs (i.e., further completion should not occur).
3376 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3377 ;; completion job.
3378 \f
3382 ;;; comint.el ends here