| blob | 6bc40a01bd3605dffe176615fbd0f2f50f5fa21a |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988,90,92,93,94,95,96,97,98,99,2000,01,02,2003
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 moves point to the end of the output.
249 If nil, then output never moves point to the output.
250 (If the output occurs at point, it is inserted before point.)
251 If t or `all', move point in all windows showing the buffer.
252 If `this', move point only the selected window.
253 If `others', move point only in other windows, not in the selected window.
255 The default is nil.
257 See the variable `comint-scroll-show-maximum-output' and the function
258 `comint-postoutput-scroll-to-bottom'.
259 This variable is buffer-local in all comint buffers."
270 "*Controls how to scroll due to interpreter output.
271 This variable applies when point is at the end of the buffer
272 \(either because it was originally there, or because
273 `comint-move-point-for-output' said to move it there)
274 and output from the subprocess is inserted.
276 Non-nil means scroll so that the window is full of text
277 and point is on the last line. A value of nil
278 means don't do anyting special--scroll normally.
280 See also the variable `comint-move-point-for-output' and the function
281 `comint-postoutput-scroll-to-bottom'.
282 This variable is buffer-local in all comint buffers."
287 "*The maximum size in lines for comint buffers.
288 Comint buffers are truncated from the top to be no greater than this number, if
289 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
303 "*If non-nil, assume that the subprocess echoes any input.
304 If so, delete one copy of the input so that only one copy eventually
305 appears in the buffer.
307 This variable is buffer-local."
311 ;; AIX puts the name of the person being su'd to in front of the prompt.
312 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
313 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
314 ;; ssh-add prints a prompt like `Enter passphrase: '.
315 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
322 "*Regexp matching prompts for passwords in the inferior process.
323 This is used by `comint-watch-for-password-prompt'."
327 ;; Here are the per-interpreter hooks.
329 "Function that returns old text in comint mode.
330 This function is called when return is typed while the point is in old
331 text. It returns the text to be submitted as process input. The
332 default is `comint-get-old-input-default', which either grabs the
333 current input field or grabs the current line and strips off leading
334 text matching `comint-prompt-regexp', depending on the value of
339 "List of functions called to perform completion.
340 Functions should return non-nil if completion was performed.
341 See also `comint-dynamic-complete'.
347 "Predicate for filtering additions to input history.
348 Takes one argument, the input. If non-nil, the input may be saved on the input
352 "Functions to call before input is sent to the process.
353 These functions get one argument, a string containing the text to send.
355 You can use `add-hook' to add functions to this list
359 "Functions to call after output is inserted into the buffer.
360 One possible function is `comint-postoutput-scroll-to-bottom'.
361 These functions get one argument, a string containing the text as originally
362 inserted. Note that this might not be the same as the buffer contents between
363 `comint-last-output-start' and the buffer's `process-mark', if other filter
364 functions have already modified the buffer.
366 See also `comint-preoutput-filter-functions'.
368 You can use `add-hook' to add functions to this list
375 "Function to actually send to PROCESS the STRING submitted by user.
376 Usually this is just `comint-simple-send', but if your mode needs to
377 massage the input string, put a different function here.
378 `comint-simple-send' just sends the string plus a newline.
379 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
383 "*Non-nil means go to the end of the line before sending input.
384 See `comint-send-input'."
388 ;; Note: If it is decided to purge comint-prompt-regexp from the source
389 ;; entirely, searching for uses of this variable will help to identify
390 ;; places that need attention.
392 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
393 If nil, then program output and user-input are given different `field'
394 properties, which emacs commands can use to distinguish them (in
395 particular, common movement commands such as begining-of-line respect
396 field boundaries in a natural way)."
401 "Called upon entry into `comint-mode'
402 This is run before the process is cranked up."
407 "Called each time a process is exec'd by `comint-exec'.
408 This is called after the process is cranked up. It is useful for things that
409 must be done each time a process is executed in a comint mode buffer (e.g.,
410 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
411 executed once when the buffer is created."
418 "Non-nil if communications via pty; false if by pipe. Buffer local.
430 "Last input ring index which you copied.
434 "Non-nil if you are accumulating input lines to send as input together.
453 "Major mode for interacting with an inferior interpreter.
454 Interpreter name is same as buffer name, sans the asterisks.
455 Return at end of buffer sends line as input.
456 Return not at end copies rest of line to end and sends it.
457 Setting variable `comint-eol-on-send' means jump to the end of the line
458 before submitting new input.
460 This mode is customised to create major modes such as Inferior Lisp
461 mode, Shell mode, etc. This can be done by setting the hooks
462 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
463 and `comint-get-old-input' to appropriate functions, and the variable
464 `comint-prompt-regexp' to the appropriate regular expression.
466 An input history is maintained of size `comint-input-ring-size', and
467 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
468 Input ring history expansion can be achieved with the commands
470 Input ring expansion is controlled by the variable `comint-input-autoexpand',
471 and addition is controlled by the variable `comint-input-ignoredups'.
473 Commands with no default key bindings include `send-invisible',
474 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
475 `comint-magic-space'.
477 Input to, and output from, the subprocess can cause the window to scroll to
478 the end of the buffer. See variables `comint-output-filter-functions',
479 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
480 and `comint-move-point-for-output'.
483 to continue it.
487 Entry to this mode runs the hooks on `comint-mode-hook'."
517 ;; This makes it really work to keep point at the bottom.
527 ;; This behavior is not useful in comint buffers, and is annoying
531 nil
532 ;; 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.
666 buffer)
668 ;;;###autoload
670 "Make a comint process NAME in a buffer, running PROGRAM.
671 The name of the buffer is made by surrounding NAME with `*'s.
672 PROGRAM should be either a string denoting an executable program to create
673 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
674 connection to be opened via `open-network-stream'. If there is already a
675 running process in that buffer, it is not restarted. Optional third arg
676 STARTFILE is the name of a file to send the contents of to the process.
678 If PROGRAM is a string, any more args are arguments to PROGRAM."
681 ;;;###autoload
683 "Run PROGRAM in a comint buffer and switch to it.
684 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
685 The file name is used to make a symbol name, such as `comint-sh-hook', and any
686 hooks on this symbol are run in the buffer.
687 See `make-comint' and `comint-exec'."
694 "Start up a process in buffer BUFFER for comint modes.
695 Blasts any old process running in the buffer. Doesn't set the buffer mode.
696 You can use this to cheaply run a series of processes in the same comint
697 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.
741 ;; ;; There is similar code in compile.el.
748 process-environment))
751 default-directory
753 proc decoding encoding changed)
755 ;; If the command has slashes, make sure we
756 ;; first look relative to the current directory.
762 ;; If start-process decided to use some coding system for decoding
763 ;; data sent from the process and the coding system doesn't
764 ;; specify EOL conversion, we had better convert CRLF to LF.
767 changed t))
768 ;; Even if start-process left the coding system for encoding data
769 ;; sent from the process undecided, we had better use the same one
770 ;; as what we use for decoding. But, we should suppress EOL
771 ;; conversion.
774 changed t))
777 proc))
781 "In a comint buffer, set the current input to the clicked-on previous input."
785 ;; No input at POS, fall back to the global definition.
790 ;; There's previous input at POS, insert it at the end of the buffer.
792 ;; First delete any old unsent input at the end
797 ;; Insert the clicked-upon input
803 \f
804 ;; Input history processing in a buffer
805 ;; ===========================================================================
806 ;; Useful input history functions, courtesy of the Ergo group.
808 ;; Eleven commands:
809 ;; comint-dynamic-list-input-ring List history in help buffer.
810 ;; comint-previous-input Previous input...
811 ;; comint-previous-matching-input ...matching a string.
812 ;; comint-previous-matching-input-from-input ... matching the current input.
813 ;; comint-next-input Next input...
814 ;; comint-next-matching-input ...matching a string.
815 ;; comint-next-matching-input-from-input ... matching the current input.
816 ;; comint-backward-matching-input Backwards input...
817 ;; comint-forward-matching-input ...matching a string.
818 ;; comint-replace-by-expanded-history Expand history at point;
819 ;; replace with expanded history.
820 ;; comint-magic-space Expand history and insert space.
821 ;;
822 ;; Three functions:
823 ;; comint-read-input-ring Read into comint-input-ring...
824 ;; comint-write-input-ring Write to comint-input-ring-file-name.
825 ;; comint-replace-by-expanded-history-before-point Workhorse function.
828 "Sets the buffer's `comint-input-ring' from a history file.
829 The name of the file is given by the variable `comint-input-ring-file-name'.
830 The history ring is of size `comint-input-ring-size', regardless of file size.
831 If `comint-input-ring-file-name' is nil this function does nothing.
833 If the optional argument SILENT is non-nil, we say nothing about a
834 failure to read the history file.
836 This function is useful for major mode commands and mode hooks.
838 The commands stored in the history file are separated by the
839 `comint-input-ring-separator', and entries that match
840 `comint-input-history-ignore' are ignored. The most recent command
841 comes last.
843 See also `comint-input-ignoredups' and `comint-write-input-ring'."
846 nil)
850 comint-input-ring-file-name)))
863 ;; Save restriction in case file is already visited...
864 ;; Watch for those date stamps in history files!
884 comint-input-ring-index nil)))))
887 "Writes the buffer's `comint-input-ring' to a history file.
888 The name of the file is given by the variable `comint-input-ring-file-name'.
889 The original contents of the file are lost if `comint-input-ring' is not empty.
890 If `comint-input-ring-file-name' is nil this function does nothing.
892 Useful within process sentinels.
894 See also `comint-read-input-ring'."
898 nil)
906 ;; Write it all out into a buffer first. Much faster, but messier,
907 ;; than writing it one line at a time.
921 "Choose the input history entry that point is in or next to."
938 "List in help buffer the buffer's input history."
947 ;; We have to build up a list ourselves from the ring vector.
951 ;; Change "completion" to "history reference"
952 ;; to make the display accurate.
973 ;; Return list of regexp and prefix arg using PROMPT.
981 regexp)
985 ;; First make sure there is a ring and that we are after the process mark
992 ;; arg of zero resets search from beginning, and uses arg of 1
996 arg)))
999 ;; Index to start a directional search, starting at comint-input-ring-index
1001 ;; If a search is running, offset by 1 in direction of arg
1004 ;; For a new search, start from beginning or end, as appropriate
1010 "Return the string ARG places along the input ring.
1011 Moves relative to `comint-input-ring-index'."
1015 arg)))
1018 "Cycle backwards through input history."
1023 "Cycle forwards through input history."
1028 "Return the string matching REGEXP ARG places along the input ring.
1029 Moves relative to `comint-input-ring-index'."
1034 "Return the index matching REGEXP ARG places along the input ring.
1035 Moves relative to START, or `comint-input-ring-index'."
1044 ;; Do the whole search as many times as the argument says.
1046 ;; Step once.
1049 ;; If we haven't reached a match, step some more.
1053 ;; If we have gone all the way around in this search.
1056 ;; Now that we know which ring element to use, if we found it, return that.
1058 n)))
1061 "Search backwards through input history for match for REGEXP.
1062 \(Previous history elements are earlier commands.)
1063 With prefix argument N, search for Nth previous match.
1064 If N is negative, find the next or Nth next match."
1068 ;; Has a match been found?
1074 ;; Can't use kill-region as it sets this-command
1081 "Search forwards through input history for match for REGEXP.
1082 \(Later history elements are more recent commands.)
1083 With prefix argument N, search for Nth following match.
1084 If N is negative, find the previous or Nth previous match."
1089 "Search backwards through input history for match for current input.
1090 \(Previous history elements are earlier commands.)
1091 With prefix argument N, search for Nth previous match.
1092 If N is negative, search forwards for the -Nth following match."
1095 comint-next-matching-input-from-input)))
1096 ;; Starting a new search
1102 comint-input-ring-index nil))
1105 arg))
1108 "Search forwards through input history for match for current input.
1109 \(Following history elements are more recent commands.)
1110 With prefix argument N, search for Nth following match.
1111 If N is negative, search backwards for the -Nth previous match."
1117 "Expand input command history references before point.
1118 Expansion is dependent on the value of `comint-input-autoexpand'.
1120 This function depends on the buffer's idea of the input history, which may not
1121 match the command interpreter's idea, assuming it has one.
1123 Assumes history syntax is like typical Un*x shells'. However, since emacs
1124 cannot know the interpreter's idea of input line numbers, assuming it has one,
1125 it cannot expand absolute input line number references.
1127 If the optional argument SILENT is non-nil, never complain
1128 even if history reference seems erroneous.
1130 If the optional argument START is non-nil, that specifies the
1131 start of the text to scan for history references, rather
1132 than the logical beginning of line.
1134 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1136 Returns t if successful."
1140 ;; Use comint-prompt-regexp
1144 ;; Use input fields. User input that hasn't been entered
1145 ;; yet, at the end of the buffer, has a nil `field' property.
1148 ;; Looks like there might be history references in the command.
1155 "Expand directory stack reference before point.
1156 See `comint-replace-by-expanded-history'. Returns t if successful.
1158 If the optional argument START is non-nil, that specifies the
1159 start of the text to scan for history references, rather
1160 than the logical beginning of line."
1168 ;; This seems a bit complex. We look for references such as !!, !-num,
1169 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1170 ;; If that wasn't enough, the plings can be suffixed with argument
1171 ;; range specifiers.
1172 ;; Argument ranges are complex too, so we hive off the input line,
1173 ;; referenced with plings, with the range string to `comint-args'.
1177 ;; The history is quoted, or we're in quotes.
1180 ;; We cannot know the interpreter's idea of input line numbers.
1184 ;; Just a number of args from `number' lines backward.
1193 t t)
1199 ;; Just a number of args from the previous input line.
1203 t t)
1207 ;; Most recent input starting with or containing (possibly
1208 ;; protected) string, maybe just a number of args. Phew.
1226 t t)
1229 ;; Quick substitution on the previous input line.
1246 "Expand input history references before point and insert ARG spaces.
1247 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1251 \f
1253 "Return t if the number of quotes between BEG and END is odd.
1254 Quotes are single and double."
1260 "Return number of matches for REGEXP from BEG to END."
1267 count))
1270 ;; From STRING, return the args depending on the range specified in the text
1271 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1272 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1288 ;; Return a list of arguments from ARG. Break it up at the
1289 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1304 comint-delimiter-argument-list)))
1307 args)))
1310 "Return from STRING the NTH to MTH arguments.
1311 NTH and/or MTH can be nil, which means the last argument.
1312 Returned arguments are separated by single spaces.
1313 We assume whitespace separates arguments, except within quotes
1314 and except for a space or tab that immediately follows a backslash.
1315 Also, a run of one or more of a single character
1316 in `comint-delimiter-argument-list' is a separate argument.
1317 Argument 0 is the command name."
1318 ;; The first line handles ordinary characters and backslash-sequences
1319 ;; (except with w32 msdos-like shells, where backslashes are valid).
1320 ;; The second matches "-quoted strings.
1321 ;; The third matches '-quoted strings.
1322 ;; The fourth matches `-quoted strings.
1323 ;; This seems to fit the syntax of BASH 2.0.
1334 beg str value quotes)
1335 ;; Build a list of all the args until we have as many as we want.
1339 ;; It's contiguous, part of the same arg.
1342 ;; It's a new separate arg.
1344 ;; Put the previous arg, if there was one, onto ARGS.
1361 \f
1362 ;;
1363 ;; Input processing stuff
1364 ;;
1366 "Add CMD to the input history.
1367 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1373 cmd))))
1377 "Send input to process.
1378 After the process output mark, sends all text from the process mark to
1379 point as input to the process. Before the process output mark, calls
1380 value of variable `comint-get-old-input' to retrieve old input, copies
1381 it to the process mark, and sends it. A terminal newline is also
1382 inserted into the buffer and sent to the process.
1384 Any history reference may be expanded depending on the value of the variable
1385 `comint-input-autoexpand'. The list of function names contained in the value
1386 of `comint-input-filter-functions' is called on the input before sending it.
1387 The input is entered into the input history ring, if the value of variable
1388 `comint-input-filter' returns non-nil when called on the input.
1390 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1391 end of line before sending the input.
1393 After the input has been sent, if `comint-process-echoes' is non-nil,
1394 then comint-send-input waits to see if the process outputs a string
1395 matching the input, and if so, deletes that part of the output.
1397 The values of `comint-get-old-input', `comint-input-filter-functions', and
1398 `comint-input-filter' are chosen according to the command interpreter running
1399 in the buffer. E.g.,
1401 If the interpreter is the csh,
1402 comint-get-old-input is the default:
1403 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1404 either return the current input field, if point is on an input
1405 field, or the current line, if point is on an output field.
1406 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1407 return the current line with any initial string matching the
1408 regexp `comint-prompt-regexp' removed.
1411 comint-input-filter is the default: returns t if the input isn't all white
1412 space.
1414 If the comint is Lucid Common Lisp,
1415 comint-get-old-input snarfs the sexp ending at point.
1416 comint-input-filter-functions does nothing.
1417 comint-input-filter returns nil if the input matches input-filter-regexp,
1418 which matches (1) all whitespace (2) :a, :c, etc.
1420 Similarly for Soar, Scheme, etc."
1422 ;; Note that the input string does not include its terminal newline.
1432 copy)))
1434 ;; Just whatever's already there
1435 intxt
1436 ;; Expand and leave it visible in buffer
1440 input
1441 ;; This is messy 'cos ultimately the original
1442 ;; functions used do insertion, rather than return
1443 ;; strings. We have to expand, then insert back.
1449 copy))))
1463 ;; Set text-properties for the input field
1465 beg end
1467 font-lock-face comint-highlight-input
1468 mouse-face highlight
1471 ;; Give old user input a field property of `input', to
1472 ;; distinguish it from both process output and unsent
1473 ;; input. The terminating newline is put into a special
1474 ;; `boundary' field to make cursor movement between input
1475 ;; and output fields smoother.
1478 ;; Cover the terminating newline
1481 field boundary
1482 inhibit-line-move-field-capture t))))
1488 ;; Update the markers before we send the input
1489 ;; in case we get output amidst sending the input.
1493 ;; clear the "accumulation" marker
1498 ;; Optionally delete echoed input (after checking it).
1501 comint-last-input-start)))
1502 ;; Wait for all input to be echoed:
1508 nil comint-last-input-start
1510 ;; Above difference is equivalent to
1511 ;; (+ comint-last-input-start
1512 ;; (- (point-max) comint-last-input-end))
1519 nil comint-last-input-start comint-last-input-end
1520 nil comint-last-input-end
1525 ;; This used to call comint-output-filter-functions,
1526 ;; but that scrolled the buffer in undesirable ways.
1530 "List of functions to call before inserting Comint output into the buffer.
1531 Each function gets one argument, a string containing the text received
1532 from the subprocess. It should return the string to insert, perhaps
1533 the same string that was received, or perhaps a modified or transformed
1534 string.
1536 The functions on the list are called sequentially, and each one is
1537 given the string returned by the previous one. The string returned by
1538 the last function is the text that is actually inserted in the
1539 redirection buffer.
1541 You can use `add-hook' to add functions to this list
1545 "If nil, comint will interpret `carriage control' characters in output.
1548 ;; When non-nil, this is an overlay over the last recognized prompt in
1549 ;; the buffer; it is used when highlighting the prompt.
1552 ;; `snapshot' any current comint-last-prompt-overlay, freezing its
1553 ;; attributes in place, even when more input comes a long and moves the
1554 ;; prompt overlay.
1563 "Interpret carriage control characters in the region from START to END.
1564 Translate carriage return/linefeed sequences to linefeeds.
1565 Make single carriage returns delete to the beginning of the line.
1566 Make backspaces delete the previous character."
1568 ;; First do a quick check to see if there are any applicable
1569 ;; characters, so we can avoid calling save-match-data and
1570 ;; save-restriction if not.
1578 ;; CR LF -> LF
1579 ;; Note that this won't work properly when the CR and LF
1580 ;; are in different output chunks, but this is probably an
1581 ;; exceedingly rare case (because they are generally
1582 ;; written as a unit), and to delay interpretation of a
1583 ;; trailing CR in a chunk would result in odd interactive
1584 ;; behavior (and this case is probably far more common).
1587 ;; bare CR -> delete preceding line
1591 ;; BS -> delete preceding character
1596 ;; The purpose of using this filter for comint processes
1597 ;; is to keep comint-last-input-end from moving forward
1598 ;; when output is inserted.
1601 ;; First check for killed buffer or no input.
1604 ;; Run preoutput filters
1615 ;; Insert STRING
1617 ;; Avoid the overhead of save-excursion, since we just
1618 ;; fiddle with the point
1621 ;; The point should float after any insertion we do
1624 ;; We temporarly remove any buffer narrowing, in case the
1625 ;; process mark is outside of the restriction
1632 ;; insert-before-markers is a bad thing. XXX
1633 ;;
1634 ;; It is used here to force window-point markers (used to
1635 ;; store the value of point in non-selected windows) to
1636 ;; advance, but it also screws up any other markers that we
1637 ;; don't _want_ to advance, such as the start-marker of some
1638 ;; of the overlays we create.
1639 ;;
1640 ;; We work around the problem with the overlays by
1641 ;; explicitly adjusting them after we do the insertion, but
1642 ;; in the future this problem should be solved correctly, by
1643 ;; using `insert', and making the insertion-type of
1644 ;; window-point markers settable (via a buffer-local
1645 ;; variable). In comint buffers, this variable would be set
1646 ;; to `t', to cause point in non-select windows to advance.
1648 ;; Fixup markers and overlays that got screwed up because we
1649 ;; used `insert-before-markers'.
1651 ;; comint-last-output-start
1653 ;; comint-last-input-end
1658 ;; No overlays we create are set to advance upon insertion
1659 ;; (at the start/end), so we assume that any overlay which
1660 ;; is at the current point was incorrectly advanced by
1661 ;; insert-before-markers. First fixup overlays that might
1662 ;; start at point:
1667 old-point
1669 ;; Then do overlays that might end at point:
1674 old-point))))
1676 ;; Advance process-mark
1680 ;; Interpret any carriage motion characters (newline, backspace)
1691 field output
1692 inhibit-line-move-field-capture t))))
1694 ;; Highlight the prompt, where we define `prompt' to mean
1695 ;; the most recent output that doesn't end with a newline.
1697 ;; Need to create or move the prompt overlay (in the case
1698 ;; where there is no prompt ((bolp) == t), we still do
1699 ;; this if there's already an existing overlay).
1702 ;; Just move an existing overlay
1705 ;; Need to create the overlay
1714 "Go to the end of buffer in all windows showing it.
1715 Movement occurs if point in the selected window is not after the process mark,
1716 and `this-command' is an insertion command. Insertion commands recognised
1717 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1718 Depends on the value of `comint-scroll-to-bottom-on-input'.
1720 This function should be a pre-command hook."
1723 hilit-yank)))
1739 nil t))))))
1742 "Go to the end of buffer in some or all windows showing it.
1743 Does not scroll if the current line is the last line in the buffer.
1744 Depends on the value of `comint-move-point-for-output' and
1745 `comint-scroll-show-maximum-output'.
1747 This function should be in the list `comint-output-filter-functions'."
1761 ;; Maybe user wants point to jump to end.
1764 ;; If point was at the end, keep it at end.
1768 ;; Optionally scroll so that the text
1769 ;; ends at the bottom of the window.
1776 nil t))
1780 "Truncate the buffer to `comint-buffer-maximum-size'.
1781 This function could be on `comint-output-filter-functions' or bound to a key."
1791 "Strip trailing `^M' characters from the current output group.
1792 This function could be on `comint-output-filter-functions' or bound to a key."
1805 "Put the end of the buffer at the bottom of the window."
1811 "Default for `comint-get-old-input'.
1812 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1813 return the current input field, if point is on an input field, or the
1814 current line, if point is on an output field.
1815 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1816 the current line with any initial string matching the regexp
1817 `comint-prompt-regexp' removed."
1825 "Insert after prompt old input at point as new input to be edited.
1826 Calls `comint-get-old-input' to get old input."
1836 "Skip past the text matching regexp `comint-prompt-regexp'.
1837 If this takes us past the end of the current line, don't skip at all."
1844 "Return t if point is after the process output marker."
1849 "Default function for sending to PROC input STRING.
1850 This just sends STRING plus a newline. To override this,
1851 set the hook `comint-input-sender'."
1859 "Returns the buffer position of the beginning of the line, after any prompt.
1860 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1861 prompt skip is done by skipping text matching the regular expression
1862 `comint-prompt-regexp', a buffer local variable."
1864 ;; Use comint-prompt-regexp
1869 ;; Use input fields. Note that, unlike the behavior of
1870 ;; `line-beginning-position' inside a field, this function will
1871 ;; return the position of the end of a prompt, even if the point is
1872 ;; already inside the prompt. In order to do this, it assumes that
1873 ;; if there are two fields on a line, then the first one is the
1874 ;; prompt, and the second one is an input field, and is front-sticky
1875 ;; (as input fields should be).
1879 "Goes to the beginning of line, then skips past the prompt, if any.
1881 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1882 prompt skip is done by skipping text matching the regular expression
1883 `comint-prompt-regexp', a buffer local variable."
1886 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1890 ;; These three functions are for entering text you don't want echoed or
1891 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1892 ;; Just enter m-x send-invisible and type in your line, or add
1893 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1896 "Read a single line of text from user without echoing, and return it.
1897 Prompt with argument PROMPT, a string. Optional argument STARS causes
1898 input to be echoed with '*' characters on the prompt line. Input ends with
1899 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1900 `inhibit-quit' is set because e.g. this function was called from a process
1901 filter and C-g is pressed, this function returns nil rather than a string).
1903 Note that the keystrokes comprising the text can still be recovered
1905 however, `clear-this-command-keys').
1906 Once the caller uses the password, it can erase the password
1907 by doing (clear-string STRING)."
1919 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1922 ;; This function may get called from a process filter, where
1923 ;; inhibit-quit is set. In later versions of emacs read-char
1924 ;; may clear quit-flag itself and return C-g. That would make
1925 ;; it impossible to quit this loop in a simple way, so
1926 ;; re-enable it here (for backward-compatibility the check for
1927 ;; quit-flag below would still be necessary, so this seems
1928 ;; like the simplest way to do things).
1930 done t))
1944 ;; Emulate a true quit, except that we have to return a value.
1950 ans)))
1953 "Read a string without echoing.
1954 Then send it to the process running in the current buffer.
1955 The string is sent using `comint-input-sender'.
1956 Security bug: your string can still be temporarily recovered with
1970 "Prompt in the minibuffer for password and send without echoing.
1971 This function uses `send-invisible' to read and send a password to the buffer's
1972 process if STRING contains a password prompt defined by
1973 `comint-password-prompt-regexp'.
1975 This function could be in the list `comint-output-filter-functions'."
1980 \f
1981 ;; Low-level process communication
1984 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1994 "Like `process-send-region', but also does extra bookkeeping for comint mode."
2003 \f
2004 ;; Random input hackage
2007 "Delete all output from interpreter since last input.
2008 Does not delete the prompt."
2021 ;; Output message and put back prompt
2027 "Write output from interpreter since last input to FILENAME.
2028 Any prompt at the end of the output is not written.
2030 If the optional argument APPEND (the prefix argument when interactive)
2031 is non-nil, the output is appended to the file instead.
2033 If the optional argument MUSTBENEW is non-nil, check for an existing
2034 file with the same name. If MUSTBENEW is `excl', that means to get an
2035 error if the file already exists; never overwrite. If MUSTBENEW is
2036 neither nil nor `excl', that means ask for confirmation before
2037 overwriting, but do go ahead and overwrite the file if the user
2038 confirms. When interactive, MUSTBENEW is nil when appending, and t
2039 otherwise."
2043 "Append output to file: "
2045 current-prefix-arg
2051 append nil nil mustbenew)))
2053 ;; This function exists for the benefit of the menu; from the keyboard,
2054 ;; users can just use `comint-write-output' with a prefix arg.
2056 "Append output from interpreter since last input to FILENAME.
2057 Any prompt at the end of the output is not written."
2062 "Display start of this batch of interpreter output at top of window.
2063 Sets mark to the value of point when this command is run."
2078 "Interrupt the current subjob.
2079 This command also kills the pending input
2080 between the process-mark and point."
2084 ;; (process-send-string nil "\n")
2085 )
2088 "Send kill signal to the current subjob.
2089 This command also kills the pending input
2090 between the process-mark and point."
2096 "Send quit signal to the current subjob.
2097 This command also kills the pending input
2098 between the process-mark and point."
2104 "Stop the current subjob.
2105 This command also kills the pending input
2106 between the process-mark and point.
2108 WARNING: if there is no current subjob, you can end up suspending
2109 the top-level process running in the buffer. If you accidentally do
2111 is not a problem with most shells, since they ignore this signal.)"
2117 "Send CONT signal to process buffer's process group.
2118 Useful if you accidentally suspend the top-level process."
2123 "Skip all pending input, from last stuff output by interpreter to point.
2124 This means mark it as if it had been sent as input, without sending it."
2136 "Kill all text from last stuff output by interpreter to point."
2143 "Delete ARG characters forward or send an EOF to subprocess.
2144 Sends an EOF only if point is at the end of the buffer and there is no input."
2152 "Send an EOF to the current buffer's process."
2159 "Search backward through buffer for input fields that match REGEXP.
2160 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2161 fields are identified by lines that match `comint-prompt-regexp'.
2163 With prefix argument N, search for Nth previous match.
2164 If N is negative, find the next or Nth next match."
2167 ;; Use comint-prompt-regexp
2177 ;; Use input fields
2191 "Search forward through buffer for input fields that match REGEXP.
2192 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2193 fields are identified by lines that match `comint-prompt-regexp'.
2195 With prefix argument N, search for Nth following match.
2196 If N is negative, find the previous or Nth previous match."
2202 "Move to end of Nth next prompt in the buffer.
2203 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2204 the beginning of the Nth next `input' field, otherwise, it means the Nth
2205 occurrence of text matching `comint-prompt-regexp'."
2208 ;; Use comint-prompt-regexp
2213 ;; Use input fields
2216 prev-pos)
2224 ;; Ran off the end of the buffer.
2226 ;; There's always an input field at the end of the
2227 ;; buffer, but it has a `field' property of nil.
2229 ;; stop iterating
2239 "Move to end of Nth previous prompt in the buffer.
2240 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2241 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2242 occurrence of text matching `comint-prompt-regexp'."
2246 ;; State used by `comint-insert-previous-argument' when cycling.
2252 ;; Needs fixing:
2253 ;; make comint-arguments understand negative indices as bash does
2255 "Insert the INDEXth argument from the previous comint command-line at point.
2256 Spaces are added at beginning and/or end of the inserted string if
2257 necessary to ensure that it's separated from adjacent arguments.
2258 Interactively, if no prefix argument is given, the last argument is inserted.
2259 Repeated interactive invocations will cycle through the same argument
2260 from progressively earlier commands (using the value of INDEX specified
2261 with the first command).
2262 This command is like `M-.' in bash."
2267 ;; Delete last input inserted by this command.
2271 ;; This is a non-repeat invocation, so initialize state.
2275 ;; First usage; initialize to a marker
2278 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2282 ;; Remember the beginning of what we insert, so we can delete it if
2283 ;; the command is repeated.
2285 ;; Insert the argument.
2288 ;; strip terminating '&'
2291 ;; Make next invocation return arg from previous input
2293 ;; Add a terminating space if necessary.
2297 \f
2298 ;; Support for source-file processing commands.
2299 ;;============================================================================
2300 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2301 ;; commands that process files of source text (e.g. loading or compiling
2302 ;; files). So the corresponding process-in-a-buffer modes have commands
2303 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2304 ;; for defining these commands.
2305 ;;
2306 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2307 ;; and Soar, in that they don't know anything about file extensions.
2308 ;; So the compile/load interface gets the wrong default occasionally.
2309 ;; The load-file/compile-file default mechanism could be smarter -- it
2310 ;; doesn't know about the relationship between filename extensions and
2311 ;; whether the file is source or executable. If you compile foo.lisp
2312 ;; with compile-file, then the next load-file should use foo.bin for
2313 ;; the default, not foo.lisp. This is tricky to do right, particularly
2314 ;; because the extension for executable files varies so much (.o, .bin,
2315 ;; .lbin, .mo, .vo, .ao, ...).
2318 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2319 ;; commands.
2320 ;;
2321 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2322 ;; want to save the buffer before issuing any process requests to the command
2323 ;; interpreter.
2324 ;;
2325 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2326 ;; for the file to process.
2328 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2329 ;;============================================================================
2330 ;; This function computes the defaults for the load-file and compile-file
2331 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2332 ;;
2333 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2334 ;; source-file processing command. nil if there hasn't been one yet.
2335 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2336 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2337 ;; Typically, (lisp-mode) or (scheme-mode).
2338 ;;
2339 ;; If the command is given while the cursor is inside a string, *and*
2340 ;; the string is an existing filename, *and* the filename is not a directory,
2341 ;; then the string is taken as default. This allows you to just position
2342 ;; your cursor over a string that's a filename and have it taken as default.
2343 ;;
2344 ;; If the command is given in a file buffer whose major mode is in
2345 ;; SOURCE-MODES, then the filename is the default file, and the
2346 ;; file's directory is the default directory.
2347 ;;
2348 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2349 ;; then the default directory & file are what was used in the last source-file
2350 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2351 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2352 ;; is the cwd, with no default file. (\"no default file\" = nil)
2353 ;;
2354 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2355 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2356 ;; for Soar programs, etc.
2357 ;;
2358 ;; The function returns a pair: (default-directory . default-file).
2369 ;; (COMINT-CHECK-SOURCE fname)
2370 ;;============================================================================
2371 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2372 ;; process-in-a-buffer modes), this function can be called on the filename.
2373 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2374 ;; is queried to see if he wants to save the buffer before proceeding with
2375 ;; the load or compile.
2382 ;; save BUFF.
2389 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2390 ;;============================================================================
2391 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2392 ;; commands that process source files (like loading or compiling a file).
2393 ;; It prompts for the filename, provides a default, if there is one,
2394 ;; and returns the result filename.
2395 ;;
2396 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2397 ;;
2398 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2399 ;; from the last source processing command. SOURCE-MODES is a list of major
2400 ;; modes used to determine what file buffers contain source files. (These
2401 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2402 ;; then the filename reader will only accept a file that exists.
2403 ;;
2404 ;; A typical use:
2405 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2406 ;; '(lisp-mode) t))
2408 ;; This is pretty stupid about strings. It decides we're in a string
2409 ;; if there's a quote on both sides of point on the current line.
2411 "Return string around POINT that starts the current line, or nil."
2438 prompt deffile)
2439 prompt)
2440 defdir
2442 mustmatch-p)))
2445 ;; I am somewhat divided on this string-default feature. It seems
2446 ;; to violate the principle-of-least-astonishment, in that it makes
2447 ;; the default harder to predict, so you actually have to look and see
2448 ;; what the default really is before choosing it. This can trip you up.
2449 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2450 ;; on this.
2451 ;; -Olin
2453 \f
2454 ;; Simple process query facility.
2455 ;; ===========================================================================
2456 ;; This function is for commands that want to send a query to the process
2457 ;; and show the response to the user. For example, a command to get the
2458 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2459 ;; to an inferior Common Lisp process.
2460 ;;
2461 ;; This simple facility just sends strings to the inferior process and pops
2462 ;; up a window for the process buffer so you can see what the process
2463 ;; responds with. We don't do anything fancy like try to intercept what the
2464 ;; process responds with and put it in a pop-up window or on the message
2465 ;; line. We just display the buffer. Low tech. Simple. Works good.
2467 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2468 ;; a window for the inferior process so that its response can be seen.
2478 ;; Try to position the proc window so you can see the answer.
2479 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2480 ;; I don't know why. Wizards invited to improve it.
2489 \f
2490 ;; Filename/command/history completion in a buffer
2491 ;; ===========================================================================
2492 ;; Useful completion functions, courtesy of the Ergo group.
2494 ;; Six commands:
2495 ;; comint-dynamic-complete Complete or expand command, filename,
2496 ;; history at point.
2497 ;; comint-dynamic-complete-filename Complete filename at point.
2498 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2499 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2500 ;; replace with expanded/completed name.
2501 ;; comint-dynamic-simple-complete Complete stub given candidates.
2503 ;; These are not installed in the comint-mode keymap. But they are
2504 ;; available for people who want them. Shell-mode installs them:
2505 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2506 ;; (define-key shell-mode-map "\M-?"
2507 ;; 'comint-dynamic-list-filename-completions)))
2508 ;;
2509 ;; Commands like this are fine things to put in load hooks if you
2510 ;; want them present in specific modes.
2513 "*If non-nil, automatically list possibilities on partial completion.
2514 This mirrors the optional behavior of tcsh."
2519 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2520 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2521 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2522 This mirrors the optional behavior of tcsh."
2531 "*If non-nil, use shortest completion if characters cannot be added.
2532 This mirrors the optional behavior of tcsh.
2534 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2539 "*List of suffixes to be disregarded during file completion.
2540 This mirrors the optional behavior of bash and tcsh.
2542 Note that this applies to `comint-dynamic-complete-filename' only."
2547 "Prefix prepended to absolute file names taken from process input.
2548 This is used by comint's and shell's completion functions, and by shell's
2553 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2555 "String of characters valid in a file name.
2556 Note that all non-ASCII characters are considered valid in a file name
2557 regardless of what this variable says.
2568 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2571 directory)))
2575 "Return the word of WORD-CHARS at point, or nil if non is found.
2576 Word constituents are considered to be those in WORD-CHARS, which is like the
2578 plus all non-ASCII characters."
2581 giveup)
2593 ;; Set match-data to match the entire string.
2599 "Return FILENAME with environment variables substituted.
2600 Supports additional environment variable syntax of the command
2601 interpreter (e.g., the percent notation of cmd.exe on NT)."
2605 env-var-val)
2614 name))
2617 "Return the filename at point, or nil if non is found.
2618 Environment variables are substituted. See `comint-word'."
2625 "Return FILENAME with magic characters quoted.
2626 Magic characters are those in `comint-file-name-quote-list'."
2628 filename
2637 filename))))
2640 "Return FILENAME with quoted characters unquoted."
2642 filename
2648 filename)))
2652 "Dynamically perform completion at point.
2653 Calls the functions in `comint-dynamic-complete-functions' to perform
2654 completion until a function returns non-nil, at which point completion is
2655 assumed to have occurred."
2661 "Dynamically complete the filename at point.
2662 Completes if after a filename. See `comint-match-partial-filename' and
2663 `comint-dynamic-complete-as-filename'.
2664 This function is similar to `comint-replace-by-expanded-filename', except that
2665 it won't change parts of the filename already entered in the buffer; it just
2666 adds completion characters to the end of the filename. A completions listing
2667 may be shown in a help buffer if completion is ambiguous.
2669 Completion is dependent on the value of `comint-completion-addsuffix',
2670 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2671 completions listing is dependent on the value of `comint-completion-autolist'.
2673 Returns t if successful."
2681 "Dynamically complete at point as a filename.
2682 See `comint-dynamic-complete-filename'. Returns t if successful."
2685 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2686 ;; I think it was originally bound to solve file completion problems,
2687 ;; but subsequent changes may have made this unnecessary. sm.
2688 ;;(file-name-handler-alist nil)
2723 ;; We inserted a unique completion.
2730 ;; It's not unique, but user wants shortest match.
2736 ;; It's not unique, list possible completions.
2741 success))
2745 "Dynamically expand and complete the filename at point.
2746 Replace the filename with an expanded, canonicalised and completed replacement.
2749 removed, and the filename is made absolute instead of relative. For expansion
2750 see `expand-file-name' and `substitute-in-file-name'. For completion see
2751 `comint-dynamic-complete-filename'."
2760 "Dynamically complete STUB from CANDIDATES list.
2761 This function inserts completion characters at point by completing STUB from
2762 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2763 if completion is ambiguous.
2765 Returns nil if no completion was inserted.
2766 Returns `sole' if completed with the only completion match.
2767 Returns `shortest' if completed with the shortest of the completion matches.
2768 Returns `partial' if completed as far as possible with the completion matches.
2769 Returns `listed' if a completion listing was shown.
2771 See also `comint-dynamic-complete-filename'."
2780 nil)
2791 ;; Insert the longest substring.
2796 ;; It's not unique, but user wants shortest match.
2802 ;; It's not unique, list possible completions.
2811 "List in help buffer possible completions of the filename at point."
2814 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2815 ;; I think it was originally bound to solve file completion problems,
2816 ;; but subsequent changes may have made this unnecessary. sm.
2817 ;;(file-name-handler-alist nil)
2829 ;; This is bound locally in a *Completions* buffer to the list of
2830 ;; completions displayed, and is used to detect the case where the same
2831 ;; command is repeatedly used without the set of completions changing.
2837 "List in help buffer sorted COMPLETIONS.
2838 Typing SPC flushes the help buffer."
2844 ;; The above tests are not sufficient to detect the case where we
2845 ;; should scroll, because the top-level interactive command may
2846 ;; not have displayed a completions window the last time it was
2847 ;; invoked, and there may be such a window left over from a
2848 ;; previous completion command with a different set of
2849 ;; completions. To detect that case, we also test that the set
2850 ;; of displayed completions is in fact the same as the previously
2851 ;; displayed set.
2855 ;; If this command was repeated, and
2856 ;; there's a fresh completion window with a live buffer,
2857 ;; and this command is repeated, scroll that window.
2865 ;; Display a completion list for the first time.
2872 ;; Read the next key, to process SPC.
2878 completions)
2885 ;; If the user does mouse-choose-completion with the mouse,
2886 ;; execute the command, then delete the completion window.
2895 \f
2897 "After fetching a line from input history, this fetches the following line.
2898 In other words, this recalls the input line after the line you recalled last.
2899 You can use this to repeat a sequence of input lines."
2908 "Accumulate a line to send as input along with more lines.
2909 This inserts a newline so that you can enter more text
2911 to send all the accumulated input, at once.
2912 The entire accumulated text becomes one item in the input history
2913 when you send it."
2922 "Move point to the process mark.
2923 The process mark separates output, and input already sent,
2924 from input that has not yet been sent."
2933 "Move point to beginning of line (after prompt) or to the process mark.
2934 The first time you use this command, it moves to the beginning of the line
2935 \(but after the prompt, if any). If you repeat it again immediately,
2936 it moves point to the process mark.
2938 The process mark separates the process output, along with input already sent,
2939 from input that has not yet been sent. Ordinarily, the process mark
2940 is at the beginning of the current input line; but if you have
2942 the process mark is at the beginning of the accumulated input."
2949 "Set the process mark at point."
2956 \f
2957 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2959 ;; This little add-on for comint is intended to make it easy to get
2960 ;; output from currently active comint buffers into another buffer,
2961 ;; or buffers, and then go back to using the comint shell.
2962 ;;
2963 ;; My particular use is SQL interpreters; I want to be able to execute a
2964 ;; query using the process associated with a comint-buffer, and save that
2965 ;; somewhere else. Because the process might have state (for example, it
2966 ;; could be in an uncommitted transaction), just running starting a new
2967 ;; process and having it execute the query and then finish, would not
2968 ;; work. I'm sure there are other uses as well, although in many cases
2969 ;; starting a new process is the simpler, and thus preferable, approach.
2970 ;;
2971 ;; The basic implementation is as follows: comint-redirect changes the
2972 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2973 ;; its own filter. The filter puts the output into the designated buffer,
2974 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2975 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2976 ;; sees the stop regexp, it restores the old filter functions, and runs
2977 ;; comint-redirect-hook.
2978 ;;
2979 ;; Each comint buffer may only use one redirection at a time, but any number
2980 ;; of different comint buffers may be simultaneously redirected.
2981 ;;
2982 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2983 ;; correct prompt for your interpreter, or that you supply a regexp that says
2984 ;; when the redirection is finished. Otherwise, redirection will continue
2985 ;; indefinitely. The code now does a sanity check to ensure that it can find
2986 ;; a prompt in the comint buffer; however, it is still important to ensure that
2987 ;; this prompt is set correctly.
2988 ;;
2989 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2990 ;; perhaps it should prompt for a terminating string (with an
2991 ;; appropriate magic default by examining what we think is the prompt)?
2992 ;;
2994 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2995 ;; Variables
2996 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2999 "*If non-nil, print messages each time the redirection filter is invoked.
3000 Also print a message when redirection is completed."
3004 ;; Directly analagous to comint-preoutput-filter-functions
3006 "List of functions to call before inserting redirected process output.
3007 Each function gets one argument, a string containing the text received
3008 from the subprocess. It should return the string to insert, perhaps
3009 the same string that was received, or perhaps a modified or transformed
3010 string.
3012 The functions on the list are called sequentially, and each one is given
3013 the string returned by the previous one. The string returned by the
3014 last function is the text that is actually inserted in the redirection buffer.
3016 You can use `add-hook' to add functions to this list
3019 ;; Internal variables
3025 "Regular expression that determines when to stop redirection in Comint.
3026 When the redirection filter function is given output that matches this regexp,
3030 "If non-nil, the text that ends a redirection is included in it.
3031 More precisely, the text that matches `comint-redirect-finished-regexp'
3032 and therefore terminates an output redirection is inserted in the
3045 "If non-nil, check that redirection is likely to complete successfully.
3046 More precisely, before starting a redirection, verify that the
3047 regular expression `comint-redirect-finished-regexp' that controls
3048 when to terminate it actually matches some text already in the process
3049 buffer. The idea is that this regular expression should match a prompt
3050 string, and that there ought to be at least one copy of your prompt string
3054 "The process filter that was in place when redirection is started.
3055 When redirection is completed, the process filter is restored to
3058 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3059 ;; Functions
3060 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3063 comint-buffer
3064 finished-regexp
3066 "Set up for output redirection.
3067 This function sets local variables that are used by `comint-redirect-filter'
3068 to perform redirection.
3070 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3071 in the output matches FINISHED-REGEXP.
3073 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3074 original comint buffer.
3076 This function is called by `comint-redirect-send-command-to-process',
3077 and does not normally need to be invoked by the end user or programmer."
3101 "End a Comint redirection. See `comint-redirect-send-command'."
3103 ;; Restore the process filter
3105 comint-redirect-original-filter-function)
3106 ;; Restore the mode line
3108 ;; Set the completed flag
3111 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3112 ;; that it really occurs.
3116 "Filter function which redirects output from PROCESS to a buffer or buffers.
3117 The variable `comint-redirect-output-buffer' says which buffer(s) to
3118 place output in.
3120 INPUT-STRING is the input from the comint process.
3122 This function runs as a process filter, and does not need to be invoked by the
3123 end user."
3127 ;; If we have to echo output, give it to the original filter function
3129 comint-redirect-original-filter-function
3131 process input-string)))))
3135 "Comint filter function which redirects comint output to a buffer or buffers.
3136 The variable `comint-redirect-output-buffer' says which buffer(s) to
3137 place output in.
3139 INPUT-STRING is the input from the comint process.
3141 This function does not need to be invoked by the end user."
3144 comint-redirect-output-buffer
3148 ;; If there are any filter functions, give them a chance to modify the string
3152 ;; If a local value says "use the default value too",
3153 ;; do that.
3163 ;; Clobber `comint-redirect-finished-regexp'
3169 ;; Send output to all registered buffers
3173 ;; Set this buffer to the output buffer
3175 ;; Go to the end of the buffer
3177 ;; Insert the output
3179 output-buffer-list))
3181 ;; Message
3186 ;; If we see the prompt, tidy up
3187 ;; We'll look for the prompt in the original string, so nobody can
3188 ;; clobber it
3195 ;; Echo input?
3197 filtered-input-string
3200 ;;;###autoload
3202 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3203 With prefix arg, echo output in process buffer.
3205 If NO-DISPLAY is non-nil, do not show the output buffer."
3213 ;;;###autoload
3216 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3217 With prefix arg, echo output in process buffer.
3219 If NO-DISPLAY is non-nil, do not show the output buffer."
3224 process))
3226 ;; Change to the process buffer
3229 ;; Make sure there's a prompt in the current process buffer
3236 ;;;;;;;;;;;;;;;;;;;;;
3237 ;; Set up for redirection
3238 ;;;;;;;;;;;;;;;;;;;;;
3240 ;; Output Buffer
3241 output-buffer
3242 ;; Comint Buffer
3244 ;; Finished Regexp
3245 comint-prompt-regexp
3246 ;; Echo input
3247 echo)
3249 ;;;;;;;;;;;;;;;;;;;;;
3250 ;; Set the filter
3251 ;;;;;;;;;;;;;;;;;;;;;
3252 ;; Save the old filter
3257 ;;;;;;;;;;;;;;;;;;;;;
3258 ;; Send the command
3259 ;;;;;;;;;;;;;;;;;;;;;
3264 ;;;;;;;;;;;;;;;;;;;;;
3265 ;; Show the output
3266 ;;;;;;;;;;;;;;;;;;;;;
3272 output-buffer)))))))
3274 ;;;###autoload
3276 "Send COMMAND to current process.
3277 Return a list of expressions in the output which match REGEXP.
3278 REGEXP-GROUP is the regular expression group in REGEXP to use."
3281 command regexp regexp-group))
3283 ;;;###autoload
3285 "Send COMMAND to PROCESS.
3286 Return a list of expressions in the output which match REGEXP.
3287 REGEXP-GROUP is the regular expression group in REGEXP to use."
3289 results)
3294 output-buffer process nil t)
3295 ;; Wait for the process to complete
3299 ;; Collect the output
3302 ;; Skip past the command, if it was echoed
3310 results)))
3311 results)))
3316 "^Empty input ring$"
3317 "^No history$"
3321 \f
3322 ;; Converting process modes to use comint mode
3323 ;; ===========================================================================
3324 ;; The code in the Emacs 19 distribution has all been modified to use comint
3325 ;; where needed. However, there are `third-party' packages out there that
3326 ;; still use the old shell mode. Here's a guide to conversion.
3327 ;;
3328 ;; Renaming variables
3329 ;; Most of the work is renaming variables and functions. These are the common
3330 ;; ones:
3331 ;; Local variables:
3332 ;; last-input-start comint-last-input-start
3333 ;; last-input-end comint-last-input-end
3334 ;; shell-prompt-pattern comint-prompt-regexp
3335 ;; shell-set-directory-error-hook <no equivalent>
3336 ;; Miscellaneous:
3337 ;; shell-set-directory <unnecessary>
3338 ;; shell-mode-map comint-mode-map
3339 ;; Commands:
3340 ;; shell-send-input comint-send-input
3341 ;; shell-send-eof comint-delchar-or-maybe-eof
3342 ;; kill-shell-input comint-kill-input
3343 ;; interrupt-shell-subjob comint-interrupt-subjob
3344 ;; stop-shell-subjob comint-stop-subjob
3345 ;; quit-shell-subjob comint-quit-subjob
3346 ;; kill-shell-subjob comint-kill-subjob
3347 ;; kill-output-from-shell comint-delete-output
3348 ;; show-output-from-shell comint-show-output
3349 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3350 ;;
3351 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3352 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3353 ;; Comint mode does not provide functionality equivalent to
3354 ;; shell-set-directory-error-hook; it is gone.
3355 ;;
3356 ;; comint-last-input-start is provided for modes which want to munge
3357 ;; the buffer after input is sent, perhaps because the inferior
3358 ;; insists on echoing the input. The LAST-INPUT-START variable in
3359 ;; the old shell package was used to implement a history mechanism,
3360 ;; but you should think twice before using comint-last-input-start
3361 ;; for this; the input history ring often does the job better.
3362 ;;
3363 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3364 ;; *not* create the comint-mode local variables in your foo-mode function.
3365 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3366 ;; necessary comint-specific local variables. Then create the
3367 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3368 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3369 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3370 ;; get-old-input) that need to be different from the defaults. Call
3371 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3372 ;; comint-mode will take care of it. The following example, from shell.el,
3373 ;; is typical:
3374 ;;
3375 ;; (defvar shell-mode-map '())
3376 ;; (cond ((not shell-mode-map)
3377 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3378 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3379 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3380 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3381 ;; (define-key shell-mode-map "\M-?"
3382 ;; 'comint-dynamic-list-filename-completions)))
3383 ;;
3384 ;; (defun shell-mode ()
3385 ;; (interactive)
3386 ;; (comint-mode)
3387 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3388 ;; (setq major-mode 'shell-mode)
3389 ;; (setq mode-name "Shell")
3390 ;; (use-local-map shell-mode-map)
3391 ;; (make-local-variable 'shell-directory-stack)
3392 ;; (setq shell-directory-stack nil)
3393 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3394 ;; (run-hooks 'shell-mode-hook))
3395 ;;
3396 ;;
3397 ;; Completion for comint-mode users
3398 ;;
3399 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3400 ;; hook to add completion functions to. Functions on this list should return
3401 ;; non-nil if completion occurs (i.e., further completion should not occur).
3402 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3403 ;; completion job.
3404 \f
3408 ;;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3409 ;;; comint.el ends here