| blob | 2083b18e32685e92d9a23b082dc92de274ac7e97 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95 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
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;;; Commentary:
27 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
28 ;;; merge them into the master source.
29 ;;; - Olin Shivers (shivers@cs.cmu.edu)
30 ;;; - Simon Marshall (simon@gnu.ai.mit.edu)
32 ;;; This file defines a general command-interpreter-in-a-buffer package
33 ;;; (comint mode). The idea is that you can build specific process-in-a-buffer
34 ;;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
35 ;;; This way, all these specific packages share a common base functionality,
36 ;;; and a common set of bindings, which makes them easier to use (and
37 ;;; saves code, implementation time, etc., etc.).
39 ;;; Several packages are already defined using comint mode:
40 ;;; - shell.el defines a shell-in-a-buffer mode.
41 ;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
42 ;;;
43 ;;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
44 ;;; - The file tea.el tunes scheme and inferior-scheme modes for T.
45 ;;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
46 ;;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
47 ;;; previewers, and printers from within emacs.
48 ;;; - background.el allows csh-like job control inside emacs.
49 ;;; It is pretty easy to make new derived modes for other processes.
51 ;;; For documentation on the functionality provided by comint mode, and
52 ;;; the hooks available for customising it, see the comments below.
53 ;;; For further information on the standard derived modes (shell,
54 ;;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
56 ;;; For hints on converting existing process modes (e.g., tex-mode,
57 ;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
58 ;;; instead of shell-mode, see the notes at the end of this file.
60 \f
61 ;;; Brief Command Documentation:
62 ;;;============================================================================
63 ;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
64 ;;; mode)
65 ;;;
66 ;;; m-p comint-previous-input Cycle backwards in input history
67 ;;; m-n comint-next-input Cycle forwards
68 ;;; m-r comint-previous-matching-input Previous input matching a regexp
69 ;;; m-s comint-next-matching-input Next input that matches
70 ;;; m-c-l comint-show-output Show last batch of process output
71 ;;; return comint-send-input
72 ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
73 ;;; c-c c-a comint-bol Beginning of line; skip prompt
74 ;;; c-c c-u comint-kill-input ^u
75 ;;; c-c c-w backward-kill-word ^w
76 ;;; c-c c-c comint-interrupt-subjob ^c
77 ;;; c-c c-z comint-stop-subjob ^z
78 ;;; c-c c-\ comint-quit-subjob ^\
79 ;;; c-c c-o comint-kill-output Delete last batch of process output
80 ;;; c-c c-r comint-show-output Show last batch of process output
81 ;;; c-c c-l comint-dynamic-list-input-ring List input history
82 ;;;
83 ;;; Not bound by default in comint-mode (some are in shell mode)
84 ;;; comint-run Run a program under comint-mode
85 ;;; send-invisible Read a line w/o echo, and send to proc
86 ;;; comint-dynamic-complete-filename Complete filename at point.
87 ;;; comint-dynamic-complete-variable Complete variable name at point.
88 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
89 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
90 ;;; replace with expanded/completed name.
91 ;;; comint-replace-by-expanded-history Expand history at point;
92 ;;; replace with expanded name.
93 ;;; comint-magic-space Expand history and add (a) space(s).
94 ;;; comint-kill-subjob No mercy.
95 ;;; comint-show-maximum-output Show as much output as possible.
96 ;;; comint-continue-subjob Send CONT signal to buffer's process
97 ;;; group. Useful if you accidentally
98 ;;; suspend your process (with C-c C-z).
100 ;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
102 ;;; Code:
105 \f
106 ;;; Buffer Local Variables:
107 ;;;============================================================================
108 ;;; Comint mode buffer local variables:
109 ;;; comint-prompt-regexp - string comint-bol uses to match prompt
110 ;;; comint-delimiter-argument-list - list For delimiters and arguments
111 ;;; comint-last-input-start - marker Handy if inferior always echoes
112 ;;; comint-last-input-end - marker For comint-kill-output command
113 ;;; comint-input-ring-size - integer For the input history
114 ;;; comint-input-ring - ring mechanism
115 ;;; comint-input-ring-index - number ...
116 ;;; comint-input-autoexpand - symbol ...
117 ;;; comint-input-ignoredups - boolean ...
118 ;;; comint-last-input-match - string ...
119 ;;; comint-dynamic-complete-functions - hook For the completion mechanism
120 ;;; comint-completion-fignore - list ...
121 ;;; comint-file-name-quote-list - list ...
122 ;;; comint-get-old-input - function Hooks for specific
123 ;;; comint-input-filter-functions - hook process-in-a-buffer
124 ;;; comint-output-filter-functions - hook function modes.
125 ;;; comint-input-filter - function ...
126 ;;; comint-input-sender - function ...
127 ;;; comint-eol-on-send - boolean ...
128 ;;; comint-process-echoes - boolean ...
129 ;;; comint-scroll-to-bottom-on-input - symbol For scroll behavior
130 ;;; comint-scroll-to-bottom-on-output - symbol ...
131 ;;; comint-scroll-show-maximum-output - boolean...
132 ;;;
133 ;;; Comint mode non-buffer local variables:
134 ;;; comint-completion-addsuffix - boolean/cons For file name completion
135 ;;; comint-completion-autolist - boolean behavior
136 ;;; comint-completion-recexact - boolean ...
139 "Regexp to recognise prompts in the inferior process.
142 Good choices:
153 "List of characters to recognise as separate arguments in input.
154 Strings comprising a character in this list will separate the arguments
155 surrounding them, and also be regarded as arguments in their own right (unlike
156 whitespace). See `comint-arguments'.
157 Defaults to the empty list.
164 "*If non-nil, expand input command history references on completion.
165 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
167 If the value is `input', then the expansion is seen on input.
168 If the value is `history', then the expansion is only when inserting
169 into the buffer's input ring. See also `comint-magic-space' and
170 `comint-dynamic-complete'.
175 "*If non-nil, don't add input matching the last on the input ring.
176 This mirrors the optional behavior of bash.
181 "*If non-nil, name of the file to read/write input history.
182 See also `comint-read-input-ring' and `comint-write-input-ring'.
187 "*Controls whether input to interpreter causes window to scroll.
188 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
189 If `this', scroll only the selected window.
191 The default is nil.
196 "*Controls whether interpreter output causes window to scroll.
197 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
198 If `this', scroll only the selected window.
199 If `others', scroll only those that are not the selected window.
201 The default is nil.
203 See variable `comint-scroll-show-maximum-output' and function
207 "*Controls how interpreter output causes window to scroll.
208 If non-nil, then show the maximum output when the window is scrolled.
210 See variable `comint-scroll-to-bottom-on-output' and function
214 "*The maximum size in lines for comint buffers.
215 Comint buffers are truncated from the top to be no greater than this number, if
222 "*If non-nil, assume that the subprocess echoes any input.
223 If so, delete one copy of the input so that only one copy eventually
224 appears in the buffer.
230 "*Regexp matching prompts for passwords in the inferior process.
233 ;;; Here are the per-interpreter hooks.
235 "Function that returns old text in comint mode.
236 This function is called when return is typed while the point is in old text.
237 It returns the text to be submitted as process input. The default is
238 `comint-get-old-input-default', which grabs the current line, and strips off
243 "List of functions called to perform completion.
244 Functions should return non-nil if completion was performed.
245 See also `comint-dynamic-complete'.
251 "Predicate for filtering additions to input history.
252 Takes one argument, the input. If non-nil, the input may be saved on the input
256 "Functions to call before input is sent to the process.
257 These functions get one argument, a string containing the text to send.
262 "Functions to call after output is inserted into the buffer.
263 One possible function is `comint-postoutput-scroll-to-bottom'.
264 These functions get one argument, a string containing the text just inserted.
269 "Function to actually send to PROCESS the STRING submitted by user.
270 Usually this is just `comint-simple-send', but if your mode needs to
271 massage the input string, put a different function here.
272 `comint-simple-send' just sends the string plus a newline.
276 "*Non-nil means go to the end of the line before sending input.
280 "Called upon entry into comint-mode
284 "Called each time a process is exec'd by `comint-exec'.
285 This is called after the process is cranked up. It is useful for things that
286 must be done each time a process is executed in a comint mode buffer (e.g.,
287 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
293 "Non-nil if communications via pty; false if by pipe. Buffer local.
317 "Major mode for interacting with an inferior interpreter.
318 Interpreter name is same as buffer name, sans the asterisks.
319 Return at end of buffer sends line as input.
320 Return not at end copies rest of line to end and sends it.
321 Setting variable `comint-eol-on-send' means jump to the end of the line
322 before submitting new input.
324 This mode is customised to create major modes such as Inferior Lisp
325 mode, Shell mode, etc. This can be done by setting the hooks
326 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
327 and `comint-get-old-input' to appropriate functions, and the variable
328 `comint-prompt-regexp' to the appropriate regular expression.
330 An input history is maintained of size `comint-input-ring-size', and
331 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
332 Input ring history expansion can be achieved with the commands
334 Input ring expansion is controlled by the variable `comint-input-autoexpand',
335 and addition is controlled by the variable `comint-input-ignoredups'.
337 Commands with no default key bindings include `send-invisible',
338 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
339 `comint-magic-space'.
341 Input to, and output from, the subprocess can cause the window to scroll to
342 the end of the buffer. See variables `comint-output-filter-functions',
343 `comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
346 to continue it.
350 Entry to this mode runs the hooks on `comint-mode-hook'."
352 ;; Do not remove this. All major modes must do this.
399 nil
400 ;; Keys:
427 ;; Menu bars:
428 ;; completion:
439 ;; Input history:
476 ;; Signals
491 ;; Put them in the menu bar:
493 menu-bar-final-items))
494 )
497 "Return t if there is a living process associated w/buffer BUFFER.
498 Living means the status is `open', `run', or `stop'.
499 BUFFER can be either a buffer or the name of one."
503 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
504 ;;; for the second argument (program).
505 ;;;###autoload
507 "Make a comint process NAME in a buffer, running PROGRAM.
508 The name of the buffer is made by surrounding NAME with `*'s.
509 PROGRAM should be either a string denoting an executable program to create
510 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
511 connection to be opened via `open-network-stream'. If there is already a
512 running process in that buffer, it is not restarted. Optional third arg
513 STARTFILE is the name of a file to send the contents of to the process.
515 If PROGRAM is a string, any more args are arguments to PROGRAM."
519 ;; If no process, or nuked process, crank up a new one and put buffer in
520 ;; comint mode. Otherwise, leave buffer and existing process alone.
526 buffer))
528 ;;;###autoload
530 "Run PROGRAM in a comint buffer and switch to it.
531 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
532 The file name is used to make a symbol name, such as `comint-sh-hook', and any
533 hooks on this symbol are run in the buffer.
534 See `make-comint' and `comint-exec'."
541 "Start up a process in buffer BUFFER for comint modes.
542 Blasts any old process running in the buffer. Doesn't set the buffer mode.
543 You can use this to cheaply run a series of processes in the same comint
544 buffer. The hook `comint-exec-hook' is run after each exec."
549 ;; Crank up a new process
557 ;; Jump to the end, and set the process mark.
560 ;; Feed it the startfile.
562 ;;This is guaranteed to wait long enough
563 ;;but has bad results if the comint does not prompt at all
564 ;; (while (= size (buffer-size))
565 ;; (sleep-for 1))
566 ;;I hope 1 second is enough!
574 buffer)))
576 ;;; This auxiliary function cranks up the process for comint-exec in
577 ;;; the appropriate environment.
582 ;; If using termcap, we specify `emacs' as the terminal type
583 ;; because that lets us specify a width.
584 ;; If using terminfo, we specify `unknown' because that is
585 ;; a defined terminal type. `emacs' is not a defined terminal type
586 ;; and there is no way for us to define it here.
587 ;; Some programs that use terminfo get very confused
588 ;; if TERM is not a valid terminal type.
594 process-environment))
597 default-directory
600 \f
601 ;;; Input history processing in a buffer
602 ;;; ===========================================================================
603 ;;; Useful input history functions, courtesy of the Ergo group.
605 ;;; Eleven commands:
606 ;;; comint-dynamic-list-input-ring List history in help buffer.
607 ;;; comint-previous-input Previous input...
608 ;;; comint-previous-matching-input ...matching a string.
609 ;;; comint-previous-matching-input-from-input ... matching the current input.
610 ;;; comint-next-input Next input...
611 ;;; comint-next-matching-input ...matching a string.
612 ;;; comint-next-matching-input-from-input ... matching the current input.
613 ;;; comint-backward-matching-input Backwards input...
614 ;;; comint-forward-matching-input ...matching a string.
615 ;;; comint-replace-by-expanded-history Expand history at point;
616 ;;; replace with expanded history.
617 ;;; comint-magic-space Expand history and insert space.
618 ;;;
619 ;;; Three functions:
620 ;;; comint-read-input-ring Read into comint-input-ring...
621 ;;; comint-write-input-ring Write to comint-input-ring-file-name.
622 ;;; comint-replace-by-expanded-history-before-point Workhorse function.
625 "Sets the buffer's `comint-input-ring' from a history file.
626 The name of the file is given by the variable `comint-input-ring-file-name'.
627 The history ring is of size `comint-input-ring-size', regardless of file size.
628 If `comint-input-ring-file-name' is nil this function does nothing.
630 If the optional argument SILENT is non-nil, we say nothing about a
631 failure to read the history file.
633 This function is useful for major mode commands and mode hooks.
635 The structure of the history file should be one input command per line,
636 with the most recent command last.
637 See also `comint-input-ignoredups' and `comint-write-input-ring'."
640 nil)
644 comint-input-ring-file-name)))
656 ;; Save restriction in case file is already visited...
657 ;; Watch for those date stamps in history files!
661 nil t))
671 comint-input-ring-index nil)))))
674 "Writes the buffer's `comint-input-ring' to a history file.
675 The name of the file is given by the variable `comint-input-ring-file-name'.
676 The original contents of the file are lost if `comint-input-ring' is not empty.
677 If `comint-input-ring-file-name' is nil this function does nothing.
679 Useful within process sentinels.
681 See also `comint-read-input-ring'."
685 nil)
693 ;; Write it all out into a buffer first. Much faster, but messier,
694 ;; than writing it one line at a time.
706 "List in help buffer the buffer's input history."
715 ;; We have to build up a list ourselves from the ring vector.
719 ;; Change "completion" to "history reference"
720 ;; to make the display accurate.
736 ;; Return list of regexp and prefix arg using PROMPT.
738 ;; Don't clobber this.
745 regexp)
749 ;; First make sure there is a ring and that we are after the process mark
756 ;; arg of zero resets search from beginning, and uses arg of 1
760 arg)))
763 ;; Index to start a directional search, starting at comint-input-ring-index
765 ;; If a search is running, offset by 1 in direction of arg
768 ;; For a new search, start from beginning or end, as appropriate
774 "Return the string ARG places along the input ring.
775 Moves relative to `comint-input-ring-index'."
779 arg)))
782 "Cycle backwards through input history."
787 "Cycle forwards through input history."
792 "Return the string matching REGEXP ARG places along the input ring.
793 Moves relative to `comint-input-ring-index'."
798 "Return the index matching REGEXP ARG places along the input ring.
799 Moves relative to START, or `comint-input-ring-index'."
808 ;; Do the whole search as many times as the argument says.
810 ;; Step once.
813 ;; If we haven't reached a match, step some more.
817 ;; If we have gone all the way around in this search.
820 ;; Now that we know which ring element to use, if we found it, return that.
822 n)))
825 "Search backwards through input history for match for REGEXP.
826 \(Previous history elements are earlier commands.)
827 With prefix argument N, search for Nth previous match.
828 If N is negative, find the next or Nth next match."
832 ;; Has a match been found?
838 ;; Can't use kill-region as it sets this-command
843 "Search forwards through input history for match for REGEXP.
844 \(Later history elements are more recent commands.)
845 With prefix argument N, search for Nth following match.
846 If N is negative, find the previous or Nth previous match."
851 "Search backwards through input history for match for current input.
852 \(Previous history elements are earlier commands.)
853 With prefix argument N, search for Nth previous match.
854 If N is negative, search forwards for the -Nth following match."
857 comint-next-matching-input-from-input)))
858 ;; Starting a new search
863 comint-input-ring-index nil))
866 arg))
869 "Search forwards through input history for match for current input.
870 \(Following history elements are more recent commands.)
871 With prefix argument N, search for Nth following match.
872 If N is negative, search backwards for the -Nth previous match."
878 "Expand input command history references before point.
879 Expansion is dependent on the value of `comint-input-autoexpand'.
881 This function depends on the buffer's idea of the input history, which may not
882 match the command interpreter's idea, assuming it has one.
884 Assumes history syntax is like typical Un*x shells'. However, since emacs
885 cannot know the interpreter's idea of input line numbers, assuming it has one,
886 it cannot expand absolute input line number references.
888 If the optional argument SILENT is non-nil, never complain
889 even if history reference seems erroneous.
891 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
893 Returns t if successful."
899 ;; Looks like there might be history references in the command.
907 "Expand directory stack reference before point.
908 See `comint-replace-by-expanded-history'. Returns t if successful."
919 ;; This seems a bit complex. We look for references such as !!, !-num,
920 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
921 ;; If that wasn't enough, the plings can be suffixed with argument
922 ;; range specifiers.
923 ;; Argument ranges are complex too, so we hive off the input line,
924 ;; referenced with plings, with the range string to `comint-args'.
928 ;; The history is quoted, or we're in quotes.
931 ;; We cannot know the interpreter's idea of input line numbers.
935 ;; Just a number of args from `number' lines backward.
944 t t)
950 ;; Just a number of args from the previous input line.
954 t t)
958 ;; Most recent input starting with or containing (possibly
959 ;; protected) string, maybe just a number of args. Phew.
977 t t)
980 ;; Quick substitution on the previous input line.
997 "Expand input history references before point and insert ARG spaces.
998 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1002 \f
1004 "Return t if the number of quotes between BEG and END is odd.
1005 Quotes are single and double."
1011 "Return number of matches for REGEXP from BEG to END."
1018 count))
1021 ;; From STRING, return the args depending on the range specified in the text
1022 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1023 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1039 ;; Return a list of arguments from ARG. Break it up at the
1040 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1055 comint-delimiter-argument-list)))
1058 args)))
1061 "Return from STRING the NTH to MTH arguments.
1062 NTH and/or MTH can be nil, which means the last argument.
1063 Returned arguments are separated by single spaces.
1064 We assume whitespace separates arguments, except within quotes.
1065 Also, a run of one or more of a single character
1066 in `comint-delimiter-argument-list' is a separate argument.
1067 Argument 0 is the command name."
1071 beg str value quotes)
1072 ;; Build a list of all the args until we have as many as we want.
1076 ;; It's contiguous, part of the same arg.
1079 ;; It's a new separate arg.
1081 ;; Put the previous arg, if there was one, onto ARGS.
1098 \f
1099 ;;;
1100 ;;; Input processing stuff
1101 ;;;
1104 "Send input to process.
1105 After the process output mark, sends all text from the process mark to
1106 point as input to the process. Before the process output mark, calls value
1107 of variable `comint-get-old-input' to retrieve old input, copies it to the
1108 process mark, and sends it. If variable `comint-process-echoes' is nil,
1109 a terminal newline is also inserted into the buffer and sent to the process
1110 \(if it is non-nil, all text from the process mark to point is deleted,
1111 since it is assumed the remote process will re-echo it).
1113 Any history reference may be expanded depending on the value of the variable
1114 `comint-input-autoexpand'. The list of function names contained in the value
1115 of `comint-input-filter-functions' is called on the input before sending it.
1116 The input is entered into the input history ring, if the value of variable
1117 `comint-input-filter' returns non-nil when called on the input.
1119 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1120 end of line before sending the input.
1122 The values of `comint-get-old-input', `comint-input-filter-functions', and
1123 `comint-input-filter' are chosen according to the command interpreter running
1124 in the buffer. E.g.,
1126 If the interpreter is the csh,
1127 comint-get-old-input is the default: take the current line, discard any
1128 initial string matching regexp comint-prompt-regexp.
1131 comint-input-filter is the default: returns t if the input isn't all white
1132 space.
1134 If the comint is Lucid Common Lisp,
1135 comint-get-old-input snarfs the sexp ending at point.
1136 comint-input-filter-functions does nothing.
1137 comint-input-filter returns nil if the input matches input-filter-regexp,
1138 which matches (1) all whitespace (2) :a, :c, etc.
1140 Similarly for Soar, Scheme, etc."
1142 ;; Note that the input string does not include its terminal newline.
1152 copy)))
1154 ;; Just whatever's already there
1155 intxt
1156 ;; Expand and leave it visible in buffer
1160 input
1161 ;; This is messy 'cos ultimately the original
1162 ;; functions used do insertion, rather than return
1163 ;; strings. We have to expand, then insert back.
1168 copy))))
1177 history))))
1182 ;; Update the markers before we send the input
1183 ;; in case we get output amidst sending the input.
1190 ;; The purpose of using this filter for comint processes
1191 ;; is to keep comint-last-input-end from moving forward
1192 ;; when output is inserted.
1194 ;; First check for killed buffer
1211 ;; Insert after old_begv, but before old_zv.
1217 ;; Don't insert initial prompt outside the top of the window.
1234 "Go to the end of buffer in all windows showing it.
1235 Movement occurs if point in the selected window is not after the process mark,
1236 and `this-command' is an insertion command. Insertion commands recognised
1237 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1238 Depends on the value of `comint-scroll-to-bottom-on-input'.
1240 This function should be a pre-command hook."
1243 hilit-yank)))
1259 nil t))))))
1262 "Go to the end of buffer in all windows showing it.
1263 Does not scroll if the current line is the last line in the buffer.
1264 Depends on the value of `comint-scroll-to-bottom-on-output' and
1265 `comint-scroll-show-maximum-output'.
1267 This function should be in the list `comint-output-filter-functions'."
1281 ;; Maybe user wants point to jump to the end.
1284 ;; If point was at the end, keep it at the end.
1288 ;; Optionally scroll so that the text
1289 ;; ends at the bottom of the window.
1296 nil t))
1300 "Truncate the buffer to `comint-buffer-maximum-size'.
1301 This function could be on `comint-output-filter-functions' or bound to a key."
1310 "Strip trailing `^M' characters from the current output group.
1311 This function could be on `comint-output-filter-functions' or bound to a key."
1322 "Put the end of the buffer at the bottom of the window."
1328 "Default for `comint-get-old-input'.
1329 Take the current line, and discard any initial text matching
1330 `comint-prompt-regexp'."
1339 "Insert after prompt old input at point as new input to be edited.
1340 Calls `comint-get-old-input' to get old input."
1350 "Skip past the text matching regexp `comint-prompt-regexp'.
1351 If this takes us past the end of the current line, don't skip at all."
1358 "Return t if point is after the process output marker."
1363 "Default function for sending to PROC input STRING.
1364 This just sends STRING plus a newline. To override this,
1365 set the hook `comint-input-sender'."
1370 "Goes to the beginning of line, then skips past the prompt, if any.
1373 The prompt skip is done by skipping text matching the regular expression
1374 `comint-prompt-regexp', a buffer local variable."
1379 ;;; These three functions are for entering text you don't want echoed or
1380 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1381 ;;; Just enter m-x send-invisible and type in your line, or add
1382 ;;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1385 "Read a single line of text from user without echoing, and return it.
1386 Prompt with argument PROMPT, a string. Optional argument STARS causes
1387 input to be echoed with '*' characters on the prompt line. Input ends with
1388 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1389 `inhibit-quit' is set because e.g. this function was called from a process
1390 filter and C-g is pressed, this function returns nil rather than a string).
1392 Note that the keystrokes comprising the text can still be recovered
1394 applications."
1405 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1408 ;; This function may get called from a process filter, where
1409 ;; inhibit-quit is set. In later versions of emacs read-char
1410 ;; may clear quit-flag itself and return C-g. That would make
1411 ;; it impossible to quit this loop in a simple way, so
1412 ;; re-enable it here (for backward-compatibility the check for
1413 ;; quit-flag below would still be necessary, so this seems
1414 ;; like the simplest way to do things).
1416 done t))
1426 ;; Emulate a true quit, except that we have to return a value.
1432 ans)))
1435 "Read a string without echoing.
1436 Then send it to the process running in the current buffer. A new-line
1437 is additionally sent. String is not saved on comint input history list.
1438 Security bug: your string can still be temporarily recovered with
1449 "Prompt in the minibuffer for password and send without echoing.
1450 This function uses `send-invisible' to read and send a password to the buffer's
1451 process if STRING contains a password prompt defined by
1452 `comint-password-prompt-regexp'.
1454 This function could be in the list `comint-output-filter-functions'."
1457 \f
1458 ;;; Low-level process communication
1462 \f
1463 ;;; Random input hackage
1466 "Kill all output from interpreter since last input.
1467 Does not delete the prompt."
1480 ;; Output message and put back prompt
1484 "Display start of this batch of interpreter output at top of window.
1485 Sets mark to the value of point when this command is run."
1495 "Interrupt the current subjob."
1500 "Send kill signal to the current subjob."
1505 "Send quit signal to the current subjob."
1510 "Stop the current subjob.
1511 WARNING: if there is no current subjob, you can end up suspending
1512 the top-level process running in the buffer. If you accidentally do
1514 is not a problem with most shells, since they ignore this signal.)"
1519 "Send CONT signal to process buffer's process group.
1520 Useful if you accidentally suspend the top-level process."
1525 "Kill all text from last stuff output by interpreter to point."
1532 "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
1539 "Send an EOF to the current buffer's process."
1545 "Search backward through buffer for match for REGEXP.
1546 Matches are searched for on lines that match `comint-prompt-regexp'.
1547 With prefix argument N, search for Nth previous match.
1548 If N is negative, find the next or Nth next match."
1561 "Search forward through buffer for match for REGEXP.
1562 Matches are searched for on lines that match `comint-prompt-regexp'.
1563 With prefix argument N, search for Nth following match.
1564 If N is negative, find the previous or Nth previous match."
1570 "Move to end of Nth next prompt in the buffer.
1571 See `comint-prompt-regexp'."
1579 "Move to end of Nth previous prompt in the buffer.
1580 See `comint-prompt-regexp'."
1583 \f
1584 ;;; Support for source-file processing commands.
1585 ;;;============================================================================
1586 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1587 ;;; commands that process files of source text (e.g. loading or compiling
1588 ;;; files). So the corresponding process-in-a-buffer modes have commands
1589 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1590 ;;; for defining these commands.
1591 ;;;
1592 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1593 ;;; and Soar, in that they don't know anything about file extensions.
1594 ;;; So the compile/load interface gets the wrong default occasionally.
1595 ;;; The load-file/compile-file default mechanism could be smarter -- it
1596 ;;; doesn't know about the relationship between filename extensions and
1597 ;;; whether the file is source or executable. If you compile foo.lisp
1598 ;;; with compile-file, then the next load-file should use foo.bin for
1599 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1600 ;;; because the extension for executable files varies so much (.o, .bin,
1601 ;;; .lbin, .mo, .vo, .ao, ...).
1604 ;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1605 ;;; commands.
1606 ;;;
1607 ;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1608 ;;; want to save the buffer before issuing any process requests to the command
1609 ;;; interpreter.
1610 ;;;
1611 ;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1612 ;;; for the file to process.
1614 ;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1615 ;;;============================================================================
1616 ;;; This function computes the defaults for the load-file and compile-file
1617 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1618 ;;;
1619 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1620 ;;; source-file processing command. NIL if there hasn't been one yet.
1621 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1622 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1623 ;;; Typically, (lisp-mode) or (scheme-mode).
1624 ;;;
1625 ;;; If the command is given while the cursor is inside a string, *and*
1626 ;;; the string is an existing filename, *and* the filename is not a directory,
1627 ;;; then the string is taken as default. This allows you to just position
1628 ;;; your cursor over a string that's a filename and have it taken as default.
1629 ;;;
1630 ;;; If the command is given in a file buffer whose major mode is in
1631 ;;; SOURCE-MODES, then the the filename is the default file, and the
1632 ;;; file's directory is the default directory.
1633 ;;;
1634 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1635 ;;; then the default directory & file are what was used in the last source-file
1636 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1637 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1638 ;;; is the cwd, with no default file. (\"no default file\" = nil)
1639 ;;;
1640 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1641 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1642 ;;; for Soar programs, etc.
1643 ;;;
1644 ;;; The function returns a pair: (default-directory . default-file).
1655 ;;; (COMINT-CHECK-SOURCE fname)
1656 ;;;============================================================================
1657 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1658 ;;; process-in-a-buffer modes), this function can be called on the filename.
1659 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1660 ;;; is queried to see if he wants to save the buffer before proceeding with
1661 ;;; the load or compile.
1668 ;; save BUFF.
1675 ;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1676 ;;;============================================================================
1677 ;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1678 ;;; commands that process source files (like loading or compiling a file).
1679 ;;; It prompts for the filename, provides a default, if there is one,
1680 ;;; and returns the result filename.
1681 ;;;
1682 ;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1683 ;;;
1684 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1685 ;;; from the last source processing command. SOURCE-MODES is a list of major
1686 ;;; modes used to determine what file buffers contain source files. (These
1687 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1688 ;;; then the filename reader will only accept a file that exists.
1689 ;;;
1690 ;;; A typical use:
1691 ;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1692 ;;; '(lisp-mode) t))
1694 ;;; This is pretty stupid about strings. It decides we're in a string
1695 ;;; if there's a quote on both sides of point on the current line.
1697 "Return string around POINT that starts the current line, or nil."
1724 prompt deffile)
1725 prompt)
1726 defdir
1728 mustmatch-p)))
1731 ;;; I am somewhat divided on this string-default feature. It seems
1732 ;;; to violate the principle-of-least-astonishment, in that it makes
1733 ;;; the default harder to predict, so you actually have to look and see
1734 ;;; what the default really is before choosing it. This can trip you up.
1735 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1736 ;;; on this.
1737 ;;; -Olin
1739 \f
1740 ;;; Simple process query facility.
1741 ;;; ===========================================================================
1742 ;;; This function is for commands that want to send a query to the process
1743 ;;; and show the response to the user. For example, a command to get the
1744 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1745 ;;; to an inferior Common Lisp process.
1746 ;;;
1747 ;;; This simple facility just sends strings to the inferior process and pops
1748 ;;; up a window for the process buffer so you can see what the process
1749 ;;; responds with. We don't do anything fancy like try to intercept what the
1750 ;;; process responds with and put it in a pop-up window or on the message
1751 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1753 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1754 ;;; a window for the inferior process so that its response can be seen.
1764 ;; Try to position the proc window so you can see the answer.
1765 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1766 ;; I don't know why. Wizards invited to improve it.
1775 \f
1776 ;;; Filename/command/history completion in a buffer
1777 ;;; ===========================================================================
1778 ;;; Useful completion functions, courtesy of the Ergo group.
1780 ;;; Six commands:
1781 ;;; comint-dynamic-complete Complete or expand command, filename,
1782 ;;; history at point.
1783 ;;; comint-dynamic-complete-filename Complete filename at point.
1784 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
1785 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
1786 ;;; replace with expanded/completed name.
1787 ;;; comint-dynamic-simple-complete Complete stub given candidates.
1789 ;;; These are not installed in the comint-mode keymap. But they are
1790 ;;; available for people who want them. Shell-mode installs them:
1791 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1792 ;;; (define-key shell-mode-map "\M-?"
1793 ;;; 'comint-dynamic-list-filename-completions)))
1794 ;;;
1795 ;;; Commands like this are fine things to put in load hooks if you
1796 ;;; want them present in specific modes.
1799 "*If non-nil, automatically list possiblities on partial completion.
1803 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1804 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
1805 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
1809 "*If non-nil, use shortest completion if characters cannot be added.
1810 This mirrors the optional behavior of tcsh.
1815 "*List of suffixes to be disregarded during file completion.
1816 This mirrors the optional behavior of bash and tcsh.
1821 "Prefix prepended to absolute file names taken from process input.
1822 This is used by comint's and shell's completion functions, and by shell's
1832 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1835 directory)))
1839 "Return the word of WORD-CHARS at point, or nil if non is found.
1840 Word constituents are considered to be those in WORD-CHARS, which is like the
1845 ;(memq (char-after (point)) shell-file-name-quote-list)
1848 ;; Don't go forward over a word-char (this can happen if we're at bob).
1851 ;; Set match-data to match the entire string.
1858 "Return the filename at point, or nil if non is found.
1859 Environment variables are substituted. See `comint-word'."
1865 "Return FILENAME with magic characters quoted.
1866 Magic characters are those in `comint-file-name-quote-list'."
1868 filename
1875 filename))))
1878 "Return FILENAME with quoted characters unquoted."
1880 filename
1884 filename)))
1888 "Dynamically perform completion at point.
1889 Calls the functions in `comint-dynamic-complete-functions' to perform
1890 completion until a function returns non-nil, at which point completion is
1891 assumed to have occurred."
1897 "Dynamically complete the filename at point.
1898 Completes if after a filename. See `comint-match-partial-filename' and
1899 `comint-dynamic-complete-as-filename'.
1900 This function is similar to `comint-replace-by-expanded-filename', except that
1901 it won't change parts of the filename already entered in the buffer; it just
1902 adds completion characters to the end of the filename. A completions listing
1903 may be shown in a help buffer if completion is ambiguous.
1905 Completion is dependent on the value of `comint-completion-addsuffix',
1906 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
1907 completions listing is dependent on the value of `comint-completion-autolist'.
1909 Returns t if successful."
1918 "Dynamically complete at point as a filename.
1919 See `comint-dynamic-complete-filename'. Returns t if successful."
1950 ;; We inserted a unique completion.
1956 ;; It's not unique, but user wants shortest match.
1961 ;; It's not unique, list possible completions.
1965 success))
1969 "Dynamically expand and complete the filename at point.
1970 Replace the filename with an expanded, canonicalised and completed replacement.
1973 removed, and the filename is made absolute instead of relative. For expansion
1974 see `expand-file-name' and `substitute-in-file-name'. For completion see
1975 `comint-dynamic-complete-filename'."
1982 "Dynamically complete STUB from CANDIDATES list.
1983 This function inserts completion characters at point by completing STUB from
1984 the strings in CANDIDATES. A completions listing may be shown in a help buffer
1985 if completion is ambiguous.
1987 Returns nil if no completion was inserted.
1988 Returns `sole' if completed with the only completion match.
1989 Returns `shortest' if completed with the shortest of the completion matches.
1990 Returns `partial' if completed as far as possible with the completion matches.
1991 Returns `listed' if a completion listing was shown.
1993 See also `comint-dynamic-complete-filename'."
2002 nil)
2013 ;; Insert the longest substring.
2018 ;; It's not unique, but user wants shortest match.
2024 ;; It's not unique, list possible completions.
2033 "List in help buffer possible completions of the filename at point."
2049 "List in help buffer sorted COMPLETIONS.
2050 Typing SPC flushes the help buffer."
2064 ;; If the user does mouse-choose-completion with the mouse,
2065 ;; execute the command, then delete the completion window.
2072 \f
2073 ;;; Converting process modes to use comint mode
2074 ;;; ===========================================================================
2075 ;;; The code in the Emacs 19 distribution has all been modified to use comint
2076 ;;; where needed. However, there are `third-party' packages out there that
2077 ;;; still use the old shell mode. Here's a guide to conversion.
2078 ;;;
2079 ;;; Renaming variables
2080 ;;; Most of the work is renaming variables and functions. These are the common
2081 ;;; ones:
2082 ;;; Local variables:
2083 ;;; last-input-start comint-last-input-start
2084 ;;; last-input-end comint-last-input-end
2085 ;;; shell-prompt-pattern comint-prompt-regexp
2086 ;;; shell-set-directory-error-hook <no equivalent>
2087 ;;; Miscellaneous:
2088 ;;; shell-set-directory <unnecessary>
2089 ;;; shell-mode-map comint-mode-map
2090 ;;; Commands:
2091 ;;; shell-send-input comint-send-input
2092 ;;; shell-send-eof comint-delchar-or-maybe-eof
2093 ;;; kill-shell-input comint-kill-input
2094 ;;; interrupt-shell-subjob comint-interrupt-subjob
2095 ;;; stop-shell-subjob comint-stop-subjob
2096 ;;; quit-shell-subjob comint-quit-subjob
2097 ;;; kill-shell-subjob comint-kill-subjob
2098 ;;; kill-output-from-shell comint-kill-output
2099 ;;; show-output-from-shell comint-show-output
2100 ;;; copy-last-shell-input Use comint-previous-input/comint-next-input
2101 ;;;
2102 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2103 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2104 ;;; Comint mode does not provide functionality equivalent to
2105 ;;; shell-set-directory-error-hook; it is gone.
2106 ;;;
2107 ;;; comint-last-input-start is provided for modes which want to munge
2108 ;;; the buffer after input is sent, perhaps because the inferior
2109 ;;; insists on echoing the input. The LAST-INPUT-START variable in
2110 ;;; the old shell package was used to implement a history mechanism,
2111 ;;; but you should think twice before using comint-last-input-start
2112 ;;; for this; the input history ring often does the job better.
2113 ;;;
2114 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2115 ;;; *not* create the comint-mode local variables in your foo-mode function.
2116 ;;; This is not modular. Instead, call comint-mode, and let *it* create the
2117 ;;; necessary comint-specific local variables. Then create the
2118 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2119 ;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2120 ;;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2121 ;;; get-old-input) that need to be different from the defaults. Call
2122 ;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2123 ;;; comint-mode will take care of it. The following example, from shell.el,
2124 ;;; is typical:
2125 ;;;
2126 ;;; (defvar shell-mode-map '())
2127 ;;; (cond ((not shell-mode-map)
2128 ;;; (setq shell-mode-map (copy-keymap comint-mode-map))
2129 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2130 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2131 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2132 ;;; (define-key shell-mode-map "\M-?"
2133 ;;; 'comint-dynamic-list-filename-completions)))
2134 ;;;
2135 ;;; (defun shell-mode ()
2136 ;;; (interactive)
2137 ;;; (comint-mode)
2138 ;;; (setq comint-prompt-regexp shell-prompt-pattern)
2139 ;;; (setq major-mode 'shell-mode)
2140 ;;; (setq mode-name "Shell")
2141 ;;; (use-local-map shell-mode-map)
2142 ;;; (make-local-variable 'shell-directory-stack)
2143 ;;; (setq shell-directory-stack nil)
2144 ;;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2145 ;;; (run-hooks 'shell-mode-hook))
2146 ;;;
2147 ;;;
2148 ;;; Note that make-comint is different from make-shell in that it
2149 ;;; doesn't have a default program argument. If you give make-shell
2150 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
2151 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
2152 ;;; of NIL, it barfs. Adjust your code accordingly...
2153 ;;;
2154 ;;; Completion for comint-mode users
2155 ;;;
2156 ;;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2157 ;;; hook to add completion functions to. Functions on this list should return
2158 ;;; non-nil if completion occurs (i.e., further completion should not occur).
2159 ;;; You could use comint-dynamic-simple-complete to do the bulk of the
2160 ;;; completion job.
2161 \f
2164 ;;; comint.el ends here