| blob | 3c0be25c1996dccb5201fb1716866538e4b1c126 |
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'."
510 ;; This behavior is not useful in comint buffers, and is annoying
514 nil
515 ;; Keys:
546 ;; Mouse Buttons:
548 ;; Menu bars:
549 ;; completion:
560 ;; Input history:
601 ;; Signals
616 ;; Put them in the menu bar:
618 menu-bar-final-items))
619 )
622 "Return t if there is a living process associated w/buffer BUFFER.
623 Living means the status is `open', `run', or `stop'.
624 BUFFER can be either a buffer or the name of one."
628 ;;;###autoload
630 "Make a comint process NAME in BUFFER, running PROGRAM.
631 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
632 PROGRAM should be either a string denoting an executable program to create
633 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
634 connection to be opened via `open-network-stream'. If there is already a
635 running process in that buffer, it is not restarted. Optional third arg
636 STARTFILE is the name of a file to send the contents of to the process.
638 If PROGRAM is a string, any more args are arguments to PROGRAM."
642 ;; If no process, or nuked process, crank up a new one and put buffer in
643 ;; comint mode. Otherwise, leave buffer and existing process alone.
649 buffer)
651 ;;;###autoload
653 "Make a comint process NAME in a buffer, running PROGRAM.
654 The name of the buffer is made by surrounding NAME with `*'s.
655 PROGRAM should be either a string denoting an executable program to create
656 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
657 connection to be opened via `open-network-stream'. If there is already a
658 running process in that buffer, it is not restarted. Optional third arg
659 STARTFILE is the name of a file to send the contents of to the process.
661 If PROGRAM is a string, any more args are arguments to PROGRAM."
664 ;;;###autoload
666 "Run PROGRAM in a comint buffer and switch to it.
667 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
668 The file name is used to make a symbol name, such as `comint-sh-hook', and any
669 hooks on this symbol are run in the buffer.
670 See `make-comint' and `comint-exec'."
677 "Start up a process in buffer BUFFER for comint modes.
678 Blasts any old process running in the buffer. Doesn't set the buffer mode.
679 You can use this to cheaply run a series of processes in the same comint
680 buffer. The hook `comint-exec-hook' is run after each exec."
685 ;; Crank up a new process
693 ;; Jump to the end, and set the process mark.
696 ;; Feed it the startfile.
698 ;;This is guaranteed to wait long enough
699 ;;but has bad results if the comint does not prompt at all
700 ;; (while (= size (buffer-size))
701 ;; (sleep-for 1))
702 ;;I hope 1 second is enough!
710 buffer)))
712 ;; This auxiliary function cranks up the process for comint-exec in
713 ;; the appropriate environment.
718 ;; If using termcap, we specify `emacs' as the terminal type
719 ;; because that lets us specify a width.
720 ;; If using terminfo, we specify `dumb' because that is
721 ;; a defined terminal type. `emacs' is not a defined terminal type
722 ;; and there is no way for us to define it here.
723 ;; Some programs that use terminfo get very confused
724 ;; if TERM is not a valid terminal type.
725 ;; ;; There is similar code in compile.el.
732 process-environment))
735 default-directory
737 proc decoding encoding changed)
739 ;; If the command has slashes, make sure we
740 ;; first look relative to the current directory.
746 ;; If start-process decided to use some coding system for decoding
747 ;; data sent from the process and the coding system doesn't
748 ;; specify EOL conversion, we had better convert CRLF to LF.
751 changed t))
752 ;; Even if start-process left the coding system for encoding data
753 ;; sent from the process undecided, we had better use the same one
754 ;; as what we use for decoding. But, we should suppress EOL
755 ;; conversion.
758 changed t))
761 proc))
765 "In a comint buffer, set the current input to the clicked-on previous input."
769 ;; No input at POS, fall back to the global definition.
774 ;; There's previous input at POS, insert it at the end of the buffer.
776 ;; First delete any old unsent input at the end
781 ;; Insert the clicked-upon input
787 \f
788 ;; Input history processing in a buffer
789 ;; ===========================================================================
790 ;; Useful input history functions, courtesy of the Ergo group.
792 ;; Eleven commands:
793 ;; comint-dynamic-list-input-ring List history in help buffer.
794 ;; comint-previous-input Previous input...
795 ;; comint-previous-matching-input ...matching a string.
796 ;; comint-previous-matching-input-from-input ... matching the current input.
797 ;; comint-next-input Next input...
798 ;; comint-next-matching-input ...matching a string.
799 ;; comint-next-matching-input-from-input ... matching the current input.
800 ;; comint-backward-matching-input Backwards input...
801 ;; comint-forward-matching-input ...matching a string.
802 ;; comint-replace-by-expanded-history Expand history at point;
803 ;; replace with expanded history.
804 ;; comint-magic-space Expand history and insert space.
805 ;;
806 ;; Three functions:
807 ;; comint-read-input-ring Read into comint-input-ring...
808 ;; comint-write-input-ring Write to comint-input-ring-file-name.
809 ;; comint-replace-by-expanded-history-before-point Workhorse function.
812 "Sets the buffer's `comint-input-ring' from a history file.
813 The name of the file is given by the variable `comint-input-ring-file-name'.
814 The history ring is of size `comint-input-ring-size', regardless of file size.
815 If `comint-input-ring-file-name' is nil this function does nothing.
817 If the optional argument SILENT is non-nil, we say nothing about a
818 failure to read the history file.
820 This function is useful for major mode commands and mode hooks.
822 The commands stored in the history file are separated by the
823 `comint-input-ring-separator', and entries that match
824 `comint-input-history-ignore' are ignored. The most recent command
825 comes last.
827 See also `comint-input-ignoredups' and `comint-write-input-ring'."
830 nil)
834 comint-input-ring-file-name)))
847 ;; Save restriction in case file is already visited...
848 ;; Watch for those date stamps in history files!
868 comint-input-ring-index nil)))))
871 "Writes the buffer's `comint-input-ring' to a history file.
872 The name of the file is given by the variable `comint-input-ring-file-name'.
873 The original contents of the file are lost if `comint-input-ring' is not empty.
874 If `comint-input-ring-file-name' is nil this function does nothing.
876 Useful within process sentinels.
878 See also `comint-read-input-ring'."
882 nil)
890 ;; Write it all out into a buffer first. Much faster, but messier,
891 ;; than writing it one line at a time.
905 "Choose the input history entry that point is in or next to."
922 "List in help buffer the buffer's input history."
931 ;; We have to build up a list ourselves from the ring vector.
935 ;; Change "completion" to "history reference"
936 ;; to make the display accurate.
957 ;; Return list of regexp and prefix arg using PROMPT.
965 regexp)
969 ;; First make sure there is a ring and that we are after the process mark
976 ;; arg of zero resets search from beginning, and uses arg of 1
980 arg)))
983 ;; Index to start a directional search, starting at comint-input-ring-index
985 ;; If a search is running, offset by 1 in direction of arg
988 ;; For a new search, start from beginning or end, as appropriate
994 "Return the string ARG places along the input ring.
995 Moves relative to `comint-input-ring-index'."
999 arg)))
1002 "Cycle backwards through input history."
1007 "Cycle forwards through input history."
1012 "Return the string matching REGEXP ARG places along the input ring.
1013 Moves relative to `comint-input-ring-index'."
1018 "Return the index matching REGEXP ARG places along the input ring.
1019 Moves relative to START, or `comint-input-ring-index'."
1028 ;; Do the whole search as many times as the argument says.
1030 ;; Step once.
1033 ;; If we haven't reached a match, step some more.
1037 ;; If we have gone all the way around in this search.
1040 ;; Now that we know which ring element to use, if we found it, return that.
1042 n)))
1045 "Search backwards through input history for match for REGEXP.
1046 \(Previous history elements are earlier commands.)
1047 With prefix argument N, search for Nth previous match.
1048 If N is negative, find the next or Nth next match."
1052 ;; Has a match been found?
1058 ;; Can't use kill-region as it sets this-command
1065 "Search forwards through input history for match for REGEXP.
1066 \(Later history elements are more recent commands.)
1067 With prefix argument N, search for Nth following match.
1068 If N is negative, find the previous or Nth previous match."
1073 "Search backwards through input history for match for current input.
1074 \(Previous history elements are earlier commands.)
1075 With prefix argument N, search for Nth previous match.
1076 If N is negative, search forwards for the -Nth following match."
1079 comint-next-matching-input-from-input)))
1080 ;; Starting a new search
1086 comint-input-ring-index nil))
1089 arg))
1092 "Search forwards through input history for match for current input.
1093 \(Following history elements are more recent commands.)
1094 With prefix argument N, search for Nth following match.
1095 If N is negative, search backwards for the -Nth previous match."
1101 "Expand input command history references before point.
1102 Expansion is dependent on the value of `comint-input-autoexpand'.
1104 This function depends on the buffer's idea of the input history, which may not
1105 match the command interpreter's idea, assuming it has one.
1107 Assumes history syntax is like typical Un*x shells'. However, since emacs
1108 cannot know the interpreter's idea of input line numbers, assuming it has one,
1109 it cannot expand absolute input line number references.
1111 If the optional argument SILENT is non-nil, never complain
1112 even if history reference seems erroneous.
1114 If the optional argument START is non-nil, that specifies the
1115 start of the text to scan for history references, rather
1116 than the logical beginning of line.
1118 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1120 Returns t if successful."
1124 ;; Use comint-prompt-regexp
1128 ;; Use input fields. User input that hasn't been entered
1129 ;; yet, at the end of the buffer, has a nil `field' property.
1132 ;; Looks like there might be history references in the command.
1139 "Expand directory stack reference before point.
1140 See `comint-replace-by-expanded-history'. Returns t if successful.
1142 If the optional argument START is non-nil, that specifies the
1143 start of the text to scan for history references, rather
1144 than the logical beginning of line."
1152 ;; This seems a bit complex. We look for references such as !!, !-num,
1153 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1154 ;; If that wasn't enough, the plings can be suffixed with argument
1155 ;; range specifiers.
1156 ;; Argument ranges are complex too, so we hive off the input line,
1157 ;; referenced with plings, with the range string to `comint-args'.
1161 ;; The history is quoted, or we're in quotes.
1164 ;; We cannot know the interpreter's idea of input line numbers.
1168 ;; Just a number of args from `number' lines backward.
1177 t t)
1183 ;; Just a number of args from the previous input line.
1187 t t)
1191 ;; Most recent input starting with or containing (possibly
1192 ;; protected) string, maybe just a number of args. Phew.
1210 t t)
1213 ;; Quick substitution on the previous input line.
1230 "Expand input history references before point and insert ARG spaces.
1231 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1235 \f
1237 "Return t if the number of quotes between BEG and END is odd.
1238 Quotes are single and double."
1244 "Return number of matches for REGEXP from BEG to END."
1251 count))
1254 ;; From STRING, return the args depending on the range specified in the text
1255 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1256 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1272 ;; Return a list of arguments from ARG. Break it up at the
1273 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1288 comint-delimiter-argument-list)))
1291 args)))
1294 "Return from STRING the NTH to MTH arguments.
1295 NTH and/or MTH can be nil, which means the last argument.
1296 Returned arguments are separated by single spaces.
1297 We assume whitespace separates arguments, except within quotes
1298 and except for a space or tab that immediately follows a backslash.
1299 Also, a run of one or more of a single character
1300 in `comint-delimiter-argument-list' is a separate argument.
1301 Argument 0 is the command name."
1302 ;; The first line handles ordinary characters and backslash-sequences
1303 ;; (except with w32 msdos-like shells, where backslashes are valid).
1304 ;; The second matches "-quoted strings.
1305 ;; The third matches '-quoted strings.
1306 ;; The fourth matches `-quoted strings.
1307 ;; This seems to fit the syntax of BASH 2.0.
1318 beg str value quotes)
1319 ;; Build a list of all the args until we have as many as we want.
1323 ;; It's contiguous, part of the same arg.
1326 ;; It's a new separate arg.
1328 ;; Put the previous arg, if there was one, onto ARGS.
1345 \f
1346 ;;
1347 ;; Input processing stuff
1348 ;;
1350 "Add CMD to the input history.
1351 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1357 cmd))))
1361 "Send input to process.
1362 After the process output mark, sends all text from the process mark to
1363 point as input to the process. Before the process output mark, calls
1364 value of variable `comint-get-old-input' to retrieve old input, copies
1365 it to the process mark, and sends it. A terminal newline is also
1366 inserted into the buffer and sent to the process.
1368 Any history reference may be expanded depending on the value of the variable
1369 `comint-input-autoexpand'. The list of function names contained in the value
1370 of `comint-input-filter-functions' is called on the input before sending it.
1371 The input is entered into the input history ring, if the value of variable
1372 `comint-input-filter' returns non-nil when called on the input.
1374 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1375 end of line before sending the input.
1377 After the input has been sent, if `comint-process-echoes' is non-nil,
1378 then comint-send-input waits to see if the process outputs a string
1379 matching the input, and if so, deletes that part of the output.
1381 The values of `comint-get-old-input', `comint-input-filter-functions', and
1382 `comint-input-filter' are chosen according to the command interpreter running
1383 in the buffer. E.g.,
1385 If the interpreter is the csh,
1386 comint-get-old-input is the default:
1387 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1388 either return the current input field, if point is on an input
1389 field, or the current line, if point is on an output field.
1390 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1391 return the current line with any initial string matching the
1392 regexp `comint-prompt-regexp' removed.
1395 comint-input-filter is the default: returns t if the input isn't all white
1396 space.
1398 If the comint is Lucid Common Lisp,
1399 comint-get-old-input snarfs the sexp ending at point.
1400 comint-input-filter-functions does nothing.
1401 comint-input-filter returns nil if the input matches input-filter-regexp,
1402 which matches (1) all whitespace (2) :a, :c, etc.
1404 Similarly for Soar, Scheme, etc."
1406 ;; Note that the input string does not include its terminal newline.
1416 copy)))
1418 ;; Just whatever's already there
1419 intxt
1420 ;; Expand and leave it visible in buffer
1424 input
1425 ;; This is messy 'cos ultimately the original
1426 ;; functions used do insertion, rather than return
1427 ;; strings. We have to expand, then insert back.
1433 copy))))
1447 ;; Set text-properties for the input field
1449 beg end
1451 font-lock-face comint-highlight-input
1452 mouse-face highlight
1455 ;; Give old user input a field property of `input', to
1456 ;; distinguish it from both process output and unsent
1457 ;; input. The terminating newline is put into a special
1458 ;; `boundary' field to make cursor movement between input
1459 ;; and output fields smoother.
1462 ;; Cover the terminating newline
1465 field boundary
1466 inhibit-line-move-field-capture t))))
1472 ;; Update the markers before we send the input
1473 ;; in case we get output amidst sending the input.
1477 ;; clear the "accumulation" marker
1482 ;; Optionally delete echoed input (after checking it).
1485 comint-last-input-start)))
1486 ;; Wait for all input to be echoed:
1492 nil comint-last-input-start
1494 ;; Above difference is equivalent to
1495 ;; (+ comint-last-input-start
1496 ;; (- (point-max) comint-last-input-end))
1503 nil comint-last-input-start comint-last-input-end
1504 nil comint-last-input-end
1509 ;; This used to call comint-output-filter-functions,
1510 ;; but that scrolled the buffer in undesirable ways.
1514 "List of functions to call before inserting Comint output into the buffer.
1515 Each function gets one argument, a string containing the text received
1516 from the subprocess. It should return the string to insert, perhaps
1517 the same string that was received, or perhaps a modified or transformed
1518 string.
1520 The functions on the list are called sequentially, and each one is
1521 given the string returned by the previous one. The string returned by
1522 the last function is the text that is actually inserted in the
1523 redirection buffer.
1525 You can use `add-hook' to add functions to this list
1528 ;; When non-nil, this is an overlay over the last recognized prompt in
1529 ;; the buffer; it is used when highlighting the prompt.
1532 ;; `snapshot' any current comint-last-prompt-overlay, freezing its
1533 ;; attributes in place, even when more input comes a long and moves the
1534 ;; prompt overlay.
1543 "Handle carriage control characters in comint output.
1544 Translate carriage return/linefeed sequences to linefeeds.
1545 Make single carriage returns delete to the beginning of the line.
1546 Make backspaces delete the previous character.
1548 This function should be in the list `comint-output-filter-functions'."
1550 ;; We first check to see if STRING contains any magic characters, to
1551 ;; avoid overhead in the common case where it does not
1559 ;; CR LF -> LF
1560 ;; Note that this won't work properly when the CR and LF
1561 ;; are in different output chunks, but this is probably an
1562 ;; exceedingly rare case (because they are generally
1563 ;; written as a unit), and to delay interpretation of a
1564 ;; trailing CR in a chunk would result in odd interactive
1565 ;; behavior (and this case is probably far more common).
1569 ;; bare CR -> delete preceding line
1573 ;; BS -> delete preceding character
1580 ;; The purpose of using this filter for comint processes
1581 ;; is to keep comint-last-input-end from moving forward
1582 ;; when output is inserted.
1585 ;; First check for killed buffer or no input.
1588 ;; Run preoutput filters
1599 ;; Insert STRING
1601 ;; Avoid the overhead of save-excursion, since we just
1602 ;; fiddle with the point
1605 ;; The point should float after any insertion we do
1608 ;; We temporarly remove any buffer narrowing, in case the
1609 ;; process mark is outside of the restriction
1616 ;; insert-before-markers is a bad thing. XXX
1617 ;;
1618 ;; It is used here to force window-point markers (used to
1619 ;; store the value of point in non-selected windows) to
1620 ;; advance, but it also screws up any other markers that we
1621 ;; don't _want_ to advance, such as the start-marker of some
1622 ;; of the overlays we create.
1623 ;;
1624 ;; We work around the problem with the overlays by
1625 ;; explicitly adjusting them after we do the insertion, but
1626 ;; in the future this problem should be solved correctly, by
1627 ;; using `insert', and making the insertion-type of
1628 ;; window-point markers settable (via a buffer-local
1629 ;; variable). In comint buffers, this variable would be set
1630 ;; to `t', to cause point in non-select windows to advance.
1632 ;; Fixup markers and overlays that got screwed up because we
1633 ;; used `insert-before-markers'.
1635 ;; comint-last-output-start
1637 ;; comint-last-input-end
1642 ;; No overlays we create are set to advance upon insertion
1643 ;; (at the start/end), so we assume that any overlay which
1644 ;; is at the current point was incorrectly advanced by
1645 ;; insert-before-markers. First fixup overlays that might
1646 ;; start at point:
1651 old-point
1653 ;; Then do overlays that might end at point:
1658 old-point))))
1660 ;; Advance process-mark
1670 field output
1671 inhibit-line-move-field-capture t))))
1673 ;; Highlight the prompt, where we define `prompt' to mean
1674 ;; the most recent output that doesn't end with a newline.
1676 ;; Need to create or move the prompt overlay (in the case
1677 ;; where there is no prompt ((bolp) == t), we still do
1678 ;; this if there's already an existing overlay).
1681 ;; Just move an existing overlay
1684 ;; Need to create the overlay
1693 "Go to the end of buffer in all windows showing it.
1694 Movement occurs if point in the selected window is not after the process mark,
1695 and `this-command' is an insertion command. Insertion commands recognised
1696 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1697 Depends on the value of `comint-scroll-to-bottom-on-input'.
1699 This function should be a pre-command hook."
1702 hilit-yank)))
1718 nil t))))))
1721 "Go to the end of buffer in all windows showing it.
1722 Does not scroll if the current line is the last line in the buffer.
1723 Depends on the value of `comint-scroll-to-bottom-on-output' and
1724 `comint-scroll-show-maximum-output'.
1726 This function should be in the list `comint-output-filter-functions'."
1740 ;; Maybe user wants point to jump to end.
1743 ;; If point was at the end, keep it at end.
1747 ;; Optionally scroll so that the text
1748 ;; ends at the bottom of the window.
1755 nil t))
1759 "Truncate the buffer to `comint-buffer-maximum-size'.
1760 This function could be on `comint-output-filter-functions' or bound to a key."
1769 "Strip trailing `^M' characters from the current output group.
1770 This function could be on `comint-output-filter-functions' or bound to a key."
1783 "Put the end of the buffer at the bottom of the window."
1789 "Default for `comint-get-old-input'.
1790 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1791 return the current input field, if point is on an input field, or the
1792 current line, if point is on an output field.
1793 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1794 the current line with any initial string matching the regexp
1795 `comint-prompt-regexp' removed."
1803 "Insert after prompt old input at point as new input to be edited.
1804 Calls `comint-get-old-input' to get old input."
1814 "Skip past the text matching regexp `comint-prompt-regexp'.
1815 If this takes us past the end of the current line, don't skip at all."
1822 "Return t if point is after the process output marker."
1827 "Default function for sending to PROC input STRING.
1828 This just sends STRING plus a newline. To override this,
1829 set the hook `comint-input-sender'."
1837 "Returns the buffer position of the beginning of the line, after any prompt.
1838 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1839 prompt skip is done by skipping text matching the regular expression
1840 `comint-prompt-regexp', a buffer local variable."
1842 ;; Use comint-prompt-regexp
1847 ;; Use input fields. Note that, unlike the behavior of
1848 ;; `line-beginning-position' inside a field, this function will
1849 ;; return the position of the end of a prompt, even if the point is
1850 ;; already inside the prompt. In order to do this, it assumes that
1851 ;; if there are two fields on a line, then the first one is the
1852 ;; prompt, and the second one is an input field, and is front-sticky
1853 ;; (as input fields should be).
1857 "Goes to the beginning of line, then skips past the prompt, if any.
1859 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1860 prompt skip is done by skipping text matching the regular expression
1861 `comint-prompt-regexp', a buffer local variable."
1864 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1868 ;; These three functions are for entering text you don't want echoed or
1869 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1870 ;; Just enter m-x send-invisible and type in your line, or add
1871 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1874 "Read a single line of text from user without echoing, and return it.
1875 Prompt with argument PROMPT, a string. Optional argument STARS causes
1876 input to be echoed with '*' characters on the prompt line. Input ends with
1877 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1878 `inhibit-quit' is set because e.g. this function was called from a process
1879 filter and C-g is pressed, this function returns nil rather than a string).
1881 Note that the keystrokes comprising the text can still be recovered
1883 Once the caller uses the password, it can erase the password
1884 by doing (fillarray STRING 0)."
1896 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1899 ;; This function may get called from a process filter, where
1900 ;; inhibit-quit is set. In later versions of emacs read-char
1901 ;; may clear quit-flag itself and return C-g. That would make
1902 ;; it impossible to quit this loop in a simple way, so
1903 ;; re-enable it here (for backward-compatibility the check for
1904 ;; quit-flag below would still be necessary, so this seems
1905 ;; like the simplest way to do things).
1907 done t))
1921 ;; Emulate a true quit, except that we have to return a value.
1927 ans)))
1930 "Read a string without echoing.
1931 Then send it to the process running in the current buffer.
1932 The string is sent using `comint-input-sender'.
1933 Security bug: your string can still be temporarily recovered with
1949 "Prompt in the minibuffer for password and send without echoing.
1950 This function uses `send-invisible' to read and send a password to the buffer's
1951 process if STRING contains a password prompt defined by
1952 `comint-password-prompt-regexp'.
1954 This function could be in the list `comint-output-filter-functions'."
1960 \f
1961 ;; Low-level process communication
1964 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1974 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1983 \f
1984 ;; Random input hackage
1987 "Delete all output from interpreter since last input.
1988 Does not delete the prompt."
2001 ;; Output message and put back prompt
2007 "Write output from interpreter since last input to FILENAME.
2008 Any prompt at the end of the output is not written.
2010 If the optional argument APPEND (the prefix argument when interactive)
2011 is non-nil, the output is appended to the file instead.
2013 If the optional argument MUSTBENEW is non-nil, check for an existing
2014 file with the same name. If MUSTBENEW is `excl', that means to get an
2015 error if the file already exists; never overwrite. If MUSTBENEW is
2016 neither nil nor `excl', that means ask for confirmation before
2017 overwriting, but do go ahead and overwrite the file if the user
2018 confirms. When interactive, MUSTBENEW is nil when appending, and t
2019 otherwise."
2023 "Append output to file: "
2025 current-prefix-arg
2031 append nil nil mustbenew)))
2033 ;; This function exists for the benefit of the menu; from the keyboard,
2034 ;; users can just use `comint-write-output' with a prefix arg.
2036 "Append output from interpreter since last input to FILENAME.
2037 Any prompt at the end of the output is not written."
2042 "Display start of this batch of interpreter output at top of window.
2043 Sets mark to the value of point when this command is run."
2058 "Interrupt the current subjob.
2059 This command also kills the pending input
2060 between the process-mark and point."
2066 "Send kill signal to the current subjob.
2067 This command also kills the pending input
2068 between the process-mark and point."
2074 "Send quit signal to the current subjob.
2075 This command also kills the pending input
2076 between the process-mark and point."
2082 "Stop the current subjob.
2083 This command also kills the pending input
2084 between the process-mark and point.
2086 WARNING: if there is no current subjob, you can end up suspending
2087 the top-level process running in the buffer. If you accidentally do
2089 is not a problem with most shells, since they ignore this signal.)"
2095 "Send CONT signal to process buffer's process group.
2096 Useful if you accidentally suspend the top-level process."
2101 "Skip all pending input, from last stuff output by interpreter to point.
2102 This means mark it as if it had been sent as input, without sending it."
2114 "Kill all text from last stuff output by interpreter to point."
2121 "Delete ARG characters forward or send an EOF to subprocess.
2122 Sends an EOF only if point is at the end of the buffer and there is no input."
2130 "Send an EOF to the current buffer's process."
2137 "Search backward through buffer for input fields that match REGEXP.
2138 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2139 fields are identified by lines that match `comint-prompt-regexp'.
2141 With prefix argument N, search for Nth previous match.
2142 If N is negative, find the next or Nth next match."
2145 ;; Use comint-prompt-regexp
2155 ;; Use input fields
2169 "Search forward through buffer for input fields that match REGEXP.
2170 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2171 fields are identified by lines that match `comint-prompt-regexp'.
2173 With prefix argument N, search for Nth following match.
2174 If N is negative, find the previous or Nth previous match."
2180 "Move to end of Nth next prompt in the buffer.
2181 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2182 the beginning of the Nth next `input' field, otherwise, it means the Nth
2183 occurrence of text matching `comint-prompt-regexp'."
2186 ;; Use comint-prompt-regexp
2191 ;; Use input fields
2194 prev-pos)
2202 ;; Ran off the end of the buffer.
2204 ;; There's always an input field at the end of the
2205 ;; buffer, but it has a `field' property of nil.
2207 ;; stop iterating
2217 "Move to end of Nth previous prompt in the buffer.
2218 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2219 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2220 occurrence of text matching `comint-prompt-regexp'."
2224 ;; State used by `comint-insert-previous-argument' when cycling.
2230 ;; Needs fixing:
2231 ;; make comint-arguments understand negative indices as bash does
2233 "Insert the INDEXth argument from the previous comint command-line at point.
2234 Spaces are added at beginning and/or end of the inserted string if
2235 necessary to ensure that it's separated from adjacent arguments.
2236 Interactively, if no prefix argument is given, the last argument is inserted.
2237 Repeated interactive invocations will cycle through the same argument
2238 from progressively earlier commands (using the value of INDEX specified
2239 with the first command).
2240 This command is like `M-.' in bash."
2245 ;; Delete last input inserted by this command.
2249 ;; This is a non-repeat invocation, so initialize state.
2253 ;; First usage; initialize to a marker
2256 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2260 ;; Remember the beginning of what we insert, so we can delete it if
2261 ;; the command is repeated.
2263 ;; Insert the argument.
2266 ;; strip terminating '&'
2269 ;; Make next invocation return arg from previous input
2271 ;; Add a terminating space if necessary.
2275 \f
2276 ;; Support for source-file processing commands.
2277 ;;============================================================================
2278 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2279 ;; commands that process files of source text (e.g. loading or compiling
2280 ;; files). So the corresponding process-in-a-buffer modes have commands
2281 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2282 ;; for defining these commands.
2283 ;;
2284 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2285 ;; and Soar, in that they don't know anything about file extensions.
2286 ;; So the compile/load interface gets the wrong default occasionally.
2287 ;; The load-file/compile-file default mechanism could be smarter -- it
2288 ;; doesn't know about the relationship between filename extensions and
2289 ;; whether the file is source or executable. If you compile foo.lisp
2290 ;; with compile-file, then the next load-file should use foo.bin for
2291 ;; the default, not foo.lisp. This is tricky to do right, particularly
2292 ;; because the extension for executable files varies so much (.o, .bin,
2293 ;; .lbin, .mo, .vo, .ao, ...).
2296 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2297 ;; commands.
2298 ;;
2299 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2300 ;; want to save the buffer before issuing any process requests to the command
2301 ;; interpreter.
2302 ;;
2303 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2304 ;; for the file to process.
2306 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2307 ;;============================================================================
2308 ;; This function computes the defaults for the load-file and compile-file
2309 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2310 ;;
2311 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2312 ;; source-file processing command. nil if there hasn't been one yet.
2313 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2314 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2315 ;; Typically, (lisp-mode) or (scheme-mode).
2316 ;;
2317 ;; If the command is given while the cursor is inside a string, *and*
2318 ;; the string is an existing filename, *and* the filename is not a directory,
2319 ;; then the string is taken as default. This allows you to just position
2320 ;; your cursor over a string that's a filename and have it taken as default.
2321 ;;
2322 ;; If the command is given in a file buffer whose major mode is in
2323 ;; SOURCE-MODES, then the filename is the default file, and the
2324 ;; file's directory is the default directory.
2325 ;;
2326 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2327 ;; then the default directory & file are what was used in the last source-file
2328 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2329 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2330 ;; is the cwd, with no default file. (\"no default file\" = nil)
2331 ;;
2332 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2333 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2334 ;; for Soar programs, etc.
2335 ;;
2336 ;; The function returns a pair: (default-directory . default-file).
2347 ;; (COMINT-CHECK-SOURCE fname)
2348 ;;============================================================================
2349 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2350 ;; process-in-a-buffer modes), this function can be called on the filename.
2351 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2352 ;; is queried to see if he wants to save the buffer before proceeding with
2353 ;; the load or compile.
2360 ;; save BUFF.
2367 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2368 ;;============================================================================
2369 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2370 ;; commands that process source files (like loading or compiling a file).
2371 ;; It prompts for the filename, provides a default, if there is one,
2372 ;; and returns the result filename.
2373 ;;
2374 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2375 ;;
2376 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2377 ;; from the last source processing command. SOURCE-MODES is a list of major
2378 ;; modes used to determine what file buffers contain source files. (These
2379 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2380 ;; then the filename reader will only accept a file that exists.
2381 ;;
2382 ;; A typical use:
2383 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2384 ;; '(lisp-mode) t))
2386 ;; This is pretty stupid about strings. It decides we're in a string
2387 ;; if there's a quote on both sides of point on the current line.
2389 "Return string around POINT that starts the current line, or nil."
2416 prompt deffile)
2417 prompt)
2418 defdir
2420 mustmatch-p)))
2423 ;; I am somewhat divided on this string-default feature. It seems
2424 ;; to violate the principle-of-least-astonishment, in that it makes
2425 ;; the default harder to predict, so you actually have to look and see
2426 ;; what the default really is before choosing it. This can trip you up.
2427 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2428 ;; on this.
2429 ;; -Olin
2431 \f
2432 ;; Simple process query facility.
2433 ;; ===========================================================================
2434 ;; This function is for commands that want to send a query to the process
2435 ;; and show the response to the user. For example, a command to get the
2436 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2437 ;; to an inferior Common Lisp process.
2438 ;;
2439 ;; This simple facility just sends strings to the inferior process and pops
2440 ;; up a window for the process buffer so you can see what the process
2441 ;; responds with. We don't do anything fancy like try to intercept what the
2442 ;; process responds with and put it in a pop-up window or on the message
2443 ;; line. We just display the buffer. Low tech. Simple. Works good.
2445 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2446 ;; a window for the inferior process so that its response can be seen.
2456 ;; Try to position the proc window so you can see the answer.
2457 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2458 ;; I don't know why. Wizards invited to improve it.
2467 \f
2468 ;; Filename/command/history completion in a buffer
2469 ;; ===========================================================================
2470 ;; Useful completion functions, courtesy of the Ergo group.
2472 ;; Six commands:
2473 ;; comint-dynamic-complete Complete or expand command, filename,
2474 ;; history at point.
2475 ;; comint-dynamic-complete-filename Complete filename at point.
2476 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2477 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2478 ;; replace with expanded/completed name.
2479 ;; comint-dynamic-simple-complete Complete stub given candidates.
2481 ;; These are not installed in the comint-mode keymap. But they are
2482 ;; available for people who want them. Shell-mode installs them:
2483 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2484 ;; (define-key shell-mode-map "\M-?"
2485 ;; 'comint-dynamic-list-filename-completions)))
2486 ;;
2487 ;; Commands like this are fine things to put in load hooks if you
2488 ;; want them present in specific modes.
2491 "*If non-nil, automatically list possibilities on partial completion.
2492 This mirrors the optional behavior of tcsh."
2497 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2498 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2499 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2500 This mirrors the optional behavior of tcsh."
2509 "*If non-nil, use shortest completion if characters cannot be added.
2510 This mirrors the optional behavior of tcsh.
2512 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2517 "*List of suffixes to be disregarded during file completion.
2518 This mirrors the optional behavior of bash and tcsh.
2520 Note that this applies to `comint-dynamic-complete-filename' only."
2525 "Prefix prepended to absolute file names taken from process input.
2526 This is used by comint's and shell's completion functions, and by shell's
2531 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2533 "String of characters valid in a file name.
2534 Note that all non-ASCII characters are considered valid in a file name
2535 regardless of what this variable says.
2546 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2549 directory)))
2553 "Return the word of WORD-CHARS at point, or nil if non is found.
2554 Word constituents are considered to be those in WORD-CHARS, which is like the
2556 plus all non-ASCII characters."
2560 ;;(memq (char-after (point)) shell-file-name-quote-list)
2564 ;; Don't go forward over a word-char (this can happen if we're at bob).
2567 ;; Set match-data to match the entire string.
2573 "Return FILENAME with environment variables substituted.
2574 Supports additional environment variable syntax of the command
2575 interpreter (e.g., the percent notation of cmd.exe on NT)."
2579 env-var-val)
2588 name))
2591 "Return the filename at point, or nil if non is found.
2592 Environment variables are substituted. See `comint-word'."
2599 "Return FILENAME with magic characters quoted.
2600 Magic characters are those in `comint-file-name-quote-list'."
2602 filename
2609 filename))))
2612 "Return FILENAME with quoted characters unquoted."
2614 filename
2620 filename)))
2624 "Dynamically perform completion at point.
2625 Calls the functions in `comint-dynamic-complete-functions' to perform
2626 completion until a function returns non-nil, at which point completion is
2627 assumed to have occurred."
2633 "Dynamically complete the filename at point.
2634 Completes if after a filename. See `comint-match-partial-filename' and
2635 `comint-dynamic-complete-as-filename'.
2636 This function is similar to `comint-replace-by-expanded-filename', except that
2637 it won't change parts of the filename already entered in the buffer; it just
2638 adds completion characters to the end of the filename. A completions listing
2639 may be shown in a help buffer if completion is ambiguous.
2641 Completion is dependent on the value of `comint-completion-addsuffix',
2642 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2643 completions listing is dependent on the value of `comint-completion-autolist'.
2645 Returns t if successful."
2653 "Dynamically complete at point as a filename.
2654 See `comint-dynamic-complete-filename'. Returns t if successful."
2657 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2658 ;; I think it was originally bound to solve file completion problems,
2659 ;; but subsequent changes may have made this unnecessary. sm.
2660 ;;(file-name-handler-alist nil)
2695 ;; We inserted a unique completion.
2702 ;; It's not unique, but user wants shortest match.
2708 ;; It's not unique, list possible completions.
2713 success))
2717 "Dynamically expand and complete the filename at point.
2718 Replace the filename with an expanded, canonicalised and completed replacement.
2721 removed, and the filename is made absolute instead of relative. For expansion
2722 see `expand-file-name' and `substitute-in-file-name'. For completion see
2723 `comint-dynamic-complete-filename'."
2732 "Dynamically complete STUB from CANDIDATES list.
2733 This function inserts completion characters at point by completing STUB from
2734 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2735 if completion is ambiguous.
2737 Returns nil if no completion was inserted.
2738 Returns `sole' if completed with the only completion match.
2739 Returns `shortest' if completed with the shortest of the completion matches.
2740 Returns `partial' if completed as far as possible with the completion matches.
2741 Returns `listed' if a completion listing was shown.
2743 See also `comint-dynamic-complete-filename'."
2752 nil)
2763 ;; Insert the longest substring.
2768 ;; It's not unique, but user wants shortest match.
2774 ;; It's not unique, list possible completions.
2783 "List in help buffer possible completions of the filename at point."
2786 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2787 ;; I think it was originally bound to solve file completion problems,
2788 ;; but subsequent changes may have made this unnecessary. sm.
2789 ;;(file-name-handler-alist nil)
2801 ;; This is bound locally in a *Completions* buffer to the list of
2802 ;; completions displayed, and is used to detect the case where the same
2803 ;; command is repeatedly used without the set of completions changing.
2807 "List in help buffer sorted COMPLETIONS.
2808 Typing SPC flushes the help buffer."
2813 ;; The above tests are not sufficient to detect the case where we
2814 ;; should scroll, because the top-level interactive command may
2815 ;; not have displayed a completions window the last time it was
2816 ;; invoked, and there may be such a window left over from a
2817 ;; previous completion command with a different set of
2818 ;; completions. To detect that case, we also test that the set
2819 ;; of displayed completions is in fact the same as the previously
2820 ;; displayed set.
2824 ;; If this command was repeated, and
2825 ;; there's a fresh completion window with a live buffer,
2826 ;; and this command is repeated, scroll that window.
2843 completions)
2850 ;; If the user does mouse-choose-completion with the mouse,
2851 ;; execute the command, then delete the completion window.
2859 \f
2861 "After fetching a line from input history, this fetches the following line.
2862 In other words, this recalls the input line after the line you recalled last.
2863 You can use this to repeat a sequence of input lines."
2872 "Accumulate a line to send as input along with more lines.
2873 This inserts a newline so that you can enter more text
2875 to send all the accumulated input, at once.
2876 The entire accumulated text becomes one item in the input history
2877 when you send it."
2886 "Move point to the process mark.
2887 The process mark separates output, and input already sent,
2888 from input that has not yet been sent."
2897 "Move point to beginning of line (after prompt) or to the process mark.
2898 The first time you use this command, it moves to the beginning of the line
2899 \(but after the prompt, if any). If you repeat it again immediately,
2900 it moves point to the process mark.
2902 The process mark separates the process output, along with input already sent,
2903 from input that has not yet been sent. Ordinarily, the process mark
2904 is at the beginning of the current input line; but if you have
2906 the process mark is at the beginning of the accumulated input."
2913 "Set the process mark at point."
2920 \f
2921 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2923 ;; This little add-on for comint is intended to make it easy to get
2924 ;; output from currently active comint buffers into another buffer,
2925 ;; or buffers, and then go back to using the comint shell.
2926 ;;
2927 ;; My particular use is SQL interpreters; I want to be able to execute a
2928 ;; query using the process associated with a comint-buffer, and save that
2929 ;; somewhere else. Because the process might have state (for example, it
2930 ;; could be in an uncommitted transaction), just running starting a new
2931 ;; process and having it execute the query and then finish, would not
2932 ;; work. I'm sure there are other uses as well, although in many cases
2933 ;; starting a new process is the simpler, and thus preferable, approach.
2934 ;;
2935 ;; The basic implementation is as follows: comint-redirect changes the
2936 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2937 ;; its own filter. The filter puts the output into the designated buffer,
2938 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2939 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2940 ;; sees the stop regexp, it restores the old filter functions, and runs
2941 ;; comint-redirect-hook.
2942 ;;
2943 ;; Each comint buffer may only use one redirection at a time, but any number
2944 ;; of different comint buffers may be simultaneously redirected.
2945 ;;
2946 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2947 ;; correct prompt for your interpreter, or that you supply a regexp that says
2948 ;; when the redirection is finished. Otherwise, redirection will continue
2949 ;; indefinitely. The code now does a sanity check to ensure that it can find
2950 ;; a prompt in the comint buffer; however, it is still important to ensure that
2951 ;; this prompt is set correctly.
2952 ;;
2953 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2954 ;; perhaps it should prompt for a terminating string (with an
2955 ;; appropriate magic default by examining what we think is the prompt)?
2956 ;;
2958 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2959 ;; Variables
2960 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2963 "*If non-nil, print messages each time the redirection filter is invoked.
2964 Also print a message when redirection is completed."
2968 ;; Directly analagous to comint-preoutput-filter-functions
2970 "List of functions to call before inserting redirected process output.
2971 Each function gets one argument, a string containing the text received
2972 from the subprocess. It should return the string to insert, perhaps
2973 the same string that was received, or perhaps a modified or transformed
2974 string.
2976 The functions on the list are called sequentially, and each one is given
2977 the string returned by the previous one. The string returned by the
2978 last function is the text that is actually inserted in the redirection buffer.
2980 You can use `add-hook' to add functions to this list
2983 ;; Internal variables
2989 "Regular expression that determines when to stop redirection in Comint.
2990 When the redirection filter function is given output that matches this regexp,
2994 "If non-nil, the text that ends a redirection is included in it.
2995 More precisely, the text that matches `comint-redirect-finished-regexp'
2996 and therefore terminates an output redirection is inserted in the
3009 "If non-nil, check that redirection is likely to complete successfully.
3010 More precisely, before starting a redirection, verify that the
3011 regular expression `comint-redirect-finished-regexp' that controls
3012 when to terminate it actually matches some text already in the process
3013 buffer. The idea is that this regular expression should match a prompt
3014 string, and that there ought to be at least one copy of your prompt string
3018 "The process filter that was in place when redirection is started.
3019 When redirection is completed, the process filter is restored to
3022 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3023 ;; Functions
3024 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3027 comint-buffer
3028 finished-regexp
3030 "Set up for output redirection.
3031 This function sets local variables that are used by `comint-redirect-filter'
3032 to perform redirection.
3034 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3035 in the output matches FINISHED-REGEXP.
3037 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3038 original comint buffer.
3040 This function is called by `comint-redirect-send-command-to-process',
3041 and does not normally need to be invoked by the end user or programmer."
3065 "End a Comint redirection. See `comint-redirect-send-command'."
3067 ;; Restore the process filter
3069 comint-redirect-original-filter-function)
3070 ;; Restore the mode line
3072 ;; Set the completed flag
3075 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3076 ;; that it really occurs.
3080 "Filter function which redirects output from PROCESS to a buffer or buffers.
3081 The variable `comint-redirect-output-buffer' says which buffer(s) to
3082 place output in.
3084 INPUT-STRING is the input from the comint process.
3086 This function runs as a process filter, and does not need to be invoked by the
3087 end user."
3091 ;; If we have to echo output, give it to the original filter function
3093 comint-redirect-original-filter-function
3095 process input-string)))))
3099 "Comint filter function which redirects comint output to a buffer or buffers.
3100 The variable `comint-redirect-output-buffer' says which buffer(s) to
3101 place output in.
3103 INPUT-STRING is the input from the comint process.
3105 This function does not need to be invoked by the end user."
3108 comint-redirect-output-buffer
3112 ;; If there are any filter functions, give them a chance to modify the string
3116 ;; If a local value says "use the default value too",
3117 ;; do that.
3127 ;; Clobber `comint-redirect-finished-regexp'
3133 ;; Send output to all registered buffers
3137 ;; Set this buffer to the output buffer
3139 ;; Go to the end of the buffer
3141 ;; Insert the output
3143 output-buffer-list))
3145 ;; Message
3150 ;; If we see the prompt, tidy up
3151 ;; We'll look for the prompt in the original string, so nobody can
3152 ;; clobber it
3159 ;; Echo input?
3161 filtered-input-string
3164 ;;;###autoload
3166 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3167 With prefix arg, echo output in process buffer.
3169 If NO-DISPLAY is non-nil, do not show the output buffer."
3177 ;;;###autoload
3180 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3181 With prefix arg, echo output in process buffer.
3183 If NO-DISPLAY is non-nil, do not show the output buffer."
3188 process))
3190 ;; Change to the process buffer
3193 ;; Make sure there's a prompt in the current process buffer
3200 ;;;;;;;;;;;;;;;;;;;;;
3201 ;; Set up for redirection
3202 ;;;;;;;;;;;;;;;;;;;;;
3204 ;; Output Buffer
3205 output-buffer
3206 ;; Comint Buffer
3208 ;; Finished Regexp
3209 comint-prompt-regexp
3210 ;; Echo input
3211 echo)
3213 ;;;;;;;;;;;;;;;;;;;;;
3214 ;; Set the filter
3215 ;;;;;;;;;;;;;;;;;;;;;
3216 ;; Save the old filter
3221 ;;;;;;;;;;;;;;;;;;;;;
3222 ;; Send the command
3223 ;;;;;;;;;;;;;;;;;;;;;
3228 ;;;;;;;;;;;;;;;;;;;;;
3229 ;; Show the output
3230 ;;;;;;;;;;;;;;;;;;;;;
3236 output-buffer)))))))
3238 ;;;###autoload
3240 "Send COMMAND to current process.
3241 Return a list of expressions in the output which match REGEXP.
3242 REGEXP-GROUP is the regular expression group in REGEXP to use."
3245 command regexp regexp-group))
3247 ;;;###autoload
3249 "Send COMMAND to PROCESS.
3250 Return a list of expressions in the output which match REGEXP.
3251 REGEXP-GROUP is the regular expression group in REGEXP to use."
3253 results)
3258 output-buffer process nil t)
3259 ;; Wait for the process to complete
3263 ;; Collect the output
3266 ;; Skip past the command, if it was echoed
3274 results)))
3275 results)))
3280 "^Empty input ring$"
3281 "^No history$"
3285 \f
3286 ;; Converting process modes to use comint mode
3287 ;; ===========================================================================
3288 ;; The code in the Emacs 19 distribution has all been modified to use comint
3289 ;; where needed. However, there are `third-party' packages out there that
3290 ;; still use the old shell mode. Here's a guide to conversion.
3291 ;;
3292 ;; Renaming variables
3293 ;; Most of the work is renaming variables and functions. These are the common
3294 ;; ones:
3295 ;; Local variables:
3296 ;; last-input-start comint-last-input-start
3297 ;; last-input-end comint-last-input-end
3298 ;; shell-prompt-pattern comint-prompt-regexp
3299 ;; shell-set-directory-error-hook <no equivalent>
3300 ;; Miscellaneous:
3301 ;; shell-set-directory <unnecessary>
3302 ;; shell-mode-map comint-mode-map
3303 ;; Commands:
3304 ;; shell-send-input comint-send-input
3305 ;; shell-send-eof comint-delchar-or-maybe-eof
3306 ;; kill-shell-input comint-kill-input
3307 ;; interrupt-shell-subjob comint-interrupt-subjob
3308 ;; stop-shell-subjob comint-stop-subjob
3309 ;; quit-shell-subjob comint-quit-subjob
3310 ;; kill-shell-subjob comint-kill-subjob
3311 ;; kill-output-from-shell comint-delete-output
3312 ;; show-output-from-shell comint-show-output
3313 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3314 ;;
3315 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3316 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3317 ;; Comint mode does not provide functionality equivalent to
3318 ;; shell-set-directory-error-hook; it is gone.
3319 ;;
3320 ;; comint-last-input-start is provided for modes which want to munge
3321 ;; the buffer after input is sent, perhaps because the inferior
3322 ;; insists on echoing the input. The LAST-INPUT-START variable in
3323 ;; the old shell package was used to implement a history mechanism,
3324 ;; but you should think twice before using comint-last-input-start
3325 ;; for this; the input history ring often does the job better.
3326 ;;
3327 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3328 ;; *not* create the comint-mode local variables in your foo-mode function.
3329 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3330 ;; necessary comint-specific local variables. Then create the
3331 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3332 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3333 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3334 ;; get-old-input) that need to be different from the defaults. Call
3335 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3336 ;; comint-mode will take care of it. The following example, from shell.el,
3337 ;; is typical:
3338 ;;
3339 ;; (defvar shell-mode-map '())
3340 ;; (cond ((not shell-mode-map)
3341 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3342 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3343 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3344 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3345 ;; (define-key shell-mode-map "\M-?"
3346 ;; 'comint-dynamic-list-filename-completions)))
3347 ;;
3348 ;; (defun shell-mode ()
3349 ;; (interactive)
3350 ;; (comint-mode)
3351 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3352 ;; (setq major-mode 'shell-mode)
3353 ;; (setq mode-name "Shell")
3354 ;; (use-local-map shell-mode-map)
3355 ;; (make-local-variable 'shell-directory-stack)
3356 ;; (setq shell-directory-stack nil)
3357 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3358 ;; (run-hooks 'shell-mode-hook))
3359 ;;
3360 ;;
3361 ;; Completion for comint-mode users
3362 ;;
3363 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3364 ;; hook to add completion functions to. Functions on this list should return
3365 ;; non-nil if completion occurs (i.e., further completion should not occur).
3366 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3367 ;; completion job.
3368 \f
3372 ;;; comint.el ends here