| blob | 48c60003b7df12c56fd86e78a33de51c7effc2c6 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
6 ;; Simon Marshall <simon@gnu.org>
7 ;; Maintainer: FSF
8 ;; Keywords: processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Please send me bug reports, bug fixes, and extensions, so that I can
30 ;; merge them into the master source.
31 ;; - Olin Shivers (shivers@cs.cmu.edu)
32 ;; - Simon Marshall (simon@gnu.org)
34 ;; This file defines a general command-interpreter-in-a-buffer package
35 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
36 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
37 ;; This way, all these specific packages share a common base functionality,
38 ;; and a common set of bindings, which makes them easier to use (and
39 ;; saves code, implementation time, etc., etc.).
41 ;; Several packages are already defined using comint mode:
42 ;; - shell.el defines a shell-in-a-buffer mode.
43 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
44 ;;
45 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
46 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
47 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
48 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
49 ;; previewers, and printers from within emacs.
50 ;; - background.el allows csh-like job control inside emacs.
51 ;; It is pretty easy to make new derived modes for other processes.
53 ;; For documentation on the functionality provided by comint mode, and
54 ;; the hooks available for customising it, see the comments below.
55 ;; For further information on the standard derived modes (shell,
56 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
58 ;; For hints on converting existing process modes (e.g., tex-mode,
59 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
60 ;; instead of shell-mode, see the notes at the end of this file.
62 \f
63 ;; Brief Command Documentation:
64 ;;============================================================================
65 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
66 ;; mode)
67 ;;
68 ;; m-p comint-previous-input Cycle backwards in input history
69 ;; m-n comint-next-input Cycle forwards
70 ;; m-r comint-previous-matching-input Previous input matching a regexp
71 ;; m-s comint-next-matching-input Next input that matches
72 ;; m-c-l comint-show-output Show last batch of process output
73 ;; return comint-send-input
74 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
75 ;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
76 ;; second time, move to process-mark.
77 ;; c-c c-u comint-kill-input ^u
78 ;; c-c c-w backward-kill-word ^w
79 ;; c-c c-c comint-interrupt-subjob ^c
80 ;; c-c c-z comint-stop-subjob ^z
81 ;; c-c c-\ comint-quit-subjob ^\
82 ;; c-c c-o comint-kill-output Delete last batch of process output
83 ;; c-c c-r comint-show-output Show last batch of process output
84 ;; c-c c-l comint-dynamic-list-input-ring List input history
85 ;;
86 ;; Not bound by default in comint-mode (some are in shell mode)
87 ;; comint-run Run a program under comint-mode
88 ;; send-invisible Read a line w/o echo, and send to proc
89 ;; comint-dynamic-complete-filename Complete filename at point.
90 ;; comint-dynamic-complete-variable Complete variable name at point.
91 ;; comint-dynamic-list-filename-completions List completions in help buffer.
92 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
93 ;; replace with expanded/completed name.
94 ;; comint-replace-by-expanded-history Expand history at point;
95 ;; replace with expanded name.
96 ;; comint-magic-space Expand history and add (a) space(s).
97 ;; comint-kill-subjob No mercy.
98 ;; comint-show-maximum-output Show as much output as possible.
99 ;; comint-continue-subjob Send CONT signal to buffer's process
100 ;; group. Useful if you accidentally
101 ;; suspend your process (with C-c C-z).
102 ;; comint-get-next-from-history Fetch successive input history lines
103 ;; comint-accumulate Combine lines to send them together
104 ;; as input.
105 ;; comint-goto-process-mark Move point to where process-mark is.
106 ;; comint-set-process-mark Set process-mark to point.
108 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
110 ;;; Code:
113 \f
114 ;; Buffer Local Variables:
115 ;;============================================================================
116 ;; Comint mode buffer local variables:
117 ;; comint-prompt-regexp string comint-bol uses to match prompt
118 ;; comint-delimiter-argument-list list For delimiters and arguments
119 ;; comint-last-input-start marker Handy if inferior always echoes
120 ;; comint-last-input-end marker For comint-kill-output command
121 ;; comint-input-ring-size integer For the input history
122 ;; comint-input-ring ring mechanism
123 ;; comint-input-ring-index number ...
124 ;; comint-save-input-ring-index number ...
125 ;; comint-input-autoexpand symbol ...
126 ;; comint-input-ignoredups boolean ...
127 ;; comint-last-input-match string ...
128 ;; comint-dynamic-complete-functions hook For the completion mechanism
129 ;; comint-completion-fignore list ...
130 ;; comint-file-name-chars string ...
131 ;; comint-file-name-quote-list list ...
132 ;; comint-get-old-input function Hooks for specific
133 ;; comint-input-filter-functions hook process-in-a-buffer
134 ;; comint-output-filter-functions hook function modes.
135 ;; comint-preoutput-filter-functions hook
136 ;; comint-input-filter function ...
137 ;; comint-input-sender function ...
138 ;; comint-eol-on-send boolean ...
139 ;; comint-process-echoes boolean ...
140 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
141 ;; comint-scroll-to-bottom-on-output symbol ...
142 ;; comint-scroll-show-maximum-output boolean ...
143 ;; comint-accum-marker maker For comint-accumulate
144 ;;
145 ;; Comint mode non-buffer local variables:
146 ;; comint-completion-addsuffix boolean/cons For file name
147 ;; comint-completion-autolist boolean completion behavior
148 ;; comint-completion-recexact boolean ...
151 "General command interpreter in a window stuff."
155 "Completion facilities in comint"
159 "Source finding facilities in comint"
165 "Regexp to recognise prompts in the inferior process.
168 Good choices:
179 "List of characters to recognise as separate arguments in input.
180 Strings comprising a character in this list will separate the arguments
181 surrounding them, and also be regarded as arguments in their own right (unlike
182 whitespace). See `comint-arguments'.
183 Defaults to the empty list.
190 "*If non-nil, expand input command history references on completion.
191 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
193 If the value is `input', then the expansion is seen on input.
194 If the value is `history', then the expansion is only when inserting
195 into the buffer's input ring. See also `comint-magic-space' and
196 `comint-dynamic-complete'.
198 This variable is buffer-local."
206 "*If non-nil, don't add input matching the last on the input ring.
207 This mirrors the optional behavior of bash.
209 This variable is buffer-local."
214 "*If non-nil, name of the file to read/write input history.
215 See also `comint-read-input-ring' and `comint-write-input-ring'.
217 This variable is buffer-local, and is a good thing to set in mode hooks."
222 "*Controls whether input to interpreter causes window to scroll.
223 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
224 If `this', scroll only the selected window.
226 The default is nil.
228 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
236 "*Controls whether interpreter output causes window to scroll.
237 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
238 If `this', scroll only the selected window.
239 If `others', scroll only those that are not the selected window.
241 The default is nil.
243 See variable `comint-scroll-show-maximum-output' and function
244 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
253 "*Controls how interpreter output causes window to scroll.
254 If non-nil, then show the maximum output when the window is scrolled.
256 See variable `comint-scroll-to-bottom-on-output' and function
257 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
262 "*The maximum size in lines for comint buffers.
263 Comint buffers are truncated from the top to be no greater than this number, if
264 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
275 "*If non-nil, assume that the subprocess echoes any input.
276 If so, delete one copy of the input so that only one copy eventually
277 appears in the buffer.
279 This variable is buffer-local."
283 ;; AIX puts the name of the person being su'd to in front of the prompt.
284 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
285 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
286 ;; ssh-add prints a prompt like `Enter passphrase: '.
287 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
292 "*Regexp matching prompts for passwords in the inferior process.
293 This is used by `comint-watch-for-password-prompt'."
297 ;; Here are the per-interpreter hooks.
299 "Function that returns old text in comint mode.
300 This function is called when return is typed while the point is in old text.
301 It returns the text to be submitted as process input. The default is
302 `comint-get-old-input-default', which grabs the current line, and strips off
307 "List of functions called to perform completion.
308 Functions should return non-nil if completion was performed.
309 See also `comint-dynamic-complete'.
315 "Predicate for filtering additions to input history.
316 Takes one argument, the input. If non-nil, the input may be saved on the input
320 "Functions to call before input is sent to the process.
321 These functions get one argument, a string containing the text to send.
326 "Functions to call after output is inserted into the buffer.
327 One possible function is `comint-postoutput-scroll-to-bottom'.
328 These functions get one argument, a string containing the text as originally
329 inserted. Note that this might not be the same as the buffer contents between
330 `comint-last-output-start' and the buffer's `process-mark', if other filter
331 functions have already modified the buffer.
333 See also `comint-preoutput-filter-functions'.
338 "Function to actually send to PROCESS the STRING submitted by user.
339 Usually this is just `comint-simple-send', but if your mode needs to
340 massage the input string, put a different function here.
341 `comint-simple-send' just sends the string plus a newline.
345 "*Non-nil means go to the end of the line before sending input.
346 See `comint-send-input'."
351 "Called upon entry into comint-mode
352 This is run before the process is cranked up."
357 "Called each time a process is exec'd by `comint-exec'.
358 This is called after the process is cranked up. It is useful for things that
359 must be done each time a process is executed in a comint mode buffer (e.g.,
360 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
361 executed once when the buffer is created."
368 "Non-nil if communications via pty; false if by pipe. Buffer local.
380 "Last input ring index which you copied.
384 "Non-nil if you are accumulating input lines to send as input together.
403 "Major mode for interacting with an inferior interpreter.
404 Interpreter name is same as buffer name, sans the asterisks.
405 Return at end of buffer sends line as input.
406 Return not at end copies rest of line to end and sends it.
407 Setting variable `comint-eol-on-send' means jump to the end of the line
408 before submitting new input.
410 This mode is customised to create major modes such as Inferior Lisp
411 mode, Shell mode, etc. This can be done by setting the hooks
412 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
413 and `comint-get-old-input' to appropriate functions, and the variable
414 `comint-prompt-regexp' to the appropriate regular expression.
416 An input history is maintained of size `comint-input-ring-size', and
417 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
418 Input ring history expansion can be achieved with the commands
420 Input ring expansion is controlled by the variable `comint-input-autoexpand',
421 and addition is controlled by the variable `comint-input-ignoredups'.
423 Commands with no default key bindings include `send-invisible',
424 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
425 `comint-magic-space'.
427 Input to, and output from, the subprocess can cause the window to scroll to
428 the end of the buffer. See variables `comint-output-filter-functions',
429 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
430 and `comint-scroll-to-bottom-on-output'.
433 to continue it.
437 Entry to this mode runs the hooks on `comint-mode-hook'."
439 ;; Do not remove this. All major modes must do this.
493 nil
494 ;; Keys:
523 ;; Menu bars:
524 ;; completion:
535 ;; Input history:
572 ;; Signals
587 ;; Put them in the menu bar:
589 menu-bar-final-items))
590 )
593 "Return t if there is a living process associated w/buffer BUFFER.
594 Living means the status is `open', `run', or `stop'.
595 BUFFER can be either a buffer or the name of one."
599 ;;;###autoload
601 "Make a comint process NAME in a buffer, running PROGRAM.
602 The name of the buffer is made by surrounding NAME with `*'s.
603 PROGRAM should be either a string denoting an executable program to create
604 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
605 connection to be opened via `open-network-stream'. If there is already a
606 running process in that buffer, it is not restarted. Optional third arg
607 STARTFILE is the name of a file to send the contents of to the process.
609 If PROGRAM is a string, any more args are arguments to PROGRAM."
613 ;; If no process, or nuked process, crank up a new one and put buffer in
614 ;; comint mode. Otherwise, leave buffer and existing process alone.
620 buffer))
622 ;;;###autoload
624 "Run PROGRAM in a comint buffer and switch to it.
625 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
626 The file name is used to make a symbol name, such as `comint-sh-hook', and any
627 hooks on this symbol are run in the buffer.
628 See `make-comint' and `comint-exec'."
635 "Start up a process in buffer BUFFER for comint modes.
636 Blasts any old process running in the buffer. Doesn't set the buffer mode.
637 You can use this to cheaply run a series of processes in the same comint
638 buffer. The hook `comint-exec-hook' is run after each exec."
643 ;; Crank up a new process
651 ;; Jump to the end, and set the process mark.
654 ;; Feed it the startfile.
656 ;;This is guaranteed to wait long enough
657 ;;but has bad results if the comint does not prompt at all
658 ;; (while (= size (buffer-size))
659 ;; (sleep-for 1))
660 ;;I hope 1 second is enough!
668 buffer)))
670 ;; This auxiliary function cranks up the process for comint-exec in
671 ;; the appropriate environment.
676 ;; If using termcap, we specify `emacs' as the terminal type
677 ;; because that lets us specify a width.
678 ;; If using terminfo, we specify `dumb' because that is
679 ;; a defined terminal type. `emacs' is not a defined terminal type
680 ;; and there is no way for us to define it here.
681 ;; Some programs that use terminfo get very confused
682 ;; if TERM is not a valid terminal type.
689 process-environment))
692 default-directory
694 proc decoding encoding changed)
699 ;; If start-process decided to use some coding system for decoding
700 ;; data sent form the process and the coding system doesn't
701 ;; specify EOL conversion, we had better convert CRLF to LF.
704 changed t))
705 ;; Even if start-process left the coding system for encoding data
706 ;; sent from the process undecided, we had better use the same one
707 ;; as what we use for decoding. But, we should suppress EOL
708 ;; conversion.
711 changed t))
714 proc))
715 \f
716 ;; Input history processing in a buffer
717 ;; ===========================================================================
718 ;; Useful input history functions, courtesy of the Ergo group.
720 ;; Eleven commands:
721 ;; comint-dynamic-list-input-ring List history in help buffer.
722 ;; comint-previous-input Previous input...
723 ;; comint-previous-matching-input ...matching a string.
724 ;; comint-previous-matching-input-from-input ... matching the current input.
725 ;; comint-next-input Next input...
726 ;; comint-next-matching-input ...matching a string.
727 ;; comint-next-matching-input-from-input ... matching the current input.
728 ;; comint-backward-matching-input Backwards input...
729 ;; comint-forward-matching-input ...matching a string.
730 ;; comint-replace-by-expanded-history Expand history at point;
731 ;; replace with expanded history.
732 ;; comint-magic-space Expand history and insert space.
733 ;;
734 ;; Three functions:
735 ;; comint-read-input-ring Read into comint-input-ring...
736 ;; comint-write-input-ring Write to comint-input-ring-file-name.
737 ;; comint-replace-by-expanded-history-before-point Workhorse function.
740 "Sets the buffer's `comint-input-ring' from a history file.
741 The name of the file is given by the variable `comint-input-ring-file-name'.
742 The history ring is of size `comint-input-ring-size', regardless of file size.
743 If `comint-input-ring-file-name' is nil this function does nothing.
745 If the optional argument SILENT is non-nil, we say nothing about a
746 failure to read the history file.
748 This function is useful for major mode commands and mode hooks.
750 The commands stored in the history file are separated by the
751 `comint-input-ring-separator'. The most recent command comes last.
753 See also `comint-input-ignoredups' and `comint-write-input-ring'."
756 nil)
760 comint-input-ring-file-name)))
772 ;; Save restriction in case file is already visited...
773 ;; Watch for those date stamps in history files!
777 nil t))
793 comint-input-ring-index nil)))))
796 "Writes the buffer's `comint-input-ring' to a history file.
797 The name of the file is given by the variable `comint-input-ring-file-name'.
798 The original contents of the file are lost if `comint-input-ring' is not empty.
799 If `comint-input-ring-file-name' is nil this function does nothing.
801 Useful within process sentinels.
803 See also `comint-read-input-ring'."
807 nil)
815 ;; Write it all out into a buffer first. Much faster, but messier,
816 ;; than writing it one line at a time.
828 "List in help buffer the buffer's input history."
837 ;; We have to build up a list ourselves from the ring vector.
841 ;; Change "completion" to "history reference"
842 ;; to make the display accurate.
858 ;; Return list of regexp and prefix arg using PROMPT.
866 regexp)
870 ;; First make sure there is a ring and that we are after the process mark
877 ;; arg of zero resets search from beginning, and uses arg of 1
881 arg)))
884 ;; Index to start a directional search, starting at comint-input-ring-index
886 ;; If a search is running, offset by 1 in direction of arg
889 ;; For a new search, start from beginning or end, as appropriate
895 "Return the string ARG places along the input ring.
896 Moves relative to `comint-input-ring-index'."
900 arg)))
903 "Cycle backwards through input history."
908 "Cycle forwards through input history."
913 "Return the string matching REGEXP ARG places along the input ring.
914 Moves relative to `comint-input-ring-index'."
919 "Return the index matching REGEXP ARG places along the input ring.
920 Moves relative to START, or `comint-input-ring-index'."
929 ;; Do the whole search as many times as the argument says.
931 ;; Step once.
934 ;; If we haven't reached a match, step some more.
938 ;; If we have gone all the way around in this search.
941 ;; Now that we know which ring element to use, if we found it, return that.
943 n)))
946 "Search backwards through input history for match for REGEXP.
947 \(Previous history elements are earlier commands.)
948 With prefix argument N, search for Nth previous match.
949 If N is negative, find the next or Nth next match."
953 ;; Has a match been found?
959 ;; Can't use kill-region as it sets this-command
966 "Search forwards through input history for match for REGEXP.
967 \(Later history elements are more recent commands.)
968 With prefix argument N, search for Nth following match.
969 If N is negative, find the previous or Nth previous match."
974 "Search backwards through input history for match for current input.
975 \(Previous history elements are earlier commands.)
976 With prefix argument N, search for Nth previous match.
977 If N is negative, search forwards for the -Nth following match."
980 comint-next-matching-input-from-input)))
981 ;; Starting a new search
987 comint-input-ring-index nil))
990 arg))
993 "Search forwards through input history for match for current input.
994 \(Following history elements are more recent commands.)
995 With prefix argument N, search for Nth following match.
996 If N is negative, search backwards for the -Nth previous match."
1002 "Expand input command history references before point.
1003 Expansion is dependent on the value of `comint-input-autoexpand'.
1005 This function depends on the buffer's idea of the input history, which may not
1006 match the command interpreter's idea, assuming it has one.
1008 Assumes history syntax is like typical Un*x shells'. However, since emacs
1009 cannot know the interpreter's idea of input line numbers, assuming it has one,
1010 it cannot expand absolute input line number references.
1012 If the optional argument SILENT is non-nil, never complain
1013 even if history reference seems erroneous.
1015 If the optional argument START is non-nil, that specifies the
1016 start of the text to scan for history references, rather
1017 than the logical beginning of line.
1019 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1021 Returns t if successful."
1027 ;; Looks like there might be history references in the command.
1034 "Expand directory stack reference before point.
1035 See `comint-replace-by-expanded-history'. Returns t if successful.
1037 If the optional argument START is non-nil, that specifies the
1038 start of the text to scan for history references, rather
1039 than the logical beginning of line."
1050 ;; This seems a bit complex. We look for references such as !!, !-num,
1051 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1052 ;; If that wasn't enough, the plings can be suffixed with argument
1053 ;; range specifiers.
1054 ;; Argument ranges are complex too, so we hive off the input line,
1055 ;; referenced with plings, with the range string to `comint-args'.
1059 ;; The history is quoted, or we're in quotes.
1062 ;; We cannot know the interpreter's idea of input line numbers.
1066 ;; Just a number of args from `number' lines backward.
1075 t t)
1081 ;; Just a number of args from the previous input line.
1085 t t)
1089 ;; Most recent input starting with or containing (possibly
1090 ;; protected) string, maybe just a number of args. Phew.
1108 t t)
1111 ;; Quick substitution on the previous input line.
1128 "Expand input history references before point and insert ARG spaces.
1129 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1133 \f
1135 "Return t if the number of quotes between BEG and END is odd.
1136 Quotes are single and double."
1142 "Return number of matches for REGEXP from BEG to END."
1149 count))
1152 ;; From STRING, return the args depending on the range specified in the text
1153 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1154 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1170 ;; Return a list of arguments from ARG. Break it up at the
1171 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1186 comint-delimiter-argument-list)))
1189 args)))
1192 "Return from STRING the NTH to MTH arguments.
1193 NTH and/or MTH can be nil, which means the last argument.
1194 Returned arguments are separated by single spaces.
1195 We assume whitespace separates arguments, except within quotes
1196 and except for a space or tab that immediately follows a backslash.
1197 Also, a run of one or more of a single character
1198 in `comint-delimiter-argument-list' is a separate argument.
1199 Argument 0 is the command name."
1200 ;; The first line handles ordinary characters and backslash-sequences
1201 ;; (except with w32 msdos-like shells, where backslashes are valid).
1202 ;; The second matches "-quoted strings.
1203 ;; The third matches '-quoted strings.
1204 ;; The fourth matches `-quoted strings.
1205 ;; This seems to fit the syntax of BASH 2.0.
1216 beg str value quotes)
1217 ;; Build a list of all the args until we have as many as we want.
1221 ;; It's contiguous, part of the same arg.
1224 ;; It's a new separate arg.
1226 ;; Put the previous arg, if there was one, onto ARGS.
1243 \f
1244 ;;
1245 ;; Input processing stuff
1246 ;;
1249 "Send input to process.
1250 After the process output mark, sends all text from the process mark to
1251 point as input to the process. Before the process output mark, calls value
1252 of variable `comint-get-old-input' to retrieve old input, copies it to the
1253 process mark, and sends it. If variable `comint-process-echoes' is nil,
1254 a terminal newline is also inserted into the buffer and sent to the process
1255 \(if it is non-nil, all text from the process mark to point is deleted,
1256 since it is assumed the remote process will re-echo it).
1258 Any history reference may be expanded depending on the value of the variable
1259 `comint-input-autoexpand'. The list of function names contained in the value
1260 of `comint-input-filter-functions' is called on the input before sending it.
1261 The input is entered into the input history ring, if the value of variable
1262 `comint-input-filter' returns non-nil when called on the input.
1264 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1265 end of line before sending the input.
1267 The values of `comint-get-old-input', `comint-input-filter-functions', and
1268 `comint-input-filter' are chosen according to the command interpreter running
1269 in the buffer. E.g.,
1271 If the interpreter is the csh,
1272 comint-get-old-input is the default: take the current line, discard any
1273 initial string matching regexp comint-prompt-regexp.
1276 comint-input-filter is the default: returns t if the input isn't all white
1277 space.
1279 If the comint is Lucid Common Lisp,
1280 comint-get-old-input snarfs the sexp ending at point.
1281 comint-input-filter-functions does nothing.
1282 comint-input-filter returns nil if the input matches input-filter-regexp,
1283 which matches (1) all whitespace (2) :a, :c, etc.
1285 Similarly for Soar, Scheme, etc."
1287 ;; Note that the input string does not include its terminal newline.
1297 copy)))
1299 ;; Just whatever's already there
1300 intxt
1301 ;; Expand and leave it visible in buffer
1305 input
1306 ;; This is messy 'cos ultimately the original
1307 ;; functions used do insertion, rather than return
1308 ;; strings. We have to expand, then insert back.
1314 copy))))
1323 history))))
1329 ;; Update the markers before we send the input
1330 ;; in case we get output amidst sending the input.
1334 ;; clear the "accumulation" marker
1337 ;; This used to call comint-output-filter-functions,
1338 ;; but that scrolled the buffer in undesirable ways.
1342 "Functions to call before output is inserted into the buffer.
1343 These functions get one argument, a string containing the text to be
1344 inserted. They return the string as it should be inserted.
1348 ;; The purpose of using this filter for comint processes
1349 ;; is to keep comint-last-input-end from moving forward
1350 ;; when output is inserted.
1353 ;; First check for killed buffer or no input.
1372 ;; Insert after old_begv, but before old_zv.
1378 ;; Don't insert initial prompt outside the top of the window.
1394 "Go to the end of buffer in all windows showing it.
1395 Movement occurs if point in the selected window is not after the process mark,
1396 and `this-command' is an insertion command. Insertion commands recognised
1397 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1398 Depends on the value of `comint-scroll-to-bottom-on-input'.
1400 This function should be a pre-command hook."
1403 hilit-yank)))
1419 nil t))))))
1422 "Go to the end of buffer in all windows showing it.
1423 Does not scroll if the current line is the last line in the buffer.
1424 Depends on the value of `comint-scroll-to-bottom-on-output' and
1425 `comint-scroll-show-maximum-output'.
1427 This function should be in the list `comint-output-filter-functions'."
1441 ;; Maybe user wants point to jump to end.
1444 ;; If point was at the end, keep it at end.
1448 ;; Optionally scroll so that the text
1449 ;; ends at the bottom of the window.
1456 nil t))
1460 "Truncate the buffer to `comint-buffer-maximum-size'.
1461 This function could be on `comint-output-filter-functions' or bound to a key."
1470 "Strip trailing `^M' characters from the current output group.
1471 This function could be on `comint-output-filter-functions' or bound to a key."
1484 "Put the end of the buffer at the bottom of the window."
1490 "Default for `comint-get-old-input'.
1491 Take the current line, and discard any initial text matching
1492 `comint-prompt-regexp'."
1501 "Insert after prompt old input at point as new input to be edited.
1502 Calls `comint-get-old-input' to get old input."
1512 "Skip past the text matching regexp `comint-prompt-regexp'.
1513 If this takes us past the end of the current line, don't skip at all."
1520 "Return t if point is after the process output marker."
1525 "Default function for sending to PROC input STRING.
1526 This just sends STRING plus a newline. To override this,
1527 set the hook `comint-input-sender'."
1532 "Goes to the beginning of line, then skips past the prompt, if any.
1535 The prompt skip is done by skipping text matching the regular expression
1536 `comint-prompt-regexp', a buffer local variable."
1541 ;; These three functions are for entering text you don't want echoed or
1542 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1543 ;; Just enter m-x send-invisible and type in your line, or add
1544 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1547 "Read a single line of text from user without echoing, and return it.
1548 Prompt with argument PROMPT, a string. Optional argument STARS causes
1549 input to be echoed with '*' characters on the prompt line. Input ends with
1550 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1551 `inhibit-quit' is set because e.g. this function was called from a process
1552 filter and C-g is pressed, this function returns nil rather than a string).
1554 Note that the keystrokes comprising the text can still be recovered
1556 Once the caller uses the password, it can erase the password
1557 by doing (fillarray STRING 0)."
1569 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1572 ;; This function may get called from a process filter, where
1573 ;; inhibit-quit is set. In later versions of emacs read-char
1574 ;; may clear quit-flag itself and return C-g. That would make
1575 ;; it impossible to quit this loop in a simple way, so
1576 ;; re-enable it here (for backward-compatibility the check for
1577 ;; quit-flag below would still be necessary, so this seems
1578 ;; like the simplest way to do things).
1580 done t))
1594 ;; Emulate a true quit, except that we have to return a value.
1600 ans)))
1603 "Read a string without echoing.
1604 Then send it to the process running in the current buffer.
1605 The string is sent using `comint-input-sender'.
1606 Security bug: your string can still be temporarily recovered with
1621 "Prompt in the minibuffer for password and send without echoing.
1622 This function uses `send-invisible' to read and send a password to the buffer's
1623 process if STRING contains a password prompt defined by
1624 `comint-password-prompt-regexp'.
1626 This function could be in the list `comint-output-filter-functions'."
1629 \f
1630 ;; Low-level process communication
1634 \f
1635 ;; Random input hackage
1638 "Kill all output from interpreter since last input.
1639 Does not delete the prompt."
1652 ;; Output message and put back prompt
1656 "Display start of this batch of interpreter output at top of window.
1657 Sets mark to the value of point when this command is run."
1667 "Interrupt the current subjob.
1668 This command also kills the pending input
1669 between the process-mark and point."
1675 "Send kill signal to the current subjob.
1676 This command also kills the pending input
1677 between the process-mark and point."
1683 "Send quit signal to the current subjob.
1684 This command also kills the pending input
1685 between the process-mark and point."
1691 "Stop the current subjob.
1692 This command also kills the pending input
1693 between the process-mark and point.
1695 WARNING: if there is no current subjob, you can end up suspending
1696 the top-level process running in the buffer. If you accidentally do
1698 is not a problem with most shells, since they ignore this signal.)"
1704 "Send CONT signal to process buffer's process group.
1705 Useful if you accidentally suspend the top-level process."
1710 "Kill all text from last stuff output by interpreter to point."
1717 "Delete ARG characters forward or send an EOF to subprocess.
1718 Sends an EOF only if point is at the end of the buffer and there is no input."
1726 "Send an EOF to the current buffer's process."
1732 "Search backward through buffer for match for REGEXP.
1733 Matches are searched for on lines that match `comint-prompt-regexp'.
1734 With prefix argument N, search for Nth previous match.
1735 If N is negative, find the next or Nth next match."
1748 "Search forward through buffer for match for REGEXP.
1749 Matches are searched for on lines that match `comint-prompt-regexp'.
1750 With prefix argument N, search for Nth following match.
1751 If N is negative, find the previous or Nth previous match."
1757 "Move to end of Nth next prompt in the buffer.
1758 See `comint-prompt-regexp'."
1766 "Move to end of Nth previous prompt in the buffer.
1767 See `comint-prompt-regexp'."
1770 \f
1771 ;; Support for source-file processing commands.
1772 ;;============================================================================
1773 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1774 ;; commands that process files of source text (e.g. loading or compiling
1775 ;; files). So the corresponding process-in-a-buffer modes have commands
1776 ;; for doing this (e.g., lisp-load-file). The functions below are useful
1777 ;; for defining these commands.
1778 ;;
1779 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1780 ;; and Soar, in that they don't know anything about file extensions.
1781 ;; So the compile/load interface gets the wrong default occasionally.
1782 ;; The load-file/compile-file default mechanism could be smarter -- it
1783 ;; doesn't know about the relationship between filename extensions and
1784 ;; whether the file is source or executable. If you compile foo.lisp
1785 ;; with compile-file, then the next load-file should use foo.bin for
1786 ;; the default, not foo.lisp. This is tricky to do right, particularly
1787 ;; because the extension for executable files varies so much (.o, .bin,
1788 ;; .lbin, .mo, .vo, .ao, ...).
1791 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1792 ;; commands.
1793 ;;
1794 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1795 ;; want to save the buffer before issuing any process requests to the command
1796 ;; interpreter.
1797 ;;
1798 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1799 ;; for the file to process.
1801 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1802 ;;============================================================================
1803 ;; This function computes the defaults for the load-file and compile-file
1804 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
1805 ;;
1806 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1807 ;; source-file processing command. NIL if there hasn't been one yet.
1808 ;; - SOURCE-MODES is a list used to determine what buffers contain source
1809 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1810 ;; Typically, (lisp-mode) or (scheme-mode).
1811 ;;
1812 ;; If the command is given while the cursor is inside a string, *and*
1813 ;; the string is an existing filename, *and* the filename is not a directory,
1814 ;; then the string is taken as default. This allows you to just position
1815 ;; your cursor over a string that's a filename and have it taken as default.
1816 ;;
1817 ;; If the command is given in a file buffer whose major mode is in
1818 ;; SOURCE-MODES, then the the filename is the default file, and the
1819 ;; file's directory is the default directory.
1820 ;;
1821 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1822 ;; then the default directory & file are what was used in the last source-file
1823 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1824 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1825 ;; is the cwd, with no default file. (\"no default file\" = nil)
1826 ;;
1827 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1828 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1829 ;; for Soar programs, etc.
1830 ;;
1831 ;; The function returns a pair: (default-directory . default-file).
1842 ;; (COMINT-CHECK-SOURCE fname)
1843 ;;============================================================================
1844 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1845 ;; process-in-a-buffer modes), this function can be called on the filename.
1846 ;; If the file is loaded into a buffer, and the buffer is modified, the user
1847 ;; is queried to see if he wants to save the buffer before proceeding with
1848 ;; the load or compile.
1855 ;; save BUFF.
1862 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1863 ;;============================================================================
1864 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1865 ;; commands that process source files (like loading or compiling a file).
1866 ;; It prompts for the filename, provides a default, if there is one,
1867 ;; and returns the result filename.
1868 ;;
1869 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1870 ;;
1871 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1872 ;; from the last source processing command. SOURCE-MODES is a list of major
1873 ;; modes used to determine what file buffers contain source files. (These
1874 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1875 ;; then the filename reader will only accept a file that exists.
1876 ;;
1877 ;; A typical use:
1878 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1879 ;; '(lisp-mode) t))
1881 ;; This is pretty stupid about strings. It decides we're in a string
1882 ;; if there's a quote on both sides of point on the current line.
1884 "Return string around POINT that starts the current line, or nil."
1911 prompt deffile)
1912 prompt)
1913 defdir
1915 mustmatch-p)))
1918 ;; I am somewhat divided on this string-default feature. It seems
1919 ;; to violate the principle-of-least-astonishment, in that it makes
1920 ;; the default harder to predict, so you actually have to look and see
1921 ;; what the default really is before choosing it. This can trip you up.
1922 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
1923 ;; on this.
1924 ;; -Olin
1926 \f
1927 ;; Simple process query facility.
1928 ;; ===========================================================================
1929 ;; This function is for commands that want to send a query to the process
1930 ;; and show the response to the user. For example, a command to get the
1931 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1932 ;; to an inferior Common Lisp process.
1933 ;;
1934 ;; This simple facility just sends strings to the inferior process and pops
1935 ;; up a window for the process buffer so you can see what the process
1936 ;; responds with. We don't do anything fancy like try to intercept what the
1937 ;; process responds with and put it in a pop-up window or on the message
1938 ;; line. We just display the buffer. Low tech. Simple. Works good.
1940 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
1941 ;; a window for the inferior process so that its response can be seen.
1951 ;; Try to position the proc window so you can see the answer.
1952 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1953 ;; I don't know why. Wizards invited to improve it.
1962 \f
1963 ;; Filename/command/history completion in a buffer
1964 ;; ===========================================================================
1965 ;; Useful completion functions, courtesy of the Ergo group.
1967 ;; Six commands:
1968 ;; comint-dynamic-complete Complete or expand command, filename,
1969 ;; history at point.
1970 ;; comint-dynamic-complete-filename Complete filename at point.
1971 ;; comint-dynamic-list-filename-completions List completions in help buffer.
1972 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
1973 ;; replace with expanded/completed name.
1974 ;; comint-dynamic-simple-complete Complete stub given candidates.
1976 ;; These are not installed in the comint-mode keymap. But they are
1977 ;; available for people who want them. Shell-mode installs them:
1978 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1979 ;; (define-key shell-mode-map "\M-?"
1980 ;; 'comint-dynamic-list-filename-completions)))
1981 ;;
1982 ;; Commands like this are fine things to put in load hooks if you
1983 ;; want them present in specific modes.
1986 "*If non-nil, automatically list possibilities on partial completion.
1987 This mirrors the optional behavior of tcsh."
1992 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1993 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
1994 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
1995 This mirrors the optional behavior of tcsh."
2000 "*If non-nil, use shortest completion if characters cannot be added.
2001 This mirrors the optional behavior of tcsh.
2003 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2008 "*List of suffixes to be disregarded during file completion.
2009 This mirrors the optional behavior of bash and tcsh.
2011 Note that this applies to `comint-dynamic-complete-filename' only."
2016 "Prefix prepended to absolute file names taken from process input.
2017 This is used by comint's and shell's completion functions, and by shell's
2022 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2024 "String of characters valid in a file name.
2025 Note that all non-ASCII characters are considered valid in a file name
2026 regardless of what this variable says.
2037 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2040 directory)))
2044 "Return the word of WORD-CHARS at point, or nil if non is found.
2045 Word constituents are considered to be those in WORD-CHARS, which is like the
2047 plus all non-ASCII characters."
2051 ;;(memq (char-after (point)) shell-file-name-quote-list)
2055 ;; Don't go forward over a word-char (this can happen if we're at bob).
2058 ;; Set match-data to match the entire string.
2064 "Return FILENAME with environment variables substituted.
2065 Supports additional environment variable syntax of the command
2066 interpreter (e.g., the percent notation of cmd.exe on NT)."
2070 env-var-val)
2079 name))
2082 "Return the filename at point, or nil if non is found.
2083 Environment variables are substituted. See `comint-word'."
2090 "Return FILENAME with magic characters quoted.
2091 Magic characters are those in `comint-file-name-quote-list'."
2093 filename
2100 filename))))
2103 "Return FILENAME with quoted characters unquoted."
2105 filename
2111 filename)))
2115 "Dynamically perform completion at point.
2116 Calls the functions in `comint-dynamic-complete-functions' to perform
2117 completion until a function returns non-nil, at which point completion is
2118 assumed to have occurred."
2124 "Dynamically complete the filename at point.
2125 Completes if after a filename. See `comint-match-partial-filename' and
2126 `comint-dynamic-complete-as-filename'.
2127 This function is similar to `comint-replace-by-expanded-filename', except that
2128 it won't change parts of the filename already entered in the buffer; it just
2129 adds completion characters to the end of the filename. A completions listing
2130 may be shown in a help buffer if completion is ambiguous.
2132 Completion is dependent on the value of `comint-completion-addsuffix',
2133 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2134 completions listing is dependent on the value of `comint-completion-autolist'.
2136 Returns t if successful."
2144 "Dynamically complete at point as a filename.
2145 See `comint-dynamic-complete-filename'. Returns t if successful."
2148 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2149 ;; I think it was originally bound to solve file completion problems,
2150 ;; but subsequent changes may have made this unnecessary. sm.
2151 ;;(file-name-handler-alist nil)
2186 ;; We inserted a unique completion.
2193 ;; It's not unique, but user wants shortest match.
2199 ;; It's not unique, list possible completions.
2204 success))
2208 "Dynamically expand and complete the filename at point.
2209 Replace the filename with an expanded, canonicalised and completed replacement.
2212 removed, and the filename is made absolute instead of relative. For expansion
2213 see `expand-file-name' and `substitute-in-file-name'. For completion see
2214 `comint-dynamic-complete-filename'."
2221 "Dynamically complete STUB from CANDIDATES list.
2222 This function inserts completion characters at point by completing STUB from
2223 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2224 if completion is ambiguous.
2226 Returns nil if no completion was inserted.
2227 Returns `sole' if completed with the only completion match.
2228 Returns `shortest' if completed with the shortest of the completion matches.
2229 Returns `partial' if completed as far as possible with the completion matches.
2230 Returns `listed' if a completion listing was shown.
2232 See also `comint-dynamic-complete-filename'."
2241 nil)
2252 ;; Insert the longest substring.
2257 ;; It's not unique, but user wants shortest match.
2263 ;; It's not unique, list possible completions.
2272 "List in help buffer possible completions of the filename at point."
2275 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2276 ;; I think it was originally bound to solve file completion problems,
2277 ;; but subsequent changes may have made this unnecessary. sm.
2278 ;;(file-name-handler-alist nil)
2291 "List in help buffer sorted COMPLETIONS.
2292 Typing SPC flushes the help buffer."
2306 ;; If the user does mouse-choose-completion with the mouse,
2307 ;; execute the command, then delete the completion window.
2314 \f
2316 "After fetching a line from input history, this fetches the following line.
2317 In other words, this recalls the input line after the line you recalled last.
2318 You can use this to repeat a sequence of input lines."
2327 "Accumulate a line to send as input along with more lines.
2328 This inserts a newline so that you can enter more text
2330 to send all the accumulated input, at once.
2331 The entire accumulated text becomes one item in the input history
2332 when you send it."
2341 "Move point to the process mark.
2342 The process mark separates output, and input already sent,
2343 from input that has not yet been sent."
2351 "Move point to beginning of line (after prompt) or to the process mark.
2352 The first time you use this command, it moves to the beginning of the line
2353 \(but after the prompt, if any). If you repeat it again immediately,
2354 it moves point to the process mark.
2356 The process mark separates the process output, along with input already sent,
2357 from input that has not yet been sent. Ordinarily, the process mark
2358 is at the beginning of the current input line; but if you have
2360 the process mark is at the beginning of the accumulated input."
2367 "Set the process mark at point."
2374 \f
2375 ;; Converting process modes to use comint mode
2376 ;; ===========================================================================
2377 ;; The code in the Emacs 19 distribution has all been modified to use comint
2378 ;; where needed. However, there are `third-party' packages out there that
2379 ;; still use the old shell mode. Here's a guide to conversion.
2380 ;;
2381 ;; Renaming variables
2382 ;; Most of the work is renaming variables and functions. These are the common
2383 ;; ones:
2384 ;; Local variables:
2385 ;; last-input-start comint-last-input-start
2386 ;; last-input-end comint-last-input-end
2387 ;; shell-prompt-pattern comint-prompt-regexp
2388 ;; shell-set-directory-error-hook <no equivalent>
2389 ;; Miscellaneous:
2390 ;; shell-set-directory <unnecessary>
2391 ;; shell-mode-map comint-mode-map
2392 ;; Commands:
2393 ;; shell-send-input comint-send-input
2394 ;; shell-send-eof comint-delchar-or-maybe-eof
2395 ;; kill-shell-input comint-kill-input
2396 ;; interrupt-shell-subjob comint-interrupt-subjob
2397 ;; stop-shell-subjob comint-stop-subjob
2398 ;; quit-shell-subjob comint-quit-subjob
2399 ;; kill-shell-subjob comint-kill-subjob
2400 ;; kill-output-from-shell comint-kill-output
2401 ;; show-output-from-shell comint-show-output
2402 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
2403 ;;
2404 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2405 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2406 ;; Comint mode does not provide functionality equivalent to
2407 ;; shell-set-directory-error-hook; it is gone.
2408 ;;
2409 ;; comint-last-input-start is provided for modes which want to munge
2410 ;; the buffer after input is sent, perhaps because the inferior
2411 ;; insists on echoing the input. The LAST-INPUT-START variable in
2412 ;; the old shell package was used to implement a history mechanism,
2413 ;; but you should think twice before using comint-last-input-start
2414 ;; for this; the input history ring often does the job better.
2415 ;;
2416 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2417 ;; *not* create the comint-mode local variables in your foo-mode function.
2418 ;; This is not modular. Instead, call comint-mode, and let *it* create the
2419 ;; necessary comint-specific local variables. Then create the
2420 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2421 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2422 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2423 ;; get-old-input) that need to be different from the defaults. Call
2424 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2425 ;; comint-mode will take care of it. The following example, from shell.el,
2426 ;; is typical:
2427 ;;
2428 ;; (defvar shell-mode-map '())
2429 ;; (cond ((not shell-mode-map)
2430 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
2431 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2432 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2433 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2434 ;; (define-key shell-mode-map "\M-?"
2435 ;; 'comint-dynamic-list-filename-completions)))
2436 ;;
2437 ;; (defun shell-mode ()
2438 ;; (interactive)
2439 ;; (comint-mode)
2440 ;; (setq comint-prompt-regexp shell-prompt-pattern)
2441 ;; (setq major-mode 'shell-mode)
2442 ;; (setq mode-name "Shell")
2443 ;; (use-local-map shell-mode-map)
2444 ;; (make-local-variable 'shell-directory-stack)
2445 ;; (setq shell-directory-stack nil)
2446 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2447 ;; (run-hooks 'shell-mode-hook))
2448 ;;
2449 ;;
2450 ;; Completion for comint-mode users
2451 ;;
2452 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2453 ;; hook to add completion functions to. Functions on this list should return
2454 ;; non-nil if completion occurs (i.e., further completion should not occur).
2455 ;; You could use comint-dynamic-simple-complete to do the bulk of the
2456 ;; completion job.
2457 \f
2460 ;; comint.el ends here