| blob | 2be96265d02ef28da8515c9e19c886cd863849ac |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Adapted-by: Simon Marshall <simon@gnu.ai.mit.edu>
7 ;; Keywords: processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; Please send me bug reports, bug fixes, and extensions, so that I can
29 ;; merge them into the master source.
30 ;; - Olin Shivers (shivers@cs.cmu.edu)
31 ;; - Simon Marshall (simon@gnu.ai.mit.edu)
33 ;; This file defines a general command-interpreter-in-a-buffer package
34 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
35 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
36 ;; This way, all these specific packages share a common base functionality,
37 ;; and a common set of bindings, which makes them easier to use (and
38 ;; saves code, implementation time, etc., etc.).
40 ;; Several packages are already defined using comint mode:
41 ;; - shell.el defines a shell-in-a-buffer mode.
42 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
43 ;;
44 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
45 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
46 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
47 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
48 ;; previewers, and printers from within emacs.
49 ;; - background.el allows csh-like job control inside emacs.
50 ;; It is pretty easy to make new derived modes for other processes.
52 ;; For documentation on the functionality provided by comint mode, and
53 ;; the hooks available for customising it, see the comments below.
54 ;; For further information on the standard derived modes (shell,
55 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
57 ;; For hints on converting existing process modes (e.g., tex-mode,
58 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
59 ;; instead of shell-mode, see the notes at the end of this file.
61 \f
62 ;; Brief Command Documentation:
63 ;;============================================================================
64 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
65 ;; mode)
66 ;;
67 ;; m-p comint-previous-input Cycle backwards in input history
68 ;; m-n comint-next-input Cycle forwards
69 ;; m-r comint-previous-matching-input Previous input matching a regexp
70 ;; m-s comint-next-matching-input Next input that matches
71 ;; m-c-l comint-show-output Show last batch of process output
72 ;; return comint-send-input
73 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
74 ;; c-c c-a comint-bol Beginning of line; skip prompt
75 ;; c-c c-u comint-kill-input ^u
76 ;; c-c c-w backward-kill-word ^w
77 ;; c-c c-c comint-interrupt-subjob ^c
78 ;; c-c c-z comint-stop-subjob ^z
79 ;; c-c c-\ comint-quit-subjob ^\
80 ;; c-c c-o comint-kill-output Delete last batch of process output
81 ;; c-c c-r comint-show-output Show last batch of process output
82 ;; c-c c-l comint-dynamic-list-input-ring List input history
83 ;;
84 ;; Not bound by default in comint-mode (some are in shell mode)
85 ;; comint-run Run a program under comint-mode
86 ;; send-invisible Read a line w/o echo, and send to proc
87 ;; comint-dynamic-complete-filename Complete filename at point.
88 ;; comint-dynamic-complete-variable Complete variable name at point.
89 ;; comint-dynamic-list-filename-completions List completions in help buffer.
90 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
91 ;; replace with expanded/completed name.
92 ;; comint-replace-by-expanded-history Expand history at point;
93 ;; replace with expanded name.
94 ;; comint-magic-space Expand history and add (a) space(s).
95 ;; comint-kill-subjob No mercy.
96 ;; comint-show-maximum-output Show as much output as possible.
97 ;; comint-continue-subjob Send CONT signal to buffer's process
98 ;; group. Useful if you accidentally
99 ;; suspend your process (with C-c C-z).
101 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
103 ;;; Code:
106 \f
107 ;; Buffer Local Variables:
108 ;;============================================================================
109 ;; Comint mode buffer local variables:
110 ;; comint-prompt-regexp string comint-bol uses to match prompt
111 ;; comint-delimiter-argument-list list For delimiters and arguments
112 ;; comint-last-input-start marker Handy if inferior always echoes
113 ;; comint-last-input-end marker For comint-kill-output command
114 ;; comint-input-ring-size integer For the input history
115 ;; comint-input-ring ring mechanism
116 ;; comint-input-ring-index number ...
117 ;; comint-input-autoexpand symbol ...
118 ;; comint-input-ignoredups boolean ...
119 ;; comint-last-input-match string ...
120 ;; comint-dynamic-complete-functions hook For the completion mechanism
121 ;; comint-completion-fignore list ...
122 ;; comint-file-name-chars string ...
123 ;; comint-file-name-quote-list list ...
124 ;; comint-get-old-input function Hooks for specific
125 ;; comint-input-filter-functions hook process-in-a-buffer
126 ;; comint-output-filter-functions hook function modes.
127 ;; comint-input-filter function ...
128 ;; comint-input-sender function ...
129 ;; comint-eol-on-send boolean ...
130 ;; comint-process-echoes boolean ...
131 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
132 ;; comint-scroll-to-bottom-on-output symbol ...
133 ;; comint-scroll-show-maximum-output boolean ...
134 ;;
135 ;; Comint mode non-buffer local variables:
136 ;; comint-completion-addsuffix boolean/cons For file name
137 ;; comint-completion-autolist boolean completion behavior
138 ;; comint-completion-recexact boolean ...
141 "Regexp to recognise prompts in the inferior process.
144 Good choices:
155 "List of characters to recognise as separate arguments in input.
156 Strings comprising a character in this list will separate the arguments
157 surrounding them, and also be regarded as arguments in their own right (unlike
158 whitespace). See `comint-arguments'.
159 Defaults to the empty list.
166 "*If non-nil, expand input command history references on completion.
167 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
169 If the value is `input', then the expansion is seen on input.
170 If the value is `history', then the expansion is only when inserting
171 into the buffer's input ring. See also `comint-magic-space' and
172 `comint-dynamic-complete'.
177 "*If non-nil, don't add input matching the last on the input ring.
178 This mirrors the optional behavior of bash.
183 "*If non-nil, name of the file to read/write input history.
184 See also `comint-read-input-ring' and `comint-write-input-ring'.
189 "*Controls whether input to interpreter causes window to scroll.
190 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
191 If `this', scroll only the selected window.
193 The default is nil.
198 "*Controls whether interpreter output causes window to scroll.
199 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
200 If `this', scroll only the selected window.
201 If `others', scroll only those that are not the selected window.
203 The default is nil.
205 See variable `comint-scroll-show-maximum-output' and function
209 "*Controls how interpreter output causes window to scroll.
210 If non-nil, then show the maximum output when the window is scrolled.
212 See variable `comint-scroll-to-bottom-on-output' and function
216 "*The maximum size in lines for comint buffers.
217 Comint buffers are truncated from the top to be no greater than this number, if
224 "*If non-nil, assume that the subprocess echoes any input.
225 If so, delete one copy of the input so that only one copy eventually
226 appears in the buffer.
232 "*Regexp matching prompts for passwords in the inferior process.
235 ;; Here are the per-interpreter hooks.
237 "Function that returns old text in comint mode.
238 This function is called when return is typed while the point is in old text.
239 It returns the text to be submitted as process input. The default is
240 `comint-get-old-input-default', which grabs the current line, and strips off
245 "List of functions called to perform completion.
246 Functions should return non-nil if completion was performed.
247 See also `comint-dynamic-complete'.
253 "Predicate for filtering additions to input history.
254 Takes one argument, the input. If non-nil, the input may be saved on the input
258 "Functions to call before input is sent to the process.
259 These functions get one argument, a string containing the text to send.
264 "Functions to call after output is inserted into the buffer.
265 One possible function is `comint-postoutput-scroll-to-bottom'.
266 These functions get one argument, a string containing the text as originally
267 inserted. Note that this might not be the same as the buffer contents between
268 `comint-last-output-start' and the buffer's `process-mark', if other filter
269 functions have already modified the buffer.
274 "Function to actually send to PROCESS the STRING submitted by user.
275 Usually this is just `comint-simple-send', but if your mode needs to
276 massage the input string, put a different function here.
277 `comint-simple-send' just sends the string plus a newline.
281 "*Non-nil means go to the end of the line before sending input.
285 "Called upon entry into comint-mode
289 "Called each time a process is exec'd by `comint-exec'.
290 This is called after the process is cranked up. It is useful for things that
291 must be done each time a process is executed in a comint mode buffer (e.g.,
292 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
298 "Non-nil if communications via pty; false if by pipe. Buffer local.
322 "Major mode for interacting with an inferior interpreter.
323 Interpreter name is same as buffer name, sans the asterisks.
324 Return at end of buffer sends line as input.
325 Return not at end copies rest of line to end and sends it.
326 Setting variable `comint-eol-on-send' means jump to the end of the line
327 before submitting new input.
329 This mode is customised to create major modes such as Inferior Lisp
330 mode, Shell mode, etc. This can be done by setting the hooks
331 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
332 and `comint-get-old-input' to appropriate functions, and the variable
333 `comint-prompt-regexp' to the appropriate regular expression.
335 An input history is maintained of size `comint-input-ring-size', and
336 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
337 Input ring history expansion can be achieved with the commands
339 Input ring expansion is controlled by the variable `comint-input-autoexpand',
340 and addition is controlled by the variable `comint-input-ignoredups'.
342 Commands with no default key bindings include `send-invisible',
343 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
344 `comint-magic-space'.
346 Input to, and output from, the subprocess can cause the window to scroll to
347 the end of the buffer. See variables `comint-output-filter-functions',
348 `comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
351 to continue it.
355 Entry to this mode runs the hooks on `comint-mode-hook'."
357 ;; Do not remove this. All major modes must do this.
405 nil
406 ;; Keys:
433 ;; Menu bars:
434 ;; completion:
445 ;; Input history:
482 ;; Signals
497 ;; Put them in the menu bar:
499 menu-bar-final-items))
500 )
503 "Return t if there is a living process associated w/buffer BUFFER.
504 Living means the status is `open', `run', or `stop'.
505 BUFFER can be either a buffer or the name of one."
509 ;;;###autoload
511 "Make a comint process NAME in a buffer, running PROGRAM.
512 The name of the buffer is made by surrounding NAME with `*'s.
513 PROGRAM should be either a string denoting an executable program to create
514 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
515 connection to be opened via `open-network-stream'. If there is already a
516 running process in that buffer, it is not restarted. Optional third arg
517 STARTFILE is the name of a file to send the contents of to the process.
519 If PROGRAM is a string, any more args are arguments to PROGRAM."
523 ;; If no process, or nuked process, crank up a new one and put buffer in
524 ;; comint mode. Otherwise, leave buffer and existing process alone.
530 buffer))
532 ;;;###autoload
534 "Run PROGRAM in a comint buffer and switch to it.
535 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
536 The file name is used to make a symbol name, such as `comint-sh-hook', and any
537 hooks on this symbol are run in the buffer.
538 See `make-comint' and `comint-exec'."
545 "Start up a process in buffer BUFFER for comint modes.
546 Blasts any old process running in the buffer. Doesn't set the buffer mode.
547 You can use this to cheaply run a series of processes in the same comint
548 buffer. The hook `comint-exec-hook' is run after each exec."
553 ;; Crank up a new process
561 ;; Jump to the end, and set the process mark.
564 ;; Feed it the startfile.
566 ;;This is guaranteed to wait long enough
567 ;;but has bad results if the comint does not prompt at all
568 ;; (while (= size (buffer-size))
569 ;; (sleep-for 1))
570 ;;I hope 1 second is enough!
578 buffer)))
580 ;; This auxiliary function cranks up the process for comint-exec in
581 ;; the appropriate environment.
586 ;; If using termcap, we specify `emacs' as the terminal type
587 ;; because that lets us specify a width.
588 ;; If using terminfo, we specify `dumb' because that is
589 ;; a defined terminal type. `emacs' is not a defined terminal type
590 ;; and there is no way for us to define it here.
591 ;; Some programs that use terminfo get very confused
592 ;; if TERM is not a valid terminal type.
599 process-environment))
602 default-directory
605 \f
606 ;; Input history processing in a buffer
607 ;; ===========================================================================
608 ;; Useful input history functions, courtesy of the Ergo group.
610 ;; Eleven commands:
611 ;; comint-dynamic-list-input-ring List history in help buffer.
612 ;; comint-previous-input Previous input...
613 ;; comint-previous-matching-input ...matching a string.
614 ;; comint-previous-matching-input-from-input ... matching the current input.
615 ;; comint-next-input Next input...
616 ;; comint-next-matching-input ...matching a string.
617 ;; comint-next-matching-input-from-input ... matching the current input.
618 ;; comint-backward-matching-input Backwards input...
619 ;; comint-forward-matching-input ...matching a string.
620 ;; comint-replace-by-expanded-history Expand history at point;
621 ;; replace with expanded history.
622 ;; comint-magic-space Expand history and insert space.
623 ;;
624 ;; Three functions:
625 ;; comint-read-input-ring Read into comint-input-ring...
626 ;; comint-write-input-ring Write to comint-input-ring-file-name.
627 ;; comint-replace-by-expanded-history-before-point Workhorse function.
630 "Sets the buffer's `comint-input-ring' from a history file.
631 The name of the file is given by the variable `comint-input-ring-file-name'.
632 The history ring is of size `comint-input-ring-size', regardless of file size.
633 If `comint-input-ring-file-name' is nil this function does nothing.
635 If the optional argument SILENT is non-nil, we say nothing about a
636 failure to read the history file.
638 This function is useful for major mode commands and mode hooks.
640 The structure of the history file should be one input command per line,
641 with the most recent command last.
642 See also `comint-input-ignoredups' and `comint-write-input-ring'."
645 nil)
649 comint-input-ring-file-name)))
661 ;; Save restriction in case file is already visited...
662 ;; Watch for those date stamps in history files!
666 nil t))
676 comint-input-ring-index nil)))))
679 "Writes the buffer's `comint-input-ring' to a history file.
680 The name of the file is given by the variable `comint-input-ring-file-name'.
681 The original contents of the file are lost if `comint-input-ring' is not empty.
682 If `comint-input-ring-file-name' is nil this function does nothing.
684 Useful within process sentinels.
686 See also `comint-read-input-ring'."
690 nil)
698 ;; Write it all out into a buffer first. Much faster, but messier,
699 ;; than writing it one line at a time.
711 "List in help buffer the buffer's input history."
720 ;; We have to build up a list ourselves from the ring vector.
724 ;; Change "completion" to "history reference"
725 ;; to make the display accurate.
741 ;; Return list of regexp and prefix arg using PROMPT.
743 ;; Don't clobber this.
750 regexp)
754 ;; First make sure there is a ring and that we are after the process mark
761 ;; arg of zero resets search from beginning, and uses arg of 1
765 arg)))
768 ;; Index to start a directional search, starting at comint-input-ring-index
770 ;; If a search is running, offset by 1 in direction of arg
773 ;; For a new search, start from beginning or end, as appropriate
779 "Return the string ARG places along the input ring.
780 Moves relative to `comint-input-ring-index'."
784 arg)))
787 "Cycle backwards through input history."
792 "Cycle forwards through input history."
797 "Return the string matching REGEXP ARG places along the input ring.
798 Moves relative to `comint-input-ring-index'."
803 "Return the index matching REGEXP ARG places along the input ring.
804 Moves relative to START, or `comint-input-ring-index'."
813 ;; Do the whole search as many times as the argument says.
815 ;; Step once.
818 ;; If we haven't reached a match, step some more.
822 ;; If we have gone all the way around in this search.
825 ;; Now that we know which ring element to use, if we found it, return that.
827 n)))
830 "Search backwards through input history for match for REGEXP.
831 \(Previous history elements are earlier commands.)
832 With prefix argument N, search for Nth previous match.
833 If N is negative, find the next or Nth next match."
837 ;; Has a match been found?
843 ;; Can't use kill-region as it sets this-command
848 "Search forwards through input history for match for REGEXP.
849 \(Later history elements are more recent commands.)
850 With prefix argument N, search for Nth following match.
851 If N is negative, find the previous or Nth previous match."
856 "Search backwards through input history for match for current input.
857 \(Previous history elements are earlier commands.)
858 With prefix argument N, search for Nth previous match.
859 If N is negative, search forwards for the -Nth following match."
862 comint-next-matching-input-from-input)))
863 ;; Starting a new search
868 comint-input-ring-index nil))
871 arg))
874 "Search forwards through input history for match for current input.
875 \(Following history elements are more recent commands.)
876 With prefix argument N, search for Nth following match.
877 If N is negative, search backwards for the -Nth previous match."
883 "Expand input command history references before point.
884 Expansion is dependent on the value of `comint-input-autoexpand'.
886 This function depends on the buffer's idea of the input history, which may not
887 match the command interpreter's idea, assuming it has one.
889 Assumes history syntax is like typical Un*x shells'. However, since emacs
890 cannot know the interpreter's idea of input line numbers, assuming it has one,
891 it cannot expand absolute input line number references.
893 If the optional argument SILENT is non-nil, never complain
894 even if history reference seems erroneous.
896 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
898 Returns t if successful."
904 ;; Looks like there might be history references in the command.
912 "Expand directory stack reference before point.
913 See `comint-replace-by-expanded-history'. Returns t if successful."
924 ;; This seems a bit complex. We look for references such as !!, !-num,
925 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
926 ;; If that wasn't enough, the plings can be suffixed with argument
927 ;; range specifiers.
928 ;; Argument ranges are complex too, so we hive off the input line,
929 ;; referenced with plings, with the range string to `comint-args'.
933 ;; The history is quoted, or we're in quotes.
936 ;; We cannot know the interpreter's idea of input line numbers.
940 ;; Just a number of args from `number' lines backward.
949 t t)
955 ;; Just a number of args from the previous input line.
959 t t)
963 ;; Most recent input starting with or containing (possibly
964 ;; protected) string, maybe just a number of args. Phew.
982 t t)
985 ;; Quick substitution on the previous input line.
1002 "Expand input history references before point and insert ARG spaces.
1003 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1007 \f
1009 "Return t if the number of quotes between BEG and END is odd.
1010 Quotes are single and double."
1016 "Return number of matches for REGEXP from BEG to END."
1023 count))
1026 ;; From STRING, return the args depending on the range specified in the text
1027 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1028 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1044 ;; Return a list of arguments from ARG. Break it up at the
1045 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1060 comint-delimiter-argument-list)))
1063 args)))
1066 "Return from STRING the NTH to MTH arguments.
1067 NTH and/or MTH can be nil, which means the last argument.
1068 Returned arguments are separated by single spaces.
1069 We assume whitespace separates arguments, except within quotes.
1070 Also, a run of one or more of a single character
1071 in `comint-delimiter-argument-list' is a separate argument.
1072 Argument 0 is the command name."
1076 beg str value quotes)
1077 ;; Build a list of all the args until we have as many as we want.
1081 ;; It's contiguous, part of the same arg.
1084 ;; It's a new separate arg.
1086 ;; Put the previous arg, if there was one, onto ARGS.
1103 \f
1104 ;;
1105 ;; Input processing stuff
1106 ;;
1109 "Send input to process.
1110 After the process output mark, sends all text from the process mark to
1111 point as input to the process. Before the process output mark, calls value
1112 of variable `comint-get-old-input' to retrieve old input, copies it to the
1113 process mark, and sends it. If variable `comint-process-echoes' is nil,
1114 a terminal newline is also inserted into the buffer and sent to the process
1115 \(if it is non-nil, all text from the process mark to point is deleted,
1116 since it is assumed the remote process will re-echo it).
1118 Any history reference may be expanded depending on the value of the variable
1119 `comint-input-autoexpand'. The list of function names contained in the value
1120 of `comint-input-filter-functions' is called on the input before sending it.
1121 The input is entered into the input history ring, if the value of variable
1122 `comint-input-filter' returns non-nil when called on the input.
1124 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1125 end of line before sending the input.
1127 The values of `comint-get-old-input', `comint-input-filter-functions', and
1128 `comint-input-filter' are chosen according to the command interpreter running
1129 in the buffer. E.g.,
1131 If the interpreter is the csh,
1132 comint-get-old-input is the default: take the current line, discard any
1133 initial string matching regexp comint-prompt-regexp.
1136 comint-input-filter is the default: returns t if the input isn't all white
1137 space.
1139 If the comint is Lucid Common Lisp,
1140 comint-get-old-input snarfs the sexp ending at point.
1141 comint-input-filter-functions does nothing.
1142 comint-input-filter returns nil if the input matches input-filter-regexp,
1143 which matches (1) all whitespace (2) :a, :c, etc.
1145 Similarly for Soar, Scheme, etc."
1147 ;; Note that the input string does not include its terminal newline.
1157 copy)))
1159 ;; Just whatever's already there
1160 intxt
1161 ;; Expand and leave it visible in buffer
1165 input
1166 ;; This is messy 'cos ultimately the original
1167 ;; functions used do insertion, rather than return
1168 ;; strings. We have to expand, then insert back.
1173 copy))))
1182 history))))
1187 ;; Update the markers before we send the input
1188 ;; in case we get output amidst sending the input.
1193 ;; This used to call comint-output-filter-functions,
1194 ;; but that scrolled the buffer in undesirable ways.
1197 ;; The purpose of using this filter for comint processes
1198 ;; is to keep comint-last-input-end from moving forward
1199 ;; when output is inserted.
1201 ;; First check for killed buffer
1218 ;; Insert after old_begv, but before old_zv.
1224 ;; Don't insert initial prompt outside the top of the window.
1241 "Go to the end of buffer in all windows showing it.
1242 Movement occurs if point in the selected window is not after the process mark,
1243 and `this-command' is an insertion command. Insertion commands recognised
1244 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1245 Depends on the value of `comint-scroll-to-bottom-on-input'.
1247 This function should be a pre-command hook."
1250 hilit-yank)))
1266 nil t))))))
1269 "Go to the end of buffer in all windows showing it.
1270 Does not scroll if the current line is the last line in the buffer.
1271 Depends on the value of `comint-scroll-to-bottom-on-output' and
1272 `comint-scroll-show-maximum-output'.
1274 This function should be in the list `comint-output-filter-functions'."
1288 ;; Maybe user wants point to jump to end.
1291 ;; If point was at the end, keep it at end.
1294 ;; Optionally scroll so that the text
1295 ;; ends at the bottom of the window.
1302 nil t))
1306 "Truncate the buffer to `comint-buffer-maximum-size'.
1307 This function could be on `comint-output-filter-functions' or bound to a key."
1316 "Strip trailing `^M' characters from the current output group.
1317 This function could be on `comint-output-filter-functions' or bound to a key."
1328 "Put the end of the buffer at the bottom of the window."
1334 "Default for `comint-get-old-input'.
1335 Take the current line, and discard any initial text matching
1336 `comint-prompt-regexp'."
1345 "Insert after prompt old input at point as new input to be edited.
1346 Calls `comint-get-old-input' to get old input."
1356 "Skip past the text matching regexp `comint-prompt-regexp'.
1357 If this takes us past the end of the current line, don't skip at all."
1364 "Return t if point is after the process output marker."
1369 "Default function for sending to PROC input STRING.
1370 This just sends STRING plus a newline. To override this,
1371 set the hook `comint-input-sender'."
1376 "Goes to the beginning of line, then skips past the prompt, if any.
1379 The prompt skip is done by skipping text matching the regular expression
1380 `comint-prompt-regexp', a buffer local variable."
1385 ;; These three functions are for entering text you don't want echoed or
1386 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1387 ;; Just enter m-x send-invisible and type in your line, or add
1388 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1391 "Read a single line of text from user without echoing, and return it.
1392 Prompt with argument PROMPT, a string. Optional argument STARS causes
1393 input to be echoed with '*' characters on the prompt line. Input ends with
1394 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1395 `inhibit-quit' is set because e.g. this function was called from a process
1396 filter and C-g is pressed, this function returns nil rather than a string).
1398 Note that the keystrokes comprising the text can still be recovered
1400 Once the caller uses the password, it can erase the password
1401 by doing (fillarray STRING 0)."
1413 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1416 ;; This function may get called from a process filter, where
1417 ;; inhibit-quit is set. In later versions of emacs read-char
1418 ;; may clear quit-flag itself and return C-g. That would make
1419 ;; it impossible to quit this loop in a simple way, so
1420 ;; re-enable it here (for backward-compatibility the check for
1421 ;; quit-flag below would still be necessary, so this seems
1422 ;; like the simplest way to do things).
1424 done t))
1438 ;; Emulate a true quit, except that we have to return a value.
1444 ans)))
1447 "Read a string without echoing.
1448 Then send it to the process running in the current buffer.
1449 The string is sent using `comint-input-sender'.
1450 Security bug: your string can still be temporarily recovered with
1465 "Prompt in the minibuffer for password and send without echoing.
1466 This function uses `send-invisible' to read and send a password to the buffer's
1467 process if STRING contains a password prompt defined by
1468 `comint-password-prompt-regexp'.
1470 This function could be in the list `comint-output-filter-functions'."
1473 \f
1474 ;; Low-level process communication
1478 \f
1479 ;; Random input hackage
1482 "Kill all output from interpreter since last input.
1483 Does not delete the prompt."
1496 ;; Output message and put back prompt
1500 "Display start of this batch of interpreter output at top of window.
1501 Sets mark to the value of point when this command is run."
1511 "Interrupt the current subjob."
1516 "Send kill signal to the current subjob."
1521 "Send quit signal to the current subjob."
1526 "Stop the current subjob.
1527 WARNING: if there is no current subjob, you can end up suspending
1528 the top-level process running in the buffer. If you accidentally do
1530 is not a problem with most shells, since they ignore this signal.)"
1535 "Send CONT signal to process buffer's process group.
1536 Useful if you accidentally suspend the top-level process."
1541 "Kill all text from last stuff output by interpreter to point."
1548 "Delete ARG characters forward or send an EOF to subprocess.
1549 Sends an EOF only if point is at the end of the buffer and there is no input."
1557 "Send an EOF to the current buffer's process."
1563 "Search backward through buffer for match for REGEXP.
1564 Matches are searched for on lines that match `comint-prompt-regexp'.
1565 With prefix argument N, search for Nth previous match.
1566 If N is negative, find the next or Nth next match."
1579 "Search forward through buffer for match for REGEXP.
1580 Matches are searched for on lines that match `comint-prompt-regexp'.
1581 With prefix argument N, search for Nth following match.
1582 If N is negative, find the previous or Nth previous match."
1588 "Move to end of Nth next prompt in the buffer.
1589 See `comint-prompt-regexp'."
1597 "Move to end of Nth previous prompt in the buffer.
1598 See `comint-prompt-regexp'."
1601 \f
1602 ;; Support for source-file processing commands.
1603 ;;============================================================================
1604 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1605 ;; commands that process files of source text (e.g. loading or compiling
1606 ;; files). So the corresponding process-in-a-buffer modes have commands
1607 ;; for doing this (e.g., lisp-load-file). The functions below are useful
1608 ;; for defining these commands.
1609 ;;
1610 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1611 ;; and Soar, in that they don't know anything about file extensions.
1612 ;; So the compile/load interface gets the wrong default occasionally.
1613 ;; The load-file/compile-file default mechanism could be smarter -- it
1614 ;; doesn't know about the relationship between filename extensions and
1615 ;; whether the file is source or executable. If you compile foo.lisp
1616 ;; with compile-file, then the next load-file should use foo.bin for
1617 ;; the default, not foo.lisp. This is tricky to do right, particularly
1618 ;; because the extension for executable files varies so much (.o, .bin,
1619 ;; .lbin, .mo, .vo, .ao, ...).
1622 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1623 ;; commands.
1624 ;;
1625 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1626 ;; want to save the buffer before issuing any process requests to the command
1627 ;; interpreter.
1628 ;;
1629 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1630 ;; for the file to process.
1632 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1633 ;;============================================================================
1634 ;; This function computes the defaults for the load-file and compile-file
1635 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
1636 ;;
1637 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1638 ;; source-file processing command. NIL if there hasn't been one yet.
1639 ;; - SOURCE-MODES is a list used to determine what buffers contain source
1640 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1641 ;; Typically, (lisp-mode) or (scheme-mode).
1642 ;;
1643 ;; If the command is given while the cursor is inside a string, *and*
1644 ;; the string is an existing filename, *and* the filename is not a directory,
1645 ;; then the string is taken as default. This allows you to just position
1646 ;; your cursor over a string that's a filename and have it taken as default.
1647 ;;
1648 ;; If the command is given in a file buffer whose major mode is in
1649 ;; SOURCE-MODES, then the the filename is the default file, and the
1650 ;; file's directory is the default directory.
1651 ;;
1652 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1653 ;; then the default directory & file are what was used in the last source-file
1654 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1655 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1656 ;; is the cwd, with no default file. (\"no default file\" = nil)
1657 ;;
1658 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1659 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1660 ;; for Soar programs, etc.
1661 ;;
1662 ;; The function returns a pair: (default-directory . default-file).
1673 ;; (COMINT-CHECK-SOURCE fname)
1674 ;;============================================================================
1675 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1676 ;; process-in-a-buffer modes), this function can be called on the filename.
1677 ;; If the file is loaded into a buffer, and the buffer is modified, the user
1678 ;; is queried to see if he wants to save the buffer before proceeding with
1679 ;; the load or compile.
1686 ;; save BUFF.
1693 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1694 ;;============================================================================
1695 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1696 ;; commands that process source files (like loading or compiling a file).
1697 ;; It prompts for the filename, provides a default, if there is one,
1698 ;; and returns the result filename.
1699 ;;
1700 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1701 ;;
1702 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1703 ;; from the last source processing command. SOURCE-MODES is a list of major
1704 ;; modes used to determine what file buffers contain source files. (These
1705 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1706 ;; then the filename reader will only accept a file that exists.
1707 ;;
1708 ;; A typical use:
1709 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1710 ;; '(lisp-mode) t))
1712 ;; This is pretty stupid about strings. It decides we're in a string
1713 ;; if there's a quote on both sides of point on the current line.
1715 "Return string around POINT that starts the current line, or nil."
1742 prompt deffile)
1743 prompt)
1744 defdir
1746 mustmatch-p)))
1749 ;; I am somewhat divided on this string-default feature. It seems
1750 ;; to violate the principle-of-least-astonishment, in that it makes
1751 ;; the default harder to predict, so you actually have to look and see
1752 ;; what the default really is before choosing it. This can trip you up.
1753 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
1754 ;; on this.
1755 ;; -Olin
1757 \f
1758 ;; Simple process query facility.
1759 ;; ===========================================================================
1760 ;; This function is for commands that want to send a query to the process
1761 ;; and show the response to the user. For example, a command to get the
1762 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1763 ;; to an inferior Common Lisp process.
1764 ;;
1765 ;; This simple facility just sends strings to the inferior process and pops
1766 ;; up a window for the process buffer so you can see what the process
1767 ;; responds with. We don't do anything fancy like try to intercept what the
1768 ;; process responds with and put it in a pop-up window or on the message
1769 ;; line. We just display the buffer. Low tech. Simple. Works good.
1771 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
1772 ;; a window for the inferior process so that its response can be seen.
1782 ;; Try to position the proc window so you can see the answer.
1783 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1784 ;; I don't know why. Wizards invited to improve it.
1793 \f
1794 ;; Filename/command/history completion in a buffer
1795 ;; ===========================================================================
1796 ;; Useful completion functions, courtesy of the Ergo group.
1798 ;; Six commands:
1799 ;; comint-dynamic-complete Complete or expand command, filename,
1800 ;; history at point.
1801 ;; comint-dynamic-complete-filename Complete filename at point.
1802 ;; comint-dynamic-list-filename-completions List completions in help buffer.
1803 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
1804 ;; replace with expanded/completed name.
1805 ;; comint-dynamic-simple-complete Complete stub given candidates.
1807 ;; These are not installed in the comint-mode keymap. But they are
1808 ;; available for people who want them. Shell-mode installs them:
1809 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1810 ;; (define-key shell-mode-map "\M-?"
1811 ;; 'comint-dynamic-list-filename-completions)))
1812 ;;
1813 ;; Commands like this are fine things to put in load hooks if you
1814 ;; want them present in specific modes.
1817 "*If non-nil, automatically list possibilities on partial completion.
1821 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1822 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
1823 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
1827 "*If non-nil, use shortest completion if characters cannot be added.
1828 This mirrors the optional behavior of tcsh.
1833 "*List of suffixes to be disregarded during file completion.
1834 This mirrors the optional behavior of bash and tcsh.
1839 "Prefix prepended to absolute file names taken from process input.
1840 This is used by comint's and shell's completion functions, and by shell's
1845 "~/A-Za-z0-9_^$!#%&{}@`'.()-"
1847 "String of characters valid in a file name.
1858 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1861 directory)))
1865 "Return the word of WORD-CHARS at point, or nil if non is found.
1866 Word constituents are considered to be those in WORD-CHARS, which is like the
1871 ;(memq (char-after (point)) shell-file-name-quote-list)
1874 ;; Don't go forward over a word-char (this can happen if we're at bob).
1877 ;; Set match-data to match the entire string.
1883 "Return FILENAME with environment variables substituted.
1884 Supports additional environment variable syntax of the command
1885 interpreter (e.g., the percent notation of cmd.exe on NT)."
1889 env-var-val)
1898 name))
1901 "Return the filename at point, or nil if non is found.
1902 Environment variables are substituted. See `comint-word'."
1909 "Return FILENAME with magic characters quoted.
1910 Magic characters are those in `comint-file-name-quote-list'."
1912 filename
1919 filename))))
1922 "Return FILENAME with quoted characters unquoted."
1924 filename
1930 filename)))
1934 "Dynamically perform completion at point.
1935 Calls the functions in `comint-dynamic-complete-functions' to perform
1936 completion until a function returns non-nil, at which point completion is
1937 assumed to have occurred."
1943 "Dynamically complete the filename at point.
1944 Completes if after a filename. See `comint-match-partial-filename' and
1945 `comint-dynamic-complete-as-filename'.
1946 This function is similar to `comint-replace-by-expanded-filename', except that
1947 it won't change parts of the filename already entered in the buffer; it just
1948 adds completion characters to the end of the filename. A completions listing
1949 may be shown in a help buffer if completion is ambiguous.
1951 Completion is dependent on the value of `comint-completion-addsuffix',
1952 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
1953 completions listing is dependent on the value of `comint-completion-autolist'.
1955 Returns t if successful."
1959 ?\\
1960 ?/)))
1966 "Dynamically complete at point as a filename.
1967 See `comint-dynamic-complete-filename'. Returns t if successful."
1970 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
1971 ;; I think it was originally bound to solve file completion problems,
1972 ;; but subsequent changes may have made this unnecessary. sm.
1973 ;;(file-name-handler-alist nil)
2001 ;; We inserted a unique completion.
2007 ;; It's not unique, but user wants shortest match.
2012 ;; It's not unique, list possible completions.
2016 success))
2020 "Dynamically expand and complete the filename at point.
2021 Replace the filename with an expanded, canonicalised and completed replacement.
2024 removed, and the filename is made absolute instead of relative. For expansion
2025 see `expand-file-name' and `substitute-in-file-name'. For completion see
2026 `comint-dynamic-complete-filename'."
2033 "Dynamically complete STUB from CANDIDATES list.
2034 This function inserts completion characters at point by completing STUB from
2035 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2036 if completion is ambiguous.
2038 Returns nil if no completion was inserted.
2039 Returns `sole' if completed with the only completion match.
2040 Returns `shortest' if completed with the shortest of the completion matches.
2041 Returns `partial' if completed as far as possible with the completion matches.
2042 Returns `listed' if a completion listing was shown.
2044 See also `comint-dynamic-complete-filename'."
2053 nil)
2064 ;; Insert the longest substring.
2069 ;; It's not unique, but user wants shortest match.
2075 ;; It's not unique, list possible completions.
2084 "List in help buffer possible completions of the filename at point."
2087 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2088 ;; I think it was originally bound to solve file completion problems,
2089 ;; but subsequent changes may have made this unnecessary. sm.
2090 ;;(file-name-handler-alist nil)
2103 "List in help buffer sorted COMPLETIONS.
2104 Typing SPC flushes the help buffer."
2118 ;; If the user does mouse-choose-completion with the mouse,
2119 ;; execute the command, then delete the completion window.
2126 \f
2127 ;; Converting process modes to use comint mode
2128 ;; ===========================================================================
2129 ;; The code in the Emacs 19 distribution has all been modified to use comint
2130 ;; where needed. However, there are `third-party' packages out there that
2131 ;; still use the old shell mode. Here's a guide to conversion.
2132 ;;
2133 ;; Renaming variables
2134 ;; Most of the work is renaming variables and functions. These are the common
2135 ;; ones:
2136 ;; Local variables:
2137 ;; last-input-start comint-last-input-start
2138 ;; last-input-end comint-last-input-end
2139 ;; shell-prompt-pattern comint-prompt-regexp
2140 ;; shell-set-directory-error-hook <no equivalent>
2141 ;; Miscellaneous:
2142 ;; shell-set-directory <unnecessary>
2143 ;; shell-mode-map comint-mode-map
2144 ;; Commands:
2145 ;; shell-send-input comint-send-input
2146 ;; shell-send-eof comint-delchar-or-maybe-eof
2147 ;; kill-shell-input comint-kill-input
2148 ;; interrupt-shell-subjob comint-interrupt-subjob
2149 ;; stop-shell-subjob comint-stop-subjob
2150 ;; quit-shell-subjob comint-quit-subjob
2151 ;; kill-shell-subjob comint-kill-subjob
2152 ;; kill-output-from-shell comint-kill-output
2153 ;; show-output-from-shell comint-show-output
2154 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
2155 ;;
2156 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2157 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2158 ;; Comint mode does not provide functionality equivalent to
2159 ;; shell-set-directory-error-hook; it is gone.
2160 ;;
2161 ;; comint-last-input-start is provided for modes which want to munge
2162 ;; the buffer after input is sent, perhaps because the inferior
2163 ;; insists on echoing the input. The LAST-INPUT-START variable in
2164 ;; the old shell package was used to implement a history mechanism,
2165 ;; but you should think twice before using comint-last-input-start
2166 ;; for this; the input history ring often does the job better.
2167 ;;
2168 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2169 ;; *not* create the comint-mode local variables in your foo-mode function.
2170 ;; This is not modular. Instead, call comint-mode, and let *it* create the
2171 ;; necessary comint-specific local variables. Then create the
2172 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2173 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2174 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2175 ;; get-old-input) that need to be different from the defaults. Call
2176 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2177 ;; comint-mode will take care of it. The following example, from shell.el,
2178 ;; is typical:
2179 ;;
2180 ;; (defvar shell-mode-map '())
2181 ;; (cond ((not shell-mode-map)
2182 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
2183 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2184 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2185 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2186 ;; (define-key shell-mode-map "\M-?"
2187 ;; 'comint-dynamic-list-filename-completions)))
2188 ;;
2189 ;; (defun shell-mode ()
2190 ;; (interactive)
2191 ;; (comint-mode)
2192 ;; (setq comint-prompt-regexp shell-prompt-pattern)
2193 ;; (setq major-mode 'shell-mode)
2194 ;; (setq mode-name "Shell")
2195 ;; (use-local-map shell-mode-map)
2196 ;; (make-local-variable 'shell-directory-stack)
2197 ;; (setq shell-directory-stack nil)
2198 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2199 ;; (run-hooks 'shell-mode-hook))
2200 ;;
2201 ;;
2202 ;; Completion for comint-mode users
2203 ;;
2204 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2205 ;; hook to add completion functions to. Functions on this list should return
2206 ;; non-nil if completion occurs (i.e., further completion should not occur).
2207 ;; You could use comint-dynamic-simple-complete to do the bulk of the
2208 ;; completion job.
2209 \f
2212 ;; comint.el ends here