(src/Makefile, lib-src/Makefile): Delete ^L. Fix definition of $undefs.
[bpt/emacs.git] / lisp / comint.el
CommitLineData
c0274f38 1;;; comint.el --- general command interpreter in a window stuff
e41b2db1 2
42453245 3;; Copyright (C) 1988, 1990, 1992, 1993, 1994 Free Software Foundation, Inc.
c0274f38 4
1586b965 5;; Author: Olin Shivers <shivers@cs.cmu.edu>
3ee91e68 6;; Adapted-by: Simon Marshall <s.marshall@dcs.hull.ac.uk>
e9571d2a 7;; Keywords: processes
3a801d0c 8
1586b965 9;; This file is part of GNU Emacs.
be9b65ac 10
1586b965
RS
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.
be9b65ac 15
1586b965
RS
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.
be9b65ac 20
1586b965
RS
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.
be9b65ac 24
e5167999
ER
25;;; Commentary:
26
49116ac0
JB
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)
3ee91e68 30;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk)
49116ac0 31
be9b65ac
DL
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.).
38
49116ac0 39;;; Several packages are already defined using comint mode:
735b3061 40;;; - shell.el defines a shell-in-a-buffer mode.
49116ac0 41;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
49116ac0
JB
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.
50
be9b65ac
DL
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.
55
49116ac0
JB
56;;; For hints on converting existing process modes (e.g., tex-mode,
57;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
be9b65ac
DL
58;;; instead of shell-mode, see the notes at the end of this file.
59
be9b65ac 60\f
49116ac0
JB
61;;; Brief Command Documentation:
62;;;============================================================================
735b3061 63;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
49116ac0
JB
64;;; mode)
65;;;
66;;; m-p comint-previous-input Cycle backwards in input history
67;;; m-n comint-next-input Cycle forwards
3ee91e68
RS
68;;; m-r comint-previous-matching-input Previous input matching a regexp
69;;; m-s comint-next-matching-input Next input that matches
d637fa56 70;;; m-c-l comint-show-output Show last batch of process output
49116ac0 71;;; return comint-send-input
3ee91e68
RS
72;;; c-a comint-bol Beginning of line; skip prompt
73;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
49116ac0
JB
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
3ee91e68 81;;; c-c c-h comint-dynamic-list-input-ring List input history
49116ac0 82;;;
3ee91e68 83;;; Not bound by default in comint-mode (some are in shell mode)
21d9bf27 84;;; comint-run Run a program under comint-mode
be9b65ac 85;;; send-invisible Read a line w/o echo, and send to proc
3ee91e68
RS
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.
be9b65ac
DL
89;;; comint-replace-by-expanded-filename Expand and complete filename at point;
90;;; replace with expanded/completed name.
3ee91e68
RS
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).
49116ac0 94;;; comint-kill-subjob No mercy.
3ee91e68 95;;; comint-show-maximum-output Show as much output as possible.
49116ac0
JB
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).
49116ac0
JB
99
100;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
be9b65ac 101
e5167999
ER
102;;; Code:
103
c9706a52 104(require 'ring)
be9b65ac
DL
105\f
106;;; Buffer Local Variables:
107;;;============================================================================
108;;; Comint mode buffer local variables:
3ee91e68
RS
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
49116ac0 112;;; comint-last-input-end - marker For comint-kill-output command
e6dfdce5
RS
113;;; comint-input-ring-size - integer For the input history
114;;; comint-input-ring - ring mechanism
0c5c1f34 115;;; comint-input-ring-index - number ...
3ee91e68
RS
116;;; comint-input-autoexpand - symbol ...
117;;; comint-input-ignoredups - boolean ...
be9b65ac 118;;; comint-last-input-match - string ...
1b421826 119;;; comint-dynamic-complete-functions - hook For the completion mechanism
497513ad 120;;; comint-completion-fignore - list ...
be9b65ac 121;;; comint-get-old-input - function Hooks for specific
fb9ab28a
RS
122;;; comint-input-filter-functions - hook process-in-a-buffer
123;;; comint-output-filter-functions - hook function modes.
3ee91e68
RS
124;;; comint-input-filter - function ...
125;;; comint-input-send - function ...
126;;; comint-eol-on-send - boolean ...
127;;; comint-process-echoes - boolean ...
fdb7791d 128;;; comint-scroll-to-bottom-on-input - symbol For scroll behavior
1b421826
RS
129;;; comint-scroll-to-bottom-on-output - symbol ...
130;;; comint-scroll-show-maximum-output - boolean...
3ee91e68
RS
131;;;
132;;; Comint mode non-buffer local variables:
1b421826
RS
133;;; comint-completion-addsuffix - boolean For file name completion
134;;; comint-completion-autolist - boolean behavior
135;;; comint-completion-recexact - boolean ...
be9b65ac 136
49116ac0
JB
137(defvar comint-prompt-regexp "^"
138 "Regexp to recognise prompts in the inferior process.
139Defaults to \"^\", the null string at BOL.
be9b65ac
DL
140
141Good choices:
d637fa56 142 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
41752cf1
JB
143 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
144 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
49116ac0 145 kcl: \"^>+ *\"
d637fa56 146 shell: \"^[^#$%>\\n]*[#$%>] *\"
49116ac0 147 T: \"^>+ *\"
be9b65ac 148
49116ac0 149This is a good thing to set in mode hooks.")
be9b65ac 150
3ee91e68
RS
151(defvar comint-delimiter-argument-list ()
152 "List of characters to recognise as separate arguments in input.
153Strings comprising a character in this list will separate the arguments
154surrounding them, and also be regarded as arguments in their own right (unlike
155whitespace). See `comint-arguments'.
3f4b7c36 156Defaults to the empty list.
3ee91e68 157
3f4b7c36 158For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
3ee91e68
RS
159
160This is a good thing to set in mode hooks.")
161
94bd6573 162(defvar comint-input-autoexpand nil
3ee91e68 163 "*If non-nil, expand input command history references on completion.
fdb7791d 164This mirrors the optional behavior of tcsh (its autoexpand and histlit).
3ee91e68
RS
165
166If the value is `input', then the expansion is seen on input.
167If the value is `history', then the expansion is only when inserting
168into the buffer's input ring. See also `comint-magic-space' and
169`comint-dynamic-complete'.
170
171This variable is buffer-local.")
172
173(defvar comint-input-ignoredups nil
174 "*If non-nil, don't add input matching the last on the input ring.
fdb7791d 175This mirrors the optional behavior of bash.
3ee91e68
RS
176
177This variable is buffer-local.")
178
179(defvar comint-input-ring-file-name nil
180 "*If non-nil, name of the file to read/write input history.
181See also `comint-read-input-ring' and `comint-write-input-ring'.
182
183This variable is buffer-local, and is a good thing to set in mode hooks.")
184
91d75282 185(defvar comint-scroll-to-bottom-on-input nil
3ee91e68
RS
186 "*Controls whether input to interpreter causes window to scroll.
187If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
188If `this', scroll only the selected window.
189
91d75282 190The default is nil.
f4ef65c7 191
3ee91e68
RS
192See `comint-preinput-scroll-to-bottom'. This variable is buffer-local.")
193
91d75282 194(defvar comint-scroll-to-bottom-on-output nil
3ee91e68
RS
195 "*Controls whether interpreter output causes window to scroll.
196If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
197If `this', scroll only the selected window.
198If `others', scroll only those that are not the selected window.
91d75282
RS
199
200The default is nil.
f4ef65c7 201
3ee91e68
RS
202See variable `comint-scroll-show-maximum-output' and function
203`comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
91d75282 204
c541b39e 205(defvar comint-scroll-show-maximum-output nil
3ee91e68
RS
206 "*Controls how interpreter output causes window to scroll.
207If non-nil, then show the maximum output when the window is scrolled.
91d75282 208
3ee91e68
RS
209See variable `comint-scroll-to-bottom-on-output' and function
210`comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
91d75282 211
3ee91e68 212(defvar comint-input-ring-size 32
49116ac0 213 "Size of input history ring.")
be9b65ac 214
8ae3bc9f 215(defvar comint-process-echoes nil
cccd719e 216 "*If non-nil, assume that the subprocess echoes any input.
8ae3bc9f 217If so, delete one copy of the input so that only one copy eventually
3ee91e68 218appears in the buffer.
8ae3bc9f
NF
219
220This variable is buffer-local.")
221
be9b65ac 222;;; Here are the per-interpreter hooks.
49116ac0 223(defvar comint-get-old-input (function comint-get-old-input-default)
3ee91e68 224 "Function that returns old text in comint mode.
be9b65ac
DL
225This function is called when return is typed while the point is in old text.
226It returns the text to be submitted as process input. The default is
cccd719e
RS
227`comint-get-old-input-default', which grabs the current line, and strips off
228leading text matching `comint-prompt-regexp'.")
be9b65ac 229
1b421826
RS
230(defvar comint-dynamic-complete-functions
231 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
232 "List of functions called to perform completion.
233Functions should return non-nil if completion was performed.
234See also `comint-dynamic-complete'.
3ee91e68
RS
235
236This is a good thing to set in mode hooks.")
237
49116ac0
JB
238(defvar comint-input-filter
239 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
240 "Predicate for filtering additions to input history.
3ee91e68
RS
241Takes one argument, the input. If non-nil, the input may be saved on the input
242history list. Default is to save anything that isn't all whitespace.")
243
fb9ab28a 244(defvar comint-input-filter-functions '()
1b421826
RS
245 "Functions to call before input is sent to the process.
246These functions get one argument, a string containing the text to send.
247
248This variable is buffer-local.")
249
fb9ab28a 250(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
3ee91e68 251 "Functions to call after output is inserted into the buffer.
c1da5c03
RS
252One possible function is `comint-postoutput-scroll-to-bottom'.
253These functions get one argument, a string containing the text just inserted.
3ee91e68
RS
254
255This variable is buffer-local.")
49116ac0
JB
256
257(defvar comint-input-sender (function comint-simple-send)
258 "Function to actually send to PROCESS the STRING submitted by user.
cccd719e
RS
259Usually this is just `comint-simple-send', but if your mode needs to
260massage the input string, put a different function here.
261`comint-simple-send' just sends the string plus a newline.
262This is called from the user command `comint-send-input'.")
49116ac0 263
cccd719e 264(defvar comint-eol-on-send t
3ee91e68 265 "*Non-nil means go to the end of the line before sending input.
cccd719e 266See `comint-send-input'.")
be9b65ac
DL
267
268(defvar comint-mode-hook '()
49116ac0
JB
269 "Called upon entry into comint-mode
270This is run before the process is cranked up.")
271
272(defvar comint-exec-hook '()
cccd719e 273 "Called each time a process is exec'd by `comint-exec'.
49116ac0 274This is called after the process is cranked up. It is useful for things that
cccd719e
RS
275must be done each time a process is executed in a comint mode buffer (e.g.,
276`(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
49116ac0
JB
277executed once when the buffer is created.")
278
279(defvar comint-mode-map nil)
be9b65ac 280
c9706a52 281(defvar comint-ptyp t
3ee91e68 282 "Non-nil if communications via pty; false if by pipe. Buffer local.
cccd719e 283This is to work around a bug in Emacs process signalling.")
c9706a52 284
0bcb5285 285(defvar comint-input-ring nil)
e6dfdce5
RS
286(defvar comint-last-input-start)
287(defvar comint-last-input-end)
7d5d472e 288(defvar comint-last-output-start)
3ee91e68
RS
289(defvar comint-input-ring-index nil
290 "Index of last matched history element.")
291(defvar comint-matching-input-from-input-string ""
292 "Input previously used to match input history.")
21d9bf27
RS
293
294(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
c9706a52 295(put 'comint-input-ring 'permanent-local t)
3ee91e68
RS
296(put 'comint-input-ring-index 'permanent-local t)
297(put 'comint-input-autoexpand 'permanent-local t)
fb9ab28a
RS
298(put 'comint-input-filter-functions 'permanent-local t)
299(put 'comint-output-filter-functions 'permanent-local t)
3ee91e68
RS
300(put 'comint-scroll-to-bottom-on-input 'permanent-local t)
301(put 'comint-scroll-to-bottom-on-output 'permanent-local t)
302(put 'comint-scroll-show-maximum-output 'permanent-local t)
c9706a52 303(put 'comint-ptyp 'permanent-local t)
e6dfdce5 304
be9b65ac
DL
305(defun comint-mode ()
306 "Major mode for interacting with an inferior interpreter.
307Interpreter name is same as buffer name, sans the asterisks.
308Return at end of buffer sends line as input.
309Return not at end copies rest of line to end and sends it.
cccd719e 310Setting variable `comint-eol-on-send' means jump to the end of the line
49116ac0 311before submitting new input.
be9b65ac 312
3ee91e68
RS
313This mode is customised to create major modes such as Inferior Lisp
314mode, Shell mode, etc. This can be done by setting the hooks
fb9ab28a 315`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
3ee91e68 316and `comint-get-old-input' to appropriate functions, and the variable
cccd719e 317`comint-prompt-regexp' to the appropriate regular expression.
be9b65ac 318
cccd719e 319An input history is maintained of size `comint-input-ring-size', and
3ee91e68
RS
320can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
321Input ring history expansion can be achieved with the commands
322\\[comint-replace-by-expanded-history] or \\[comint-magic-space].
323Input ring expansion is controlled by the variable `comint-input-autoexpand',
324and addition is controlled by the variable `comint-input-ignoredups'.
325
cccd719e 326Commands with no default key bindings include `send-invisible',
21d9bf27 327`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
3ee91e68
RS
328`comint-magic-space'.
329
330Input to, and output from, the subprocess can cause the window to scroll to
fb9ab28a 331the end of the buffer. See variables `comint-output-filter-functions',
3ee91e68 332`comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
be9b65ac
DL
333
334If you accidentally suspend your process, use \\[comint-continue-subjob]
335to continue it.
336
337\\{comint-mode-map}
338
3ee91e68 339Entry to this mode runs the hooks on `comint-mode-hook'."
be9b65ac 340 (interactive)
3ee91e68
RS
341 ;; Do not remove this. All major modes must do this.
342 (kill-all-local-variables)
343 (setq major-mode 'comint-mode)
344 (setq mode-name "Comint")
345 (setq mode-line-process '(": %s"))
346 (use-local-map comint-mode-map)
347 (make-local-variable 'comint-last-input-start)
348 (setq comint-last-input-start (make-marker))
349 (make-local-variable 'comint-last-input-end)
350 (setq comint-last-input-end (make-marker))
351 (make-local-variable 'comint-last-output-start)
352 (setq comint-last-output-start (make-marker))
353 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
354 (make-local-variable 'comint-input-ring-size) ; ...to global val.
355 (make-local-variable 'comint-input-ring)
356 (make-local-variable 'comint-input-ring-file-name)
357 (or (and (boundp 'comint-input-ring) comint-input-ring)
358 (setq comint-input-ring (make-ring comint-input-ring-size)))
359 (make-local-variable 'comint-input-ring-index)
360 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
361 (setq comint-input-ring-index nil))
362 (make-local-variable 'comint-matching-input-from-input-string)
363 (make-local-variable 'comint-input-autoexpand)
364 (make-local-variable 'comint-input-ignoredups)
365 (make-local-variable 'comint-delimiter-argument-list)
1b421826 366 (make-local-variable 'comint-dynamic-complete-functions)
497513ad 367 (make-local-variable 'comint-completion-fignore)
3ee91e68 368 (make-local-variable 'comint-get-old-input)
fb9ab28a 369 (make-local-variable 'comint-input-filter-functions)
3ee91e68
RS
370 (make-local-variable 'comint-input-filter)
371 (make-local-variable 'comint-input-sender)
372 (make-local-variable 'comint-eol-on-send)
373 (make-local-variable 'comint-scroll-to-bottom-on-input)
374 (make-local-variable 'comint-scroll-to-bottom-on-output)
375 (make-local-variable 'comint-scroll-show-maximum-output)
c1da5c03
RS
376 (make-local-variable 'pre-command-hook)
377 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
fb9ab28a 378 (make-local-variable 'comint-output-filter-functions)
3ee91e68
RS
379 (make-local-variable 'comint-ptyp)
380 (make-local-variable 'comint-exec-hook)
381 (make-local-variable 'comint-process-echoes)
382 (run-hooks 'comint-mode-hook))
be9b65ac 383
49116ac0
JB
384(if comint-mode-map
385 nil
3ee91e68 386 ;; Keys:
49116ac0
JB
387 (setq comint-mode-map (make-sparse-keymap))
388 (define-key comint-mode-map "\ep" 'comint-previous-input)
389 (define-key comint-mode-map "\en" 'comint-next-input)
0c5c1f34
RS
390 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
391 (define-key comint-mode-map "\es" 'comint-next-matching-input)
3ee91e68
RS
392 (define-key comint-mode-map [?\A-\M-r] 'comint-previous-matching-input-from-input)
393 (define-key comint-mode-map [?\A-\M-s] 'comint-next-matching-input-from-input)
d637fa56 394 (define-key comint-mode-map "\e\C-l" 'comint-show-output)
49116ac0
JB
395 (define-key comint-mode-map "\C-m" 'comint-send-input)
396 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
397 (define-key comint-mode-map "\C-a" 'comint-bol)
398 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
399 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
400 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
401 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
402 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
3ee91e68 403 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
49116ac0 404 (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
49116ac0 405 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
3ee91e68
RS
406 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
407 (define-key comint-mode-map "\C-c\C-h" 'comint-dynamic-list-input-ring)
1de80a34 408 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
3ee91e68 409 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
1de80a34 410 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
3ee91e68
RS
411 ;; Menu bars:
412 ;; completion:
413 (define-key comint-mode-map [menu-bar completion]
dcab7fbd 414 (cons "Complete" (make-sparse-keymap "Complete")))
3ee91e68
RS
415 (define-key comint-mode-map [menu-bar completion complete-expand]
416 '("Expand File Name" . comint-replace-by-expanded-filename))
417 (define-key comint-mode-map [menu-bar completion complete-listing]
418 '("File Completion Listing" . comint-dynamic-list-filename-completions))
3ee91e68
RS
419 (define-key comint-mode-map [menu-bar completion complete-file]
420 '("Complete File Name" . comint-dynamic-complete-filename))
421 (define-key comint-mode-map [menu-bar completion complete]
422 '("Complete Before Point" . comint-dynamic-complete))
423 ;; Input history:
5c07a950 424 (define-key comint-mode-map [menu-bar inout]
dcab7fbd 425 (cons "In/Out" (make-sparse-keymap "In/Out")))
5c07a950 426 (define-key comint-mode-map [menu-bar inout kill-output]
dcab7fbd 427 '("Kill Current Output Group" . comint-kill-output))
5c07a950 428 (define-key comint-mode-map [menu-bar inout next-prompt]
dcab7fbd 429 '("Forward Output Group" . comint-next-prompt))
5c07a950 430 (define-key comint-mode-map [menu-bar inout previous-prompt]
dcab7fbd 431 '("Backward Output Group" . comint-previous-prompt))
5c07a950 432 (define-key comint-mode-map [menu-bar inout show-maximum-output]
dcab7fbd 433 '("Show Maximum Output" . comint-show-maximum-output))
5c07a950 434 (define-key comint-mode-map [menu-bar inout show-output]
dcab7fbd 435 '("Show Current Output Group" . comint-show-output))
5c07a950 436 (define-key comint-mode-map [menu-bar inout kill-input]
3ee91e68 437 '("Kill Current Input" . comint-kill-input))
5c07a950 438 (define-key comint-mode-map [menu-bar inout copy-input]
3ee91e68 439 '("Copy Old Input" . comint-copy-old-input))
5c07a950 440 (define-key comint-mode-map [menu-bar inout forward-matching-history]
dcab7fbd 441 '("Forward Matching Input..." . comint-forward-matching-input))
5c07a950 442 (define-key comint-mode-map [menu-bar inout backward-matching-history]
dcab7fbd 443 '("Backward Matching Input..." . comint-backward-matching-input))
5c07a950 444 (define-key comint-mode-map [menu-bar inout next-matching-history]
3ee91e68 445 '("Next Matching Input..." . comint-next-matching-input))
5c07a950 446 (define-key comint-mode-map [menu-bar inout previous-matching-history]
3ee91e68 447 '("Previous Matching Input..." . comint-previous-matching-input))
5c07a950 448 (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
3ee91e68 449 '("Next Matching Current Input" . comint-next-matching-input-from-input))
5c07a950 450 (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
3ee91e68 451 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
5c07a950 452 (define-key comint-mode-map [menu-bar inout next-history]
3ee91e68 453 '("Next Input" . comint-next-input))
5c07a950 454 (define-key comint-mode-map [menu-bar inout previous-history]
3ee91e68 455 '("Previous Input" . comint-previous-input))
5c07a950 456 (define-key comint-mode-map [menu-bar inout list-history]
3ee91e68 457 '("List Input History" . comint-dynamic-list-input-ring))
5c07a950 458 (define-key comint-mode-map [menu-bar inout expand-history]
3ee91e68 459 '("Expand History Before Point" . comint-replace-by-expanded-history))
3ee91e68
RS
460 ;; Signals
461 (define-key comint-mode-map [menu-bar signals]
462 (cons "Signals" (make-sparse-keymap "Signals")))
463 (define-key comint-mode-map [menu-bar signals eof]
464 '("EOF" . comint-send-eof))
465 (define-key comint-mode-map [menu-bar signals kill]
466 '("KILL" . comint-kill-subjob))
467 (define-key comint-mode-map [menu-bar signals quit]
468 '("QUIT" . comint-quit-subjob))
469 (define-key comint-mode-map [menu-bar signals cont]
470 '("CONT" . comint-continue-subjob))
471 (define-key comint-mode-map [menu-bar signals stop]
472 '("STOP" . comint-stop-subjob))
473 (define-key comint-mode-map [menu-bar signals break]
474 '("BREAK" . comint-interrupt-subjob))
475 ;; Put them in the menu bar:
5c07a950 476 (setq menu-bar-final-items (append '(completion inout signals)
3ee91e68 477 menu-bar-final-items))
49116ac0
JB
478 )
479
49116ac0 480(defun comint-check-proc (buffer)
3ee91e68 481 "Return t if there is a living process associated w/buffer BUFFER.
cccd719e
RS
482Living means the status is `run' or `stop'.
483BUFFER can be either a buffer or the name of one."
49116ac0
JB
484 (let ((proc (get-buffer-process buffer)))
485 (and proc (memq (process-status proc) '(run stop)))))
be9b65ac
DL
486
487;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
488;;; for the second argument (program).
eb6e9899 489;;;###autoload
be9b65ac 490(defun make-comint (name program &optional startfile &rest switches)
14a08856
RM
491 "Make a comint process NAME in a buffer, running PROGRAM.
492The name of the buffer is made by surrounding NAME with `*'s.
493If there is already a running process in that buffer, it is not restarted.
494Optional third arg STARTFILE is the name of a file to send the contents of to
495the process. Any more args are arguments to PROGRAM."
49116ac0 496 (let ((buffer (get-buffer-create (concat "*" name "*"))))
be9b65ac 497 ;; If no process, or nuked process, crank up a new one and put buffer in
14a08856 498 ;; comint mode. Otherwise, leave buffer and existing process alone.
1ff6cf10 499 (cond ((not (comint-check-proc buffer))
49116ac0 500 (save-excursion
be9b65ac
DL
501 (set-buffer buffer)
502 (comint-mode)) ; Install local vars, mode, keymap, ...
503 (comint-exec buffer name program startfile switches)))
504 buffer))
505
21d9bf27
RS
506;;;###autoload
507(defun comint-run (program)
508 "Run PROGRAM in a comint buffer and switch to it.
509The buffer name is made by surrounding the file name of PROGRAM with `*'s.
510The file name is used to make a symbol name, such as `comint-sh-hook', and any
511hooks on this symbol are run in the buffer.
512See `make-comint' and `comint-exec'."
513 (interactive "sRun program: ")
514 (let ((name (file-name-nondirectory program)))
515 (switch-to-buffer (make-comint name program))
516 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
517
be9b65ac 518(defun comint-exec (buffer name command startfile switches)
cccd719e 519 "Start up a process in buffer BUFFER for comint modes.
14a08856 520Blasts any old process running in the buffer. Doesn't set the buffer mode.
49116ac0 521You can use this to cheaply run a series of processes in the same comint
cccd719e 522buffer. The hook `comint-exec-hook' is run after each exec."
be9b65ac
DL
523 (save-excursion
524 (set-buffer buffer)
525 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
526 (if proc (delete-process proc)))
527 ;; Crank up a new process
528 (let ((proc (comint-exec-1 name buffer command switches)))
3ee91e68 529 (set-process-filter proc 'comint-output-filter)
49116ac0
JB
530 (make-local-variable 'comint-ptyp)
531 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
be9b65ac 532 ;; Jump to the end, and set the process mark.
49116ac0 533 (goto-char (point-max))
87ef29fd 534 (set-marker (process-mark proc) (point))
be9b65ac
DL
535 ;; Feed it the startfile.
536 (cond (startfile
537 ;;This is guaranteed to wait long enough
538 ;;but has bad results if the comint does not prompt at all
539 ;; (while (= size (buffer-size))
540 ;; (sleep-for 1))
541 ;;I hope 1 second is enough!
542 (sleep-for 1)
543 (goto-char (point-max))
544 (insert-file-contents startfile)
545 (setq startfile (buffer-substring (point) (point-max)))
546 (delete-region (point) (point-max))
49116ac0
JB
547 (comint-send-string proc startfile)))
548 (run-hooks 'comint-exec-hook)
87ef29fd 549 buffer)))
be9b65ac
DL
550
551;;; This auxiliary function cranks up the process for comint-exec in
e065a56e 552;;; the appropriate environment.
be9b65ac
DL
553
554(defun comint-exec-1 (name buffer command switches)
1b421826 555 (let ((process-environment
1f9e761d
KH
556 (nconc
557 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
558 (list "EMACS=t" "TERM=unknown"
559 (format "COLUMNS=%d" (frame-width)))
560 (list "EMACS=t" "TERM=emacs"
561 (format "TERMCAP=emacs:co#%d:tc=unknown" (frame-width))))
562 process-environment)))
e065a56e 563 (apply 'start-process name buffer command switches)))
be9b65ac 564\f
3ee91e68 565;;; Input history processing in a buffer
be9b65ac 566;;; ===========================================================================
3ee91e68
RS
567;;; Useful input history functions, courtesy of the Ergo group.
568
569;;; Eleven commands:
570;;; comint-dynamic-list-input-ring List history in help buffer.
571;;; comint-previous-input Previous input...
572;;; comint-previous-matching-input ...matching a string.
573;;; comint-previous-matching-input-from-input ... matching the current input.
574;;; comint-next-input Next input...
575;;; comint-next-matching-input ...matching a string.
576;;; comint-next-matching-input-from-input ... matching the current input.
577;;; comint-backward-matching-input Backwards input...
578;;; comint-forward-matching-input ...matching a string.
579;;; comint-replace-by-expanded-history Expand history at point;
580;;; replace with expanded history.
581;;; comint-magic-space Expand history and insert space.
582;;;
1b421826 583;;; Three functions:
3ee91e68
RS
584;;; comint-read-input-ring Read into comint-input-ring...
585;;; comint-write-input-ring Write to comint-input-ring-file-name.
1b421826 586;;; comint-replace-by-expanded-history-before-point Workhorse function.
3ee91e68 587
d637fa56 588(defun comint-read-input-ring (&optional silent)
3ee91e68
RS
589 "Sets the buffer's `comint-input-ring' from a history file.
590The name of the file is given by the variable `comint-input-ring-file-name'.
591The history ring is of size `comint-input-ring-size', regardless of file size.
592If `comint-input-ring-file-name' is nil this function does nothing.
593
d637fa56
RS
594If the optional argument SILENT is non-nil, we say nothing about a
595failure to read the history file.
3ee91e68 596
d637fa56
RS
597This function is useful for major mode commands and mode hooks.
598
599The structure of the history file should be one input command per line,
600with the most recent command last.
3ee91e68 601See also `comint-input-ignoredups' and `comint-write-input-ring'."
07ccf0bc
RS
602 (cond ((or (null comint-input-ring-file-name)
603 (equal comint-input-ring-file-name ""))
3ee91e68
RS
604 nil)
605 ((not (file-readable-p comint-input-ring-file-name))
d637fa56
RS
606 (or silent
607 (message "Cannot read history file %s"
608 comint-input-ring-file-name)))
3ee91e68
RS
609 (t
610 (let ((history-buf (get-file-buffer comint-input-ring-file-name))
611 (ring (make-ring comint-input-ring-size)))
612 (save-excursion
613 (set-buffer (or history-buf
614 (find-file-noselect comint-input-ring-file-name)))
615 ;; Save restriction in case file is already visited...
616 ;; Watch for those date stamps in history files!
617 (save-excursion
618 (save-restriction
619 (widen)
620 (goto-char (point-min))
621 (while (re-search-forward "^\\s *\\([^#].*\\)\\s *$" nil t)
622 (let ((history (buffer-substring (match-beginning 1)
623 (match-end 1))))
624 (if (or (null comint-input-ignoredups)
625 (ring-empty-p ring)
626 (not (string-equal (ring-ref ring 0) history)))
627 (ring-insert ring history)))))
628 ;; Kill buffer unless already visited.
629 (if (null history-buf)
630 (kill-buffer nil))))
631 (setq comint-input-ring ring
632 comint-input-ring-index nil)))))
633
634(defun comint-write-input-ring ()
635 "Writes the buffer's `comint-input-ring' to a history file.
636The name of the file is given by the variable `comint-input-ring-file-name'.
637The original contents of the file are lost if `comint-input-ring' is not empty.
638If `comint-input-ring-file-name' is nil this function does nothing.
639
640Useful within process sentinels.
641
642See also `comint-read-input-ring'."
643 (cond ((or (null comint-input-ring-file-name)
07ccf0bc 644 (equal comint-input-ring-file-name "")
3ee91e68
RS
645 (null comint-input-ring) (ring-empty-p comint-input-ring))
646 nil)
647 ((not (file-writable-p comint-input-ring-file-name))
648 (message "Cannot write history file %s" comint-input-ring-file-name))
649 (t
650 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
651 (ring comint-input-ring)
652 (file comint-input-ring-file-name)
653 (index (ring-length ring)))
654 ;; Write it all out into a buffer first. Much faster, but messier,
655 ;; than writing it one line at a time.
656 (save-excursion
657 (set-buffer history-buf)
658 (erase-buffer)
659 (while (> index 0)
660 (setq index (1- index))
661 (insert (ring-ref ring index) ?\n))
662 (write-region (buffer-string) nil file nil 'no-message)
663 (kill-buffer nil))))))
664
665
666(defun comint-dynamic-list-input-ring ()
667 "List in help buffer the buffer's input history."
668 (interactive)
669 (if (or (not (ring-p comint-input-ring))
670 (ring-empty-p comint-input-ring))
671 (message "No history")
672 (let ((history nil)
673 (history-buffer " *Input History*")
674 (index (1- (ring-length comint-input-ring)))
675 (conf (current-window-configuration)))
676 ;; We have to build up a list ourselves from the ring vector.
677 (while (>= index 0)
678 (setq history (cons (ring-ref comint-input-ring index) history)
679 index (1- index)))
680 ;; Change "completion" to "history reference"
681 ;; to make the display accurate.
682 (with-output-to-temp-buffer history-buffer
683 (display-completion-list history)
684 (set-buffer history-buffer)
685 (forward-line 3)
686 (while (search-backward "completion" nil 'move)
687 (replace-match "history reference")))
688 (sit-for 0)
689 (message "Hit space to flush")
690 (let ((ch (read-event)))
691 (if (eq ch ?\ )
692 (set-window-configuration conf)
693 (setq unread-command-events (list ch)))))))
694
695
696(defun comint-regexp-arg (prompt)
697 ;; Return list of regexp and prefix arg using PROMPT.
698 (let* ((minibuffer-history-sexp-flag nil)
699 ;; Don't clobber this.
700 (last-command last-command)
701 (regexp (read-from-minibuffer prompt nil nil nil
702 'minibuffer-history-search-history)))
703 (list (if (string-equal regexp "")
704 (setcar minibuffer-history-search-history
705 (nth 1 minibuffer-history-search-history))
706 regexp)
707 (prefix-numeric-value current-prefix-arg))))
708
709(defun comint-search-arg (arg)
710 ;; First make sure there is a ring and that we are after the process mark
711 (cond ((not (comint-after-pmark-p))
712 (error "Not at command line"))
713 ((or (null comint-input-ring)
714 (ring-empty-p comint-input-ring))
715 (error "Empty input ring"))
716 ((zerop arg)
717 ;; arg of zero resets search from beginning, and uses arg of 1
718 (setq comint-input-ring-index nil)
719 1)
720 (t
721 arg)))
722
723(defun comint-search-start (arg)
724 ;; Index to start a directional search, starting at comint-input-ring-index
725 (if comint-input-ring-index
726 ;; If a search is running, offset by 1 in direction of arg
727 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
728 (ring-length comint-input-ring))
729 ;; For a new search, start from beginning or end, as appropriate
730 (if (>= arg 0)
731 0 ; First elt for forward search
732 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
733
734(defun comint-previous-input-string (arg)
735 "Return the string ARG places along the input ring.
736Moves relative to `comint-input-ring-index'."
737 (ring-ref comint-input-ring (if comint-input-ring-index
738 (mod (+ arg comint-input-ring-index)
739 (ring-length comint-input-ring))
740 arg)))
be9b65ac
DL
741
742(defun comint-previous-input (arg)
743 "Cycle backwards through input history."
744 (interactive "*p")
3ee91e68 745 (comint-previous-matching-input "." arg))
1586b965 746
be9b65ac
DL
747(defun comint-next-input (arg)
748 "Cycle forwards through input history."
749 (interactive "*p")
750 (comint-previous-input (- arg)))
751
3ee91e68
RS
752(defun comint-previous-matching-input-string (regexp arg)
753 "Return the string matching REGEXP ARG places along the input ring.
754Moves relative to `comint-input-ring-index'."
755 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
756 (if pos (ring-ref comint-input-ring pos))))
757
758(defun comint-previous-matching-input-string-position (regexp arg &optional start)
759 "Return the index matching REGEXP ARG places along the input ring.
760Moves relative to START, or `comint-input-ring-index'."
761 (if (or (not (ring-p comint-input-ring))
762 (ring-empty-p comint-input-ring))
763 (error "No history"))
764 (let* ((len (ring-length comint-input-ring))
765 (motion (if (> arg 0) 1 -1))
766 (n (mod (- (or start (comint-search-start arg)) motion) len))
767 (tried-each-ring-item nil)
768 (prev nil))
769 ;; Do the whole search as many times as the argument says.
770 (while (and (/= arg 0) (not tried-each-ring-item))
771 ;; Step once.
772 (setq prev n
773 n (mod (+ n motion) len))
774 ;; If we haven't reached a match, step some more.
775 (while (and (< n len) (not tried-each-ring-item)
776 (not (string-match regexp (ring-ref comint-input-ring n))))
777 (setq n (mod (+ n motion) len)
778 ;; If we have gone all the way around in this search.
779 tried-each-ring-item (= n prev)))
780 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
781 ;; Now that we know which ring element to use, if we found it, return that.
782 (if (string-match regexp (ring-ref comint-input-ring n))
783 n)))
784
0c5c1f34
RS
785(defun comint-previous-matching-input (regexp arg)
786 "Search backwards through input history for match for REGEXP.
787\(Previous history elements are earlier commands.)
788With prefix argument N, search for Nth previous match.
789If N is negative, find the next or Nth next match."
3ee91e68
RS
790 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
791 (setq arg (comint-search-arg arg))
792 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
793 ;; Has a match been found?
794 (if (null pos)
795 (error "Not found")
796 (setq comint-input-ring-index pos)
797 (message "History item: %d" (1+ pos))
798 (delete-region
799 ;; Can't use kill-region as it sets this-command
800 (process-mark (get-buffer-process (current-buffer))) (point))
801 (insert (ring-ref comint-input-ring pos)))))
0c5c1f34
RS
802
803(defun comint-next-matching-input (regexp arg)
804 "Search forwards through input history for match for REGEXP.
805\(Later history elements are more recent commands.)
806With prefix argument N, search for Nth following match.
807If N is negative, find the previous or Nth previous match."
3ee91e68 808 (interactive (comint-regexp-arg "Next input matching (regexp): "))
0c5c1f34 809 (comint-previous-matching-input regexp (- arg)))
be9b65ac 810
3ee91e68
RS
811(defun comint-previous-matching-input-from-input (arg)
812 "Search backwards through input history for match for current input.
813\(Previous history elements are earlier commands.)
814With prefix argument N, search for Nth previous match.
3f849529 815If N is negative, search forwards for the -Nth following match."
3ee91e68
RS
816 (interactive "p")
817 (if (not (memq last-command '(comint-previous-matching-input-from-input
818 comint-next-matching-input-from-input)))
819 ;; Starting a new search
820 (setq comint-matching-input-from-input-string
821 (buffer-substring
822 (process-mark (get-buffer-process (current-buffer)))
823 (point))
824 comint-input-ring-index nil))
825 (comint-previous-matching-input
826 (concat "^" (regexp-quote comint-matching-input-from-input-string))
827 arg))
828
829(defun comint-next-matching-input-from-input (arg)
830 "Search forwards through input history for match for current input.
3f849529
RS
831\(Following history elements are more recent commands.)
832With prefix argument N, search for Nth following match.
833If N is negative, search backwards for the -Nth previous match."
3ee91e68
RS
834 (interactive "p")
835 (comint-previous-matching-input-from-input (- arg)))
836
837
d637fa56 838(defun comint-replace-by-expanded-history (&optional silent)
3ee91e68 839 "Expand input command history references before point.
1b421826
RS
840Expansion is dependent on the value of `comint-input-autoexpand'.
841
3ee91e68
RS
842This function depends on the buffer's idea of the input history, which may not
843match the command interpreter's idea, assuming it has one.
844
845Assumes history syntax is like typical Un*x shells'. However, since emacs
846cannot know the interpreter's idea of input line numbers, assuming it has one,
847it cannot expand absolute input line number references.
848
d637fa56
RS
849If the optional argument SILENT is non-nil, never complain
850even if history reference seems erroneous.
851
1b421826
RS
852See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
853
854Returns t if successful."
3ee91e68 855 (interactive)
1b421826
RS
856 (if (and comint-input-autoexpand
857 (string-match "[!^]" (funcall comint-get-old-input)))
858 ;; Looks like there might be history references in the command.
859 (let ((previous-modified-tick (buffer-modified-tick)))
860 (message "Expanding history references...")
861 (comint-replace-by-expanded-history-before-point)
862 (/= previous-modified-tick (buffer-modified-tick)))))
863
864
865(defun comint-replace-by-expanded-history-before-point ()
866 "Expand directory stack reference before point.
867See `comint-replace-by-expanded-history'. Returns t if successful."
3ee91e68
RS
868 (save-excursion
869 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
870 (start (progn (comint-bol nil) (point))))
d637fa56
RS
871 (while (progn
872 (skip-chars-forward "^!^"
873 (save-excursion
874 (end-of-line nil) (- (point) toend)))
875 (< (point)
876 (save-excursion
877 (end-of-line nil) (- (point) toend))))
3ee91e68
RS
878 ;; This seems a bit complex. We look for references such as !!, !-num,
879 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
880 ;; If that wasn't enough, the plings can be suffixed with argument
881 ;; range specifiers.
882 ;; Argument ranges are complex too, so we hive off the input line,
883 ;; referenced with plings, with the range string to `comint-args'.
884 (setq comint-input-ring-index nil)
3ee91e68
RS
885 (cond ((or (= (preceding-char) ?\\)
886 (comint-within-quotes start (point)))
887 ;; The history is quoted, or we're in quotes.
d637fa56 888 (goto-char (1+ (point))))
3ee91e68
RS
889 ((looking-at "![0-9]+\\($\\|[^-]\\)")
890 ;; We cannot know the interpreter's idea of input line numbers.
891 (goto-char (match-end 0))
892 (message "Absolute reference cannot be expanded"))
893 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
894 ;; Just a number of args from `number' lines backward.
895 (let ((number (1- (string-to-number
896 (buffer-substring (match-beginning 1)
897 (match-end 1))))))
898 (if (<= number (ring-length comint-input-ring))
899 (progn
900 (replace-match
901 (comint-args (comint-previous-input-string number)
fb9ab28a
RS
902 (match-beginning 2) (match-end 2))
903 t t)
3ee91e68
RS
904 (setq comint-input-ring-index number)
905 (message "History item: %d" (1+ number)))
906 (goto-char (match-end 0))
907 (message "Relative reference exceeds input history size"))))
908 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
909 ;; Just a number of args from the previous input line.
910 (replace-match
911 (comint-args (comint-previous-input-string 0)
fb9ab28a
RS
912 (match-beginning 1) (match-end 1))
913 t t)
1b421826 914 (message "History item: previous"))
3ee91e68
RS
915 ((looking-at
916 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
917 ;; Most recent input starting with or containing (possibly
918 ;; protected) string, maybe just a number of args. Phew.
919 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
920 (mb2 (match-beginning 2)) (me2 (match-end 2))
921 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
922 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
923 (pos (save-match-data
924 (comint-previous-matching-input-string-position
925 (concat pref (regexp-quote exp)) 1))))
926 (if (null pos)
5a336c13
KH
927 (progn
928 (goto-char (match-end 0))
929 (or silent
930 (progn (message "Not found")
931 (ding))))
3ee91e68 932 (setq comint-input-ring-index pos)
3ee91e68
RS
933 (replace-match
934 (comint-args (ring-ref comint-input-ring pos)
fb9ab28a
RS
935 (match-beginning 4) (match-end 4))
936 t t)
1b421826 937 (message "History item: %d" (1+ pos)))))
3ee91e68
RS
938 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
939 ;; Quick substitution on the previous input line.
940 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
941 (new (buffer-substring (match-beginning 2) (match-end 2)))
942 (pos nil))
943 (replace-match (comint-previous-input-string 0) t t)
944 (setq pos (point))
945 (goto-char (match-beginning 0))
1b421826
RS
946 (if (not (search-forward old pos t))
947 (or silent
948 (error "Not found"))
949 (replace-match new t t)
950 (message "History item: substituted"))))
3ee91e68
RS
951 (t
952 (goto-char (match-end 0))))))))
953
954
955(defun comint-magic-space (arg)
956 "Expand input history references before point and insert ARG spaces.
957A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
958 (interactive "p")
959 (comint-replace-by-expanded-history)
960 (self-insert-command arg))
961\f
962(defun comint-within-quotes (beg end)
963 "Return t if the number of quotes between BEG and END is odd.
964Quotes are single and double."
965 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
966 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
967 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
968
969(defun comint-how-many-region (regexp beg end)
970 "Return number of matches for REGEXP from BEG to END."
971 (let ((count 0))
972 (save-excursion
973 (save-match-data
974 (goto-char beg)
975 (while (re-search-forward regexp end t)
976 (setq count (1+ count)))))
977 count))
978
979(defun comint-args (string begin end)
980 ;; From STRING, return the args depending on the range specified in the text
981 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
982 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
983 (save-match-data
984 (if (null begin)
985 (comint-arguments string 0 nil)
986 (let* ((range (buffer-substring
987 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
988 (nth (cond ((string-match "^[*^]" range) 1)
989 ((string-match "^-" range) 0)
990 ((string-equal range "$") nil)
991 (t (string-to-number range))))
992 (mth (cond ((string-match "[-*$]$" range) nil)
993 ((string-match "-" range)
994 (string-to-number (substring range (match-end 0))))
995 (t nth))))
996 (comint-arguments string nth mth)))))
997
3f4b7c36
RS
998;; Return a list of arguments from ARG. Break it up at the
999;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
3ee91e68 1000(defun comint-delim-arg (arg)
3f4b7c36 1001 (if (null comint-delimiter-argument-list)
3ee91e68 1002 (list arg)
3f4b7c36
RS
1003 (let ((args nil)
1004 (pos 0)
1005 (len (length arg)))
1006 (while (< pos len)
1007 (let ((char (aref arg pos))
1008 (start pos))
1009 (if (memq char comint-delimiter-argument-list)
1010 (while (and (< pos len) (eq (aref arg pos) char))
1011 (setq pos (1+ pos)))
1012 (while (and (< pos len)
1013 (not (memq (aref arg pos)
1014 comint-delimiter-argument-list)))
1015 (setq pos (1+ pos))))
1016 (setq args (cons (substring arg start pos) args))))
3ee91e68
RS
1017 args)))
1018
1019(defun comint-arguments (string nth mth)
1020 "Return from STRING the NTH to MTH arguments.
1021NTH and/or MTH can be nil, which means the last argument.
3f4b7c36
RS
1022Returned arguments are separated by single spaces.
1023We assume whitespace separates arguments, except within quotes.
1024Also, a run of one or more of a single character
1025in `comint-delimiter-argument-list' is a separate argument.
3ee91e68 1026Argument 0 is the command name."
3f4b7c36 1027 (let ((arg "\\(\\(\"[^\"]*\"\\|\'[^\']*\'\\|\`[^\`]*\`\\)\\|\\S \\)+")
3ee91e68
RS
1028 (args ()) (pos 0) (str nil))
1029 ;; We build a list of all the args. Unnecessary, but more efficient, when
1030 ;; ranges of args are required, than picking out one by one and recursing.
1031 (while (string-match arg string pos)
1032 (setq pos (match-end 0)
1033 str (substring string (match-beginning 0) pos)
3f4b7c36
RS
1034 ;; (match-end 2) is non-nil if we found quotes.
1035 args (if (match-end 2) (cons str args)
1036 (nconc (comint-delim-arg str) args))))
3ee91e68
RS
1037 (let ((n (or nth (1- (length args))))
1038 (m (if mth (1- (- (length args) mth)) 0)))
1039 (mapconcat
1040 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1041\f
be9b65ac 1042;;;
3ee91e68 1043;;; Input processing stuff
be9b65ac 1044;;;
3ee91e68 1045
49116ac0 1046(defun comint-send-input ()
c2ced5d8
CZ
1047 "Send input to process.
1048After the process output mark, sends all text from the process mark to
1049point as input to the process. Before the process output mark, calls value
8ae3bc9f 1050of variable `comint-get-old-input' to retrieve old input, copies it to the
cccd719e 1051process mark, and sends it. If variable `comint-process-echoes' is nil,
8ae3bc9f 1052a terminal newline is also inserted into the buffer and sent to the process
cccd719e
RS
1053\(if it is non-nil, all text from the process mark to point is deleted,
1054since it is assumed the remote process will re-echo it).
8ae3bc9f 1055
3ee91e68 1056Any history reference may be expanded depending on the value of the variable
1b421826 1057`comint-input-autoexpand'. The list of function names contained in the value
fb9ab28a 1058of `comint-input-filter-functions' is called on the input before sending it.
1b421826
RS
1059The input is entered into the input history ring, if the value of variable
1060`comint-input-filter' returns non-nil when called on the input.
cccd719e
RS
1061
1062If variable `comint-eol-on-send' is non-nil, then point is moved to the
8ae3bc9f
NF
1063end of line before sending the input.
1064
fb9ab28a 1065The values of `comint-get-old-input', `comint-input-filter-functions', and
1b421826
RS
1066`comint-input-filter' are chosen according to the command interpreter running
1067in the buffer. E.g.,
1068
be9b65ac 1069If the interpreter is the csh,
49116ac0
JB
1070 comint-get-old-input is the default: take the current line, discard any
1071 initial string matching regexp comint-prompt-regexp.
fb9ab28a 1072 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1b421826 1073 \"popd\" commands. When it sees one, it cd's the buffer.
3ee91e68 1074 comint-input-filter is the default: returns t if the input isn't all white
49116ac0 1075 space.
be9b65ac
DL
1076
1077If the comint is Lucid Common Lisp,
49116ac0 1078 comint-get-old-input snarfs the sexp ending at point.
fb9ab28a 1079 comint-input-filter-functions does nothing.
3ee91e68 1080 comint-input-filter returns nil if the input matches input-filter-regexp,
be9b65ac
DL
1081 which matches (1) all whitespace (2) :a, :c, etc.
1082
1586b965 1083Similarly for Soar, Scheme, etc."
be9b65ac
DL
1084 (interactive)
1085 ;; Note that the input string does not include its terminal newline.
49116ac0
JB
1086 (let ((proc (get-buffer-process (current-buffer))))
1087 (if (not proc) (error "Current buffer has no process")
1088 (let* ((pmark (process-mark proc))
3ee91e68 1089 (intxt (if (>= (point) (marker-position pmark))
49116ac0
JB
1090 (progn (if comint-eol-on-send (end-of-line))
1091 (buffer-substring pmark (point)))
87ef29fd
JB
1092 (let ((copy (funcall comint-get-old-input)))
1093 (goto-char pmark)
1094 (insert copy)
3ee91e68
RS
1095 copy)))
1096 (input (if (not (eq comint-input-autoexpand 'input))
1097 ;; Just whatever's already there
1098 intxt
1099 ;; Expand and leave it visible in buffer
d637fa56 1100 (comint-replace-by-expanded-history t)
3ee91e68
RS
1101 (buffer-substring pmark (point))))
1102 (history (if (not (eq comint-input-autoexpand 'history))
5f46b51a 1103 input
3ee91e68
RS
1104 ;; This is messy 'cos ultimately the original
1105 ;; functions used do insertion, rather than return
1106 ;; strings. We have to expand, then insert back.
d637fa56 1107 (comint-replace-by-expanded-history t)
5f46b51a
RS
1108 (let ((copy (buffer-substring pmark (point))))
1109 (delete-region pmark (point))
1110 (insert input)
1111 copy))))
8ae3bc9f
NF
1112 (if comint-process-echoes
1113 (delete-region pmark (point))
3ee91e68
RS
1114 (insert ?\n))
1115 (if (and (funcall comint-input-filter history)
1116 (or (null comint-input-ignoredups)
1117 (not (ring-p comint-input-ring))
1118 (ring-empty-p comint-input-ring)
1119 (not (string-equal (ring-ref comint-input-ring 0)
1120 history))))
1121 (ring-insert comint-input-ring history))
fb9ab28a 1122 (let ((functions comint-input-filter-functions))
1b421826
RS
1123 (while functions
1124 (funcall (car functions) (concat input "\n"))
1125 (setq functions (cdr functions))))
49116ac0 1126 (funcall comint-input-sender proc input)
1586b965 1127 (setq comint-input-ring-index nil)
87ef29fd
JB
1128 (set-marker comint-last-input-start pmark)
1129 (set-marker comint-last-input-end (point))
3ee91e68
RS
1130 (set-marker (process-mark proc) (point))
1131 ;; A kludge to prevent the delay between insert and process output
1132 ;; affecting the display. A case for a comint-send-input-hook?
669a535c 1133 (if (eq (process-filter proc) 'comint-output-filter)
fb9ab28a 1134 (let ((functions comint-output-filter-functions))
669a535c
RS
1135 (while functions
1136 (funcall (car functions) (concat input "\n"))
1137 (setq functions (cdr functions)))))))))
be9b65ac 1138
3ee91e68 1139;; The purpose of using this filter for comint processes
5511e411
RS
1140;; is to keep comint-last-input-end from moving forward
1141;; when output is inserted.
3ee91e68
RS
1142(defun comint-output-filter (process string)
1143 ;; First check for killed buffer
91d75282
RS
1144 (let ((oprocbuf (process-buffer process)))
1145 (if (and oprocbuf (buffer-name oprocbuf))
1146 (let ((obuf (current-buffer))
1147 (opoint nil) (obeg nil) (oend nil))
1148 (set-buffer oprocbuf)
1149 (setq opoint (point))
1150 (setq obeg (point-min))
1151 (setq oend (point-max))
1152 (let ((buffer-read-only nil)
1153 (nchars (length string))
1154 (ostart nil))
1155 (widen)
1156 (goto-char (process-mark process))
1157 (setq ostart (point))
1158 (if (<= (point) opoint)
1159 (setq opoint (+ opoint nchars)))
1160 ;; Insert after old_begv, but before old_zv.
1161 (if (< (point) obeg)
1162 (setq obeg (+ obeg nchars)))
1163 (if (<= (point) oend)
1164 (setq oend (+ oend nchars)))
1165 (insert-before-markers string)
1166 ;; Don't insert initial prompt outside the top of the window.
1167 (if (= (window-start (selected-window)) (point))
1168 (set-window-start (selected-window) (- (point) (length string))))
1169 (if (and comint-last-input-end
1170 (marker-buffer comint-last-input-end)
1171 (= (point) comint-last-input-end))
1172 (set-marker comint-last-input-end (- comint-last-input-end nchars)))
1173 (set-marker comint-last-output-start ostart)
1174 (set-marker (process-mark process) (point))
1175 (force-mode-line-update))
1176
1177 (narrow-to-region obeg oend)
1178 (goto-char opoint)
fb9ab28a 1179 (let ((functions comint-output-filter-functions))
91d75282
RS
1180 (while functions
1181 (funcall (car functions) string)
1182 (setq functions (cdr functions))))
1183 (set-buffer obuf)))))
3ee91e68 1184
c1da5c03 1185(defun comint-preinput-scroll-to-bottom ()
3ee91e68
RS
1186 "Go to the end of buffer in all windows showing it.
1187Movement occurs if point in the selected window is not after the process mark,
1188and `this-command' is an insertion command. Insertion commands recognised
d637fa56 1189are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
3ee91e68
RS
1190Depends on the value of `comint-scroll-to-bottom-on-input'.
1191
c1da5c03 1192This function should be a pre-command hook."
3ee91e68 1193 (if (and comint-scroll-to-bottom-on-input
91d75282 1194 (memq this-command '(self-insert-command comint-magic-space yank
d637fa56 1195 hilit-yank)))
3ee91e68
RS
1196 (let* ((selected (selected-window))
1197 (current (current-buffer))
1198 (process (get-buffer-process current))
1199 (scroll comint-scroll-to-bottom-on-input))
d637fa56 1200 (if (and process (< (point) (process-mark process)))
0744bf64
RS
1201 (if (eq scroll 'this)
1202 (goto-char (point-max))
1203 (walk-windows
1204 (function (lambda (window)
1205 (if (and (eq (window-buffer window) current)
d637fa56 1206 (or (eq scroll t) (eq scroll 'all)))
0744bf64
RS
1207 (progn
1208 (select-window window)
1209 (goto-char (point-max))
1210 (select-window selected)))))
d637fa56 1211 nil t))))))
3ee91e68 1212
c1da5c03 1213(defun comint-postoutput-scroll-to-bottom (string)
3ee91e68
RS
1214 "Go to the end of buffer in all windows showing it.
1215Does not scroll if the current line is the last line in the buffer.
1216Depends on the value of `comint-scroll-to-bottom-on-output' and
1217`comint-scroll-show-maximum-output'.
1218
fb9ab28a 1219This function should be in the list `comint-output-filter-functions'."
3ee91e68
RS
1220 (let* ((selected (selected-window))
1221 (current (current-buffer))
1222 (process (get-buffer-process current))
1223 (scroll comint-scroll-to-bottom-on-output))
d637fa56
RS
1224 (unwind-protect
1225 (if process
1226 (walk-windows
1227 (function (lambda (window)
1228 (if (eq (window-buffer window) current)
1229 (progn
1230 (select-window window)
1231 (if (and (< (point) (process-mark process))
1232 (or (eq scroll t) (eq scroll 'all)
1233 ;; Maybe user wants point to jump to the end.
1234 (and (eq scroll 'this) (eq selected window))
1235 (and (eq scroll 'others) (not (eq selected window)))
1236 ;; If point was at the end, keep it at the end.
1237 (>= (point)
1238 (- (process-mark process) (length string)))))
1239 (goto-char (process-mark process)))
1240 ;; Optionally scroll so that the text
1241 ;; ends at the bottom of the window.
1242 (if (and comint-scroll-show-maximum-output
1243 (>= (point) (process-mark process)))
1244 (save-excursion
1245 (goto-char (point-max))
1246 (recenter -1)))
1247 (select-window selected)))))
1248 nil t))
1249 (set-buffer current))))
3ee91e68
RS
1250
1251(defun comint-show-maximum-output ()
1252 "Put the end of the buffer at the bottom of the window."
1253 (interactive)
1254 (goto-char (point-max))
1255 (recenter -1))
5511e411 1256
be9b65ac 1257(defun comint-get-old-input-default ()
cccd719e 1258 "Default for `comint-get-old-input'.
c2ced5d8 1259Take the current line, and discard any initial text matching
cccd719e 1260`comint-prompt-regexp'."
be9b65ac 1261 (save-excursion
49116ac0
JB
1262 (beginning-of-line)
1263 (comint-skip-prompt)
1264 (let ((beg (point)))
1265 (end-of-line)
1266 (buffer-substring beg (point)))))
1267
3ee91e68
RS
1268(defun comint-copy-old-input ()
1269 "Insert after prompt old input at point as new input to be edited.
1270Calls `comint-get-old-input' to get old input."
1271 (interactive)
1272 (let ((input (funcall comint-get-old-input))
1273 (process (get-buffer-process (current-buffer))))
1274 (if (not process)
1275 (error "Current buffer has no process")
1276 (goto-char (process-mark process))
1277 (insert input))))
1278
49116ac0 1279(defun comint-skip-prompt ()
cccd719e 1280 "Skip past the text matching regexp `comint-prompt-regexp'.
49116ac0
JB
1281If this takes us past the end of the current line, don't skip at all."
1282 (let ((eol (save-excursion (end-of-line) (point))))
1283 (if (and (looking-at comint-prompt-regexp)
1284 (<= (match-end 0) eol))
1285 (goto-char (match-end 0)))))
1286
49116ac0 1287(defun comint-after-pmark-p ()
3ee91e68
RS
1288 "Return t if point is after the process output marker."
1289 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1290 (<= (marker-position pmark) (point))))
49116ac0
JB
1291
1292(defun comint-simple-send (proc string)
1293 "Default function for sending to PROC input STRING.
1294This just sends STRING plus a newline. To override this,
cccd719e 1295set the hook `comint-input-sender'."
49116ac0
JB
1296 (comint-send-string proc string)
1297 (comint-send-string proc "\n"))
be9b65ac
DL
1298
1299(defun comint-bol (arg)
1300 "Goes to the beginning of line, then skips past the prompt, if any.
3ee91e68 1301If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
be9b65ac 1302
49116ac0 1303The prompt skip is done by skipping text matching the regular expression
cccd719e 1304`comint-prompt-regexp', a buffer local variable.
49116ac0 1305
cccd719e
RS
1306If you don't like this command, bind C-a to `beginning-of-line'
1307in your hook, `comint-mode-hook'."
be9b65ac
DL
1308 (interactive "P")
1309 (beginning-of-line)
49116ac0 1310 (if (null arg) (comint-skip-prompt)))
be9b65ac 1311
21d9bf27 1312;;; These three functions are for entering text you don't want echoed or
be9b65ac 1313;;; saved -- typically passwords to ftp, telnet, or somesuch.
21d9bf27
RS
1314;;; Just enter m-x send-invisible and type in your line, or add
1315;;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
49116ac0 1316
87ef29fd 1317(defun comint-read-noecho (prompt &optional stars)
4be9a25f
NF
1318 "Read a single line of text from user without echoing, and return it.
1319Prompt with argument PROMPT, a string. Optional argument STARS causes
1320input to be echoed with '*' characters on the prompt line. Input ends with
1321RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
cccd719e
RS
1322`inhibit-quit' is set because e.g. this function was called from a process
1323filter and C-g is pressed, this function returns nil rather than a string).
4be9a25f
NF
1324
1325Note that the keystrokes comprising the text can still be recovered
cccd719e 1326\(temporarily) with \\[view-lossage]. This may be a security bug for some
4be9a25f
NF
1327applications."
1328 (let ((ans "")
1329 (c 0)
1330 (echo-keystrokes 0)
87ef29fd 1331 (cursor-in-echo-area t)
4be9a25f
NF
1332 (done nil))
1333 (while (not done)
1334 (if stars
1335 (message "%s%s" prompt (make-string (length ans) ?*))
1336 (message prompt))
1337 (setq c (read-char))
1338 (cond ((= c ?\C-g)
1339 ;; This function may get called from a process filter, where
1340 ;; inhibit-quit is set. In later versions of emacs read-char
1341 ;; may clear quit-flag itself and return C-g. That would make
1342 ;; it impossible to quit this loop in a simple way, so
1343 ;; re-enable it here (for backward-compatibility the check for
acdf173a 1344 ;; quit-flag below would still be necessary, so this seems
4be9a25f
NF
1345 ;; like the simplest way to do things).
1346 (setq quit-flag t
1347 done t))
1348 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1349 (setq done t))
1350 ((= c ?\C-u)
1351 (setq ans ""))
1352 ((and (/= c ?\b) (/= c ?\177))
1353 (setq ans (concat ans (char-to-string c))))
1354 ((> (length ans) 0)
1355 (setq ans (substring ans 0 -1)))))
1356 (if quit-flag
1357 ;; Emulate a true quit, except that we have to return a value.
1358 (prog1
1359 (setq quit-flag nil)
1360 (message "Quit")
1361 (beep t))
1362 (message "")
1363 ans)))
87ef29fd 1364
be9b65ac 1365(defun send-invisible (str)
c2ced5d8 1366 "Read a string without echoing.
cccd719e
RS
1367Then send it to the process running in the current buffer. A new-line
1368is additionally sent. String is not saved on comint input history list.
49116ac0
JB
1369Security bug: your string can still be temporarily recovered with
1370\\[view-lossage]."
be9b65ac
DL
1371 (interactive "P") ; Defeat snooping via C-x esc
1372 (let ((proc (get-buffer-process (current-buffer))))
21d9bf27
RS
1373 (if (not proc)
1374 (error "Current buffer has no process")
1375 (comint-send-string
1376 proc (if (stringp str) str (comint-read-noecho "Non-echoed text: " t)))
1377 (comint-send-string proc "\n"))))
1378
1379(defun comint-watch-for-password-prompt (string)
1380 "Prompt in the minibuffer for password and send without echoing.
1381This function uses `send-invisible' to read and send a password to the buffer's
1382process if STRING contains a password prompt (matches \"^[Pp]assword:\\\\s *\\\\'\").
1383
1384This function could be in the list `comint-output-filter-functions'."
1385 (if (string-match "^[Pp]assword:\\s *\\'" string)
1386 (send-invisible nil)))
be9b65ac
DL
1387\f
1388;;; Low-level process communication
1389
1390(defvar comint-input-chunk-size 512
cccd719e 1391 "*Long inputs are sent to comint processes in chunks of this size.
be9b65ac
DL
1392If your process is choking on big inputs, try lowering the value.")
1393
1394(defun comint-send-string (proc str)
1395 "Send PROCESS the contents of STRING as input.
cccd719e
RS
1396This is equivalent to `process-send-string', except that long input strings
1397are broken up into chunks of size `comint-input-chunk-size'. Processes
1398are given a chance to output between chunks. This can help prevent processes
be9b65ac
DL
1399from hanging when you send them long inputs on some OS's."
1400 (let* ((len (length str))
1401 (i (min len comint-input-chunk-size)))
1402 (process-send-string proc (substring str 0 i))
1403 (while (< i len)
1404 (let ((next-i (+ i comint-input-chunk-size)))
1405 (accept-process-output)
3ee91e68 1406 (sit-for 0)
be9b65ac
DL
1407 (process-send-string proc (substring str i (min len next-i)))
1408 (setq i next-i)))))
1409
1410(defun comint-send-region (proc start end)
1411 "Sends to PROC the region delimited by START and END.
cccd719e
RS
1412This is a replacement for `process-send-region' that tries to keep
1413your process from hanging on long inputs. See `comint-send-string'."
be9b65ac 1414 (comint-send-string proc (buffer-substring start end)))
be9b65ac
DL
1415\f
1416;;; Random input hackage
1417
49116ac0 1418(defun comint-kill-output ()
3ee91e68
RS
1419 "Kill all output from interpreter since last input.
1420Does not delete the prompt."
be9b65ac 1421 (interactive)
3ee91e68
RS
1422 (let ((pmark (progn (goto-char
1423 (process-mark (get-buffer-process (current-buffer))))
1424 (beginning-of-line nil)
1425 (point-marker))))
49116ac0 1426 (kill-region comint-last-input-end pmark)
49116ac0 1427 (insert "*** output flushed ***\n")
3ee91e68 1428 (comint-skip-prompt)
49116ac0 1429 (set-marker pmark (point))))
be9b65ac
DL
1430
1431(defun comint-show-output ()
49116ac0 1432 "Display start of this batch of interpreter output at top of window.
21d9bf27 1433Sets mark to the value of point when this command is run."
be9b65ac 1434 (interactive)
815c1a20 1435 (push-mark)
3ee91e68 1436 (let ((pos (point)))
42453245 1437 (goto-char (or (marker-position comint-last-input-end) (point-max)))
3ee91e68
RS
1438 (beginning-of-line 0)
1439 (set-window-start (selected-window) (point))
815c1a20 1440 (comint-skip-prompt)))
be9b65ac
DL
1441
1442(defun comint-interrupt-subjob ()
49116ac0 1443 "Interrupt the current subjob."
be9b65ac 1444 (interactive)
49116ac0 1445 (interrupt-process nil comint-ptyp))
be9b65ac
DL
1446
1447(defun comint-kill-subjob ()
49116ac0 1448 "Send kill signal to the current subjob."
be9b65ac 1449 (interactive)
49116ac0 1450 (kill-process nil comint-ptyp))
be9b65ac
DL
1451
1452(defun comint-quit-subjob ()
49116ac0 1453 "Send quit signal to the current subjob."
be9b65ac 1454 (interactive)
49116ac0 1455 (quit-process nil comint-ptyp))
be9b65ac
DL
1456
1457(defun comint-stop-subjob ()
49116ac0 1458 "Stop the current subjob.
be9b65ac 1459WARNING: if there is no current subjob, you can end up suspending
49116ac0
JB
1460the top-level process running in the buffer. If you accidentally do
1461this, use \\[comint-continue-subjob] to resume the process. (This
1462is not a problem with most shells, since they ignore this signal.)"
be9b65ac 1463 (interactive)
49116ac0 1464 (stop-process nil comint-ptyp))
be9b65ac
DL
1465
1466(defun comint-continue-subjob ()
49116ac0 1467 "Send CONT signal to process buffer's process group.
be9b65ac
DL
1468Useful if you accidentally suspend the top-level process."
1469 (interactive)
49116ac0 1470 (continue-process nil comint-ptyp))
be9b65ac
DL
1471
1472(defun comint-kill-input ()
49116ac0 1473 "Kill all text from last stuff output by interpreter to point."
be9b65ac 1474 (interactive)
3ee91e68
RS
1475 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1476 (if (> (point) (marker-position pmark))
49116ac0 1477 (kill-region pmark (point)))))
be9b65ac
DL
1478
1479(defun comint-delchar-or-maybe-eof (arg)
3ee91e68 1480 "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
be9b65ac
DL
1481 (interactive "p")
1482 (if (eobp)
1483 (process-send-eof)
3ee91e68 1484 (delete-char arg)))
49116ac0 1485
1de80a34
RM
1486(defun comint-send-eof ()
1487 "Send an EOF to the current buffer's process."
1488 (interactive)
1489 (process-send-eof))
49116ac0 1490
3ee91e68
RS
1491
1492(defun comint-backward-matching-input (regexp arg)
1493 "Search backward through buffer for match for REGEXP.
1494Matches are searched for on lines that match `comint-prompt-regexp'.
1495With prefix argument N, search for Nth previous match.
1496If N is negative, find the next or Nth next match."
1497 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
1498 (let* ((re (concat comint-prompt-regexp ".*" regexp))
1499 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1500 (if (re-search-backward re nil t arg)
1501 (point)))))
1502 (if (null pos)
1503 (progn (message "Not found")
1504 (ding))
1505 (goto-char pos)
1506 (comint-bol nil))))
1507
1508(defun comint-forward-matching-input (regexp arg)
1509 "Search forward through buffer for match for REGEXP.
1510Matches are searched for on lines that match `comint-prompt-regexp'.
1511With prefix argument N, search for Nth following match.
1512If N is negative, find the previous or Nth previous match."
1513 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
1514 (comint-backward-matching-input regexp (- arg)))
1515
1516
1de80a34 1517(defun comint-next-prompt (n)
3ee91e68 1518 "Move to end of Nth next prompt in the buffer.
1de80a34
RM
1519See `comint-prompt-regexp'."
1520 (interactive "p")
3ee91e68
RS
1521 (let ((paragraph-start comint-prompt-regexp))
1522 (end-of-line (if (> n 0) 1 0))
1523 (forward-paragraph n)
1524 (comint-skip-prompt)))
49116ac0 1525
3ee91e68
RS
1526(defun comint-previous-prompt (n)
1527 "Move to end of Nth previous prompt in the buffer.
1de80a34
RM
1528See `comint-prompt-regexp'."
1529 (interactive "p")
3ee91e68 1530 (comint-next-prompt (- n)))
be9b65ac
DL
1531\f
1532;;; Support for source-file processing commands.
1533;;;============================================================================
1534;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1535;;; commands that process files of source text (e.g. loading or compiling
1536;;; files). So the corresponding process-in-a-buffer modes have commands
1537;;; for doing this (e.g., lisp-load-file). The functions below are useful
1538;;; for defining these commands.
1539;;;
1540;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1541;;; and Soar, in that they don't know anything about file extensions.
1542;;; So the compile/load interface gets the wrong default occasionally.
1543;;; The load-file/compile-file default mechanism could be smarter -- it
1544;;; doesn't know about the relationship between filename extensions and
1545;;; whether the file is source or executable. If you compile foo.lisp
1546;;; with compile-file, then the next load-file should use foo.bin for
1547;;; the default, not foo.lisp. This is tricky to do right, particularly
1548;;; because the extension for executable files varies so much (.o, .bin,
1549;;; .lbin, .mo, .vo, .ao, ...).
1550
1551
1552;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1553;;; commands.
1554;;;
1555;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1556;;; want to save the buffer before issuing any process requests to the command
1557;;; interpreter.
1558;;;
1559;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1560;;; for the file to process.
1561
1562;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1563;;;============================================================================
1564;;; This function computes the defaults for the load-file and compile-file
49116ac0 1565;;; commands for tea, soar, cmulisp, and cmuscheme modes.
be9b65ac
DL
1566;;;
1567;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1568;;; source-file processing command. NIL if there hasn't been one yet.
1569;;; - SOURCE-MODES is a list used to determine what buffers contain source
1570;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1571;;; Typically, (lisp-mode) or (scheme-mode).
1572;;;
1573;;; If the command is given while the cursor is inside a string, *and*
1574;;; the string is an existing filename, *and* the filename is not a directory,
1575;;; then the string is taken as default. This allows you to just position
1576;;; your cursor over a string that's a filename and have it taken as default.
1577;;;
1578;;; If the command is given in a file buffer whose major mode is in
1579;;; SOURCE-MODES, then the the filename is the default file, and the
1580;;; file's directory is the default directory.
1581;;;
1582;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1583;;; then the default directory & file are what was used in the last source-file
1584;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1585;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1586;;; is the cwd, with no default file. (\"no default file\" = nil)
1587;;;
1588;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1589;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1590;;; for Soar programs, etc.
1591;;;
1592;;; The function returns a pair: (default-directory . default-file).
1593
1594(defun comint-source-default (previous-dir/file source-modes)
1595 (cond ((and buffer-file-name (memq major-mode source-modes))
1596 (cons (file-name-directory buffer-file-name)
1597 (file-name-nondirectory buffer-file-name)))
1598 (previous-dir/file)
1599 (t
1600 (cons default-directory nil))))
1601
49116ac0 1602
be9b65ac
DL
1603;;; (COMINT-CHECK-SOURCE fname)
1604;;;============================================================================
49116ac0 1605;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
be9b65ac
DL
1606;;; process-in-a-buffer modes), this function can be called on the filename.
1607;;; If the file is loaded into a buffer, and the buffer is modified, the user
1608;;; is queried to see if he wants to save the buffer before proceeding with
1609;;; the load or compile.
1610
1611(defun comint-check-source (fname)
1612 (let ((buff (get-file-buffer fname)))
1613 (if (and buff
1614 (buffer-modified-p buff)
3ee91e68 1615 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
be9b65ac
DL
1616 ;; save BUFF.
1617 (let ((old-buffer (current-buffer)))
1618 (set-buffer buff)
1619 (save-buffer)
1620 (set-buffer old-buffer)))))
1621
49116ac0 1622
be9b65ac
DL
1623;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1624;;;============================================================================
1625;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1626;;; commands that process source files (like loading or compiling a file).
1627;;; It prompts for the filename, provides a default, if there is one,
1628;;; and returns the result filename.
1629;;;
1630;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1631;;;
1632;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1633;;; from the last source processing command. SOURCE-MODES is a list of major
1634;;; modes used to determine what file buffers contain source files. (These
1635;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1636;;; then the filename reader will only accept a file that exists.
1637;;;
1638;;; A typical use:
1639;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1640;;; '(lisp-mode) t))
1641
1642;;; This is pretty stupid about strings. It decides we're in a string
1643;;; if there's a quote on both sides of point on the current line.
1644(defun comint-extract-string ()
cccd719e 1645 "Return string around POINT that starts the current line, or nil."
be9b65ac
DL
1646 (save-excursion
1647 (let* ((point (point))
1648 (bol (progn (beginning-of-line) (point)))
1649 (eol (progn (end-of-line) (point)))
1650 (start (progn (goto-char point)
1651 (and (search-backward "\"" bol t)
1652 (1+ (point)))))
1653 (end (progn (goto-char point)
1654 (and (search-forward "\"" eol t)
1655 (1- (point))))))
1656 (and start end
1657 (buffer-substring start end)))))
1658
1659(defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
1660 (let* ((def (comint-source-default prev-dir/file source-modes))
1661 (stringfile (comint-extract-string))
1662 (sfile-p (and stringfile
49116ac0
JB
1663 (condition-case ()
1664 (file-exists-p stringfile)
1665 (error nil))
be9b65ac
DL
1666 (not (file-directory-p stringfile))))
1667 (defdir (if sfile-p (file-name-directory stringfile)
1668 (car def)))
1669 (deffile (if sfile-p (file-name-nondirectory stringfile)
1670 (cdr def)))
1671 (ans (read-file-name (if deffile (format "%s(default %s) "
1672 prompt deffile)
1673 prompt)
1674 defdir
1675 (concat defdir deffile)
1676 mustmatch-p)))
1677 (list (expand-file-name (substitute-in-file-name ans)))))
1678
49116ac0
JB
1679;;; I am somewhat divided on this string-default feature. It seems
1680;;; to violate the principle-of-least-astonishment, in that it makes
1681;;; the default harder to predict, so you actually have to look and see
1682;;; what the default really is before choosing it. This can trip you up.
1683;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1684;;; on this.
1685;;; -Olin
1686
be9b65ac
DL
1687\f
1688;;; Simple process query facility.
1689;;; ===========================================================================
1690;;; This function is for commands that want to send a query to the process
1691;;; and show the response to the user. For example, a command to get the
1692;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1693;;; to an inferior Common Lisp process.
1694;;;
1695;;; This simple facility just sends strings to the inferior process and pops
1696;;; up a window for the process buffer so you can see what the process
1697;;; responds with. We don't do anything fancy like try to intercept what the
1698;;; process responds with and put it in a pop-up window or on the message
1699;;; line. We just display the buffer. Low tech. Simple. Works good.
1700
1701;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1702;;; a window for the inferior process so that its response can be seen.
1703(defun comint-proc-query (proc str)
1704 (let* ((proc-buf (process-buffer proc))
1705 (proc-mark (process-mark proc)))
1706 (display-buffer proc-buf)
1707 (set-buffer proc-buf) ; but it's not the selected *window*
1708 (let ((proc-win (get-buffer-window proc-buf))
1709 (proc-pt (marker-position proc-mark)))
1710 (comint-send-string proc str) ; send the query
1711 (accept-process-output proc) ; wait for some output
1712 ;; Try to position the proc window so you can see the answer.
1713 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1714 ;; I don't know why. Wizards invited to improve it.
1715 (if (not (pos-visible-in-window-p proc-pt proc-win))
1716 (let ((opoint (window-point proc-win)))
3ee91e68
RS
1717 (set-window-point proc-win proc-mark)
1718 (sit-for 0)
be9b65ac
DL
1719 (if (not (pos-visible-in-window-p opoint proc-win))
1720 (push-mark opoint)
3ee91e68 1721 (set-window-point proc-win opoint)))))))
be9b65ac
DL
1722
1723\f
3ee91e68 1724;;; Filename/command/history completion in a buffer
be9b65ac
DL
1725;;; ===========================================================================
1726;;; Useful completion functions, courtesy of the Ergo group.
be9b65ac 1727
1b421826 1728;;; Six commands:
3ee91e68
RS
1729;;; comint-dynamic-complete Complete or expand command, filename,
1730;;; history at point.
1731;;; comint-dynamic-complete-filename Complete filename at point.
3ee91e68 1732;;; comint-dynamic-list-filename-completions List completions in help buffer.
be9b65ac
DL
1733;;; comint-replace-by-expanded-filename Expand and complete filename at point;
1734;;; replace with expanded/completed name.
3ee91e68
RS
1735;;; comint-dynamic-simple-complete Complete stub given candidates.
1736
be9b65ac 1737;;; These are not installed in the comint-mode keymap. But they are
49116ac0 1738;;; available for people who want them. Shell-mode installs them:
735b3061 1739;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3ee91e68
RS
1740;;; (define-key shell-mode-map "\M-?"
1741;;; 'comint-dynamic-list-filename-completions)))
49116ac0
JB
1742;;;
1743;;; Commands like this are fine things to put in load hooks if you
1586b965 1744;;; want them present in specific modes.
49116ac0 1745
3ee91e68
RS
1746(defvar comint-completion-autolist nil
1747 "*If non-nil, automatically list possiblities on partial completion.
fdb7791d 1748This mirrors the optional behavior of tcsh.")
3ee91e68
RS
1749
1750(defvar comint-completion-addsuffix t
1751 "*If non-nil, add a `/' to completed directories, ` ' to file names.
fdb7791d 1752This mirrors the optional behavior of tcsh.")
3ee91e68
RS
1753
1754(defvar comint-completion-recexact nil
1755 "*If non-nil, use shortest completion if characters cannot be added.
fdb7791d 1756This mirrors the optional behavior of tcsh.
3ee91e68
RS
1757
1758A non-nil value is useful if `comint-completion-autolist' is non-nil too.")
1759
497513ad
RS
1760(defvar comint-completion-fignore nil
1761 "*List of suffixes to be disregarded during file completion.
1762This mirrors the optional behavior of bash and tcsh.
1763
1764Note that this applies to `comint-dynamic-complete-filename' only.")
1765
3ee91e68
RS
1766(defvar comint-file-name-prefix ""
1767 "Prefix prepended to absolute file names taken from process input.
1768This is used by comint's and shell's completion functions, and by shell's
1769directory tracking functions.")
be9b65ac 1770
3ee91e68
RS
1771
1772(defun comint-directory (directory)
1773 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1774 (expand-file-name (if (file-name-absolute-p directory)
1775 (concat comint-file-name-prefix directory)
1776 directory)))
1777
1778
1b421826
RS
1779(defun comint-word (word-chars)
1780 "Return the word of WORD-CHARS at point, or nil if non is found.
1781Word constituents are considered to be those in WORD-CHARS, which is like the
1782inside of a \"[...]\" (see `skip-chars-forward')."
3ee91e68 1783 (save-excursion
1b421826
RS
1784 (let ((limit (point))
1785 (word (concat "[" word-chars "]"))
1786 (non-word (concat "[^" word-chars "]")))
1787 (if (re-search-backward non-word nil 'move)
1788 (forward-char 1))
1789 ;; Anchor the search forwards.
1790 (if (or (eolp) (looking-at non-word))
1791 nil
1792 (re-search-forward (concat word "+") limit)
1793 (buffer-substring (match-beginning 0) (match-end 0))))))
3ee91e68 1794
3ee91e68 1795
1b421826
RS
1796(defun comint-match-partial-filename ()
1797 "Return the filename at point, or nil if non is found.
1798Environment variables are substituted. See `comint-word'."
1799 (let ((filename (comint-word "~/A-Za-z0-9+@:_.$#,={}-")))
1800 (and filename (substitute-in-file-name filename))))
be9b65ac 1801
49116ac0 1802
be9b65ac 1803(defun comint-dynamic-complete ()
1b421826
RS
1804 "Dynamically perform completion at point.
1805Calls the functions in `comint-dynamic-complete-functions' to perform
1806completion until a function returns non-nil, at which point completion is
1807assumed to have occurred."
3ee91e68 1808 (interactive)
1b421826
RS
1809 (let ((functions comint-dynamic-complete-functions))
1810 (while (and functions (null (funcall (car functions))))
1811 (setq functions (cdr functions)))))
3ee91e68
RS
1812
1813
1814(defun comint-dynamic-complete-filename ()
49116ac0 1815 "Dynamically complete the filename at point.
1b421826
RS
1816Completes if after a filename. See `comint-match-partial-filename' and
1817`comint-dynamic-complete-as-filename'.
3ee91e68
RS
1818This function is similar to `comint-replace-by-expanded-filename', except that
1819it won't change parts of the filename already entered in the buffer; it just
1820adds completion characters to the end of the filename. A completions listing
1821may be shown in a help buffer if completion is ambiguous.
1822
497513ad
RS
1823Completion is dependent on the value of `comint-completion-addsuffix',
1824`comint-completion-recexact' and `comint-completion-fignore', and the timing of
1825completions listing is dependent on the value of `comint-completion-autolist'.
1b421826
RS
1826
1827Returns t if successful."
3ee91e68 1828 (interactive)
1b421826
RS
1829 (if (comint-match-partial-filename)
1830 (prog2 (message "Completing file name...")
1831 (comint-dynamic-complete-as-filename))))
1832
1833
1834(defun comint-dynamic-complete-as-filename ()
1835 "Dynamically complete at point as a filename.
1836See `comint-dynamic-complete-filename'. Returns t if successful."
3ee91e68 1837 (let* ((completion-ignore-case nil)
497513ad 1838 (completion-ignored-extensions comint-completion-fignore)
1b421826 1839 (success t)
f79f58bc
KH
1840 (filename (or (comint-match-partial-filename) ""))
1841 (pathdir (file-name-directory filename))
1842 (pathnondir (file-name-nondirectory filename))
1843 (directory (if pathdir (comint-directory pathdir) default-directory))
1844 (completion (file-name-completion pathnondir directory)))
3ee91e68
RS
1845 (cond ((null completion)
1846 (message "No completions of %s" filename)
1b421826 1847 (setq success nil))
3ee91e68
RS
1848 ((eq completion t) ; Means already completed "file".
1849 (if comint-completion-addsuffix (insert " "))
1850 (message "Sole completion"))
1851 ((string-equal completion "") ; Means completion on "directory/".
1852 (comint-dynamic-list-filename-completions))
1853 (t ; Completion string returned.
1854 (let ((file (concat (file-name-as-directory directory) completion)))
3ee91e68
RS
1855 (insert (substring (directory-file-name completion)
1856 (length pathnondir)))
1857 (cond ((symbolp (file-name-completion completion directory))
1858 ;; We inserted a unique completion.
1859 (if comint-completion-addsuffix
1860 (insert (if (file-directory-p file) "/" " ")))
1861 (message "Completed"))
1862 ((and comint-completion-recexact comint-completion-addsuffix
1863 (string-equal pathnondir completion)
1864 (file-exists-p file))
1865 ;; It's not unique, but user wants shortest match.
1866 (insert (if (file-directory-p file) "/" " "))
1867 (message "Completed shortest"))
1868 ((or comint-completion-autolist
1869 (string-equal pathnondir completion))
1870 ;; It's not unique, list possible completions.
1871 (comint-dynamic-list-filename-completions))
1872 (t
1b421826
RS
1873 (message "Partially completed"))))))
1874 success))
3ee91e68
RS
1875
1876
1877(defun comint-replace-by-expanded-filename ()
1878 "Dynamically expand and complete the filename at point.
1879Replace the filename with an expanded, canonicalised and completed replacement.
1880\"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
1881with the corresponding directories. \"Canonicalised\" means `..' and `.' are
1882removed, and the filename is made absolute instead of relative. For expansion
1883see `expand-file-name' and `substitute-in-file-name'. For completion see
1884`comint-dynamic-complete-filename'."
be9b65ac 1885 (interactive)
3ee91e68
RS
1886 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
1887 (comint-dynamic-complete-filename))
1888
1889
3ee91e68
RS
1890(defun comint-dynamic-simple-complete (stub candidates)
1891 "Dynamically complete STUB from CANDIDATES list.
1892This function inserts completion characters at point by completing STUB from
1893the strings in CANDIDATES. A completions listing may be shown in a help buffer
1894if completion is ambiguous.
1895
1b421826
RS
1896Returns nil if no completion was inserted.
1897Returns `sole' if completed with the only completion match.
1898Returns `shortest' if completed with the shortest of the completion matches.
1899Returns `partial' if completed as far as possible with the completion matches.
1900Returns `listed' if a completion listing was shown.
1901
3ee91e68
RS
1902See also `comint-dynamic-complete-filename'."
1903 (let* ((completion-ignore-case nil)
1904 (candidates (mapcar (function (lambda (x) (list x))) candidates))
1905 (completions (all-completions stub candidates)))
be9b65ac 1906 (cond ((null completions)
3ee91e68 1907 (message "No completions of %s" stub)
1b421826 1908 nil)
3ee91e68
RS
1909 ((= 1 (length completions)) ; Gotcha!
1910 (let ((completion (car completions)))
1911 (if (string-equal completion stub)
1912 (message "Sole completion")
1913 (insert (substring completion (length stub)))
1914 (message "Completed"))
1b421826
RS
1915 (if comint-completion-addsuffix (insert " "))
1916 'sole))
3ee91e68
RS
1917 (t ; There's no unique completion.
1918 (let ((completion (try-completion stub candidates)))
1919 ;; Insert the longest substring.
1920 (insert (substring completion (length stub)))
1921 (cond ((and comint-completion-recexact comint-completion-addsuffix
1922 (string-equal stub completion)
1923 (member completion completions))
1924 ;; It's not unique, but user wants shortest match.
1925 (insert " ")
1b421826
RS
1926 (message "Completed shortest")
1927 'shortest)
3ee91e68
RS
1928 ((or comint-completion-autolist
1929 (string-equal stub completion))
1930 ;; It's not unique, list possible completions.
1b421826
RS
1931 (comint-dynamic-list-completions completions)
1932 'listed)
3ee91e68 1933 (t
1b421826
RS
1934 (message "Partially completed")
1935 'partial)))))))
3ee91e68
RS
1936
1937
1938(defun comint-dynamic-list-filename-completions ()
1939 "List in help buffer possible completions of the filename at point."
1940 (interactive)
1941 (let* ((completion-ignore-case nil)
1b421826 1942 (filename (or (comint-match-partial-filename) ""))
3ee91e68
RS
1943 (pathdir (file-name-directory filename))
1944 (pathnondir (file-name-nondirectory filename))
1945 (directory (if pathdir (comint-directory pathdir) default-directory))
1946 (completions (file-name-all-completions pathnondir directory)))
1947 (if completions
1948 (comint-dynamic-list-completions completions)
1b421826 1949 (message "No completions of %s" filename))))
3ee91e68
RS
1950
1951
1952(defun comint-dynamic-list-completions (completions)
1953 "List in help buffer sorted COMPLETIONS.
1954Typing SPC flushes the help buffer."
1955 (let ((conf (current-window-configuration)))
1956 (with-output-to-temp-buffer " *Completions*"
1957 (display-completion-list (sort completions 'string-lessp)))
3ee91e68 1958 (message "Hit space to flush")
7d5d472e
RS
1959 (let (key first)
1960 (if (save-excursion
1961 (set-buffer (get-buffer " *Completions*"))
1962 (setq key (read-key-sequence nil)
1963 first (aref key 0))
1964 (and (consp first)
1965 (eq (window-buffer (posn-window (event-start first)))
1966 (get-buffer " *Completions*"))
1967 (eq (key-binding key) 'mouse-choose-completion)))
1968 ;; If the user does mouse-choose-completion with the mouse,
1969 ;; execute the command, then delete the completion window.
1970 (progn
1971 (mouse-choose-completion first)
1972 (set-window-configuration conf))
1973 (if (eq first ?\ )
1974 (set-window-configuration conf)
1975 (setq unread-command-events (append key nil)))))))
be9b65ac
DL
1976\f
1977;;; Converting process modes to use comint mode
1978;;; ===========================================================================
be14d312
ER
1979;;; The code in the Emacs 19 distribution has all been modified to use comint
1980;;; where needed. However, there are `third-party' packages out there that
1981;;; still use the old shell mode. Here's a guide to conversion.
49116ac0 1982;;;
be9b65ac 1983;;; Renaming variables
49116ac0
JB
1984;;; Most of the work is renaming variables and functions. These are the common
1985;;; ones:
1986;;; Local variables:
87ef29fd 1987;;; last-input-start comint-last-input-start
49116ac0 1988;;; last-input-end comint-last-input-end
49116ac0
JB
1989;;; shell-prompt-pattern comint-prompt-regexp
1990;;; shell-set-directory-error-hook <no equivalent>
1991;;; Miscellaneous:
be9b65ac
DL
1992;;; shell-set-directory <unnecessary>
1993;;; shell-mode-map comint-mode-map
49116ac0 1994;;; Commands:
be9b65ac
DL
1995;;; shell-send-input comint-send-input
1996;;; shell-send-eof comint-delchar-or-maybe-eof
1997;;; kill-shell-input comint-kill-input
1998;;; interrupt-shell-subjob comint-interrupt-subjob
1999;;; stop-shell-subjob comint-stop-subjob
2000;;; quit-shell-subjob comint-quit-subjob
2001;;; kill-shell-subjob comint-kill-subjob
2002;;; kill-output-from-shell comint-kill-output
2003;;; show-output-from-shell comint-show-output
2004;;; copy-last-shell-input Use comint-previous-input/comint-next-input
2005;;;
87ef29fd 2006;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
fb9ab28a 2007;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
87ef29fd 2008;;; Comint mode does not provide functionality equivalent to
be9b65ac 2009;;; shell-set-directory-error-hook; it is gone.
87ef29fd
JB
2010;;;
2011;;; comint-last-input-start is provided for modes which want to munge
2012;;; the buffer after input is sent, perhaps because the inferior
2013;;; insists on echoing the input. The LAST-INPUT-START variable in
2014;;; the old shell package was used to implement a history mechanism,
2015;;; but you should think twice before using comint-last-input-start
2016;;; for this; the input history ring often does the job better.
be9b65ac
DL
2017;;;
2018;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2019;;; *not* create the comint-mode local variables in your foo-mode function.
2020;;; This is not modular. Instead, call comint-mode, and let *it* create the
2021;;; necessary comint-specific local variables. Then create the
2022;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2023;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
fb9ab28a 2024;;; (comint-{prompt-regexp, input-filter, input-filter-functions,
1b421826 2025;;; get-old-input) that need to be different from the defaults. Call
be9b65ac 2026;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
735b3061 2027;;; comint-mode will take care of it. The following example, from shell.el,
49116ac0
JB
2028;;; is typical:
2029;;;
d55d5ec2
RS
2030;;; (defvar shell-mode-map '())
2031;;; (cond ((not shell-mode-map)
63ab7e8f 2032;;; (setq shell-mode-map (copy-keymap comint-mode-map))
d55d5ec2
RS
2033;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2034;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2035;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2036;;; (define-key shell-mode-map "\M-?"
2037;;; 'comint-dynamic-list-filename-completions)))
2038;;;
49116ac0
JB
2039;;; (defun shell-mode ()
2040;;; (interactive)
2041;;; (comint-mode)
2042;;; (setq comint-prompt-regexp shell-prompt-pattern)
2043;;; (setq major-mode 'shell-mode)
2044;;; (setq mode-name "Shell")
49116ac0
JB
2045;;; (use-local-map shell-mode-map)
2046;;; (make-local-variable 'shell-directory-stack)
2047;;; (setq shell-directory-stack nil)
fb9ab28a 2048;;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
49116ac0
JB
2049;;; (run-hooks 'shell-mode-hook))
2050;;;
be9b65ac
DL
2051;;;
2052;;; Note that make-comint is different from make-shell in that it
2053;;; doesn't have a default program argument. If you give make-shell
2054;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
2055;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
2056;;; of NIL, it barfs. Adjust your code accordingly...
49116ac0 2057;;;
3ee91e68
RS
2058;;; Completion for comint-mode users
2059;;;
1b421826
RS
2060;;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2061;;; hook to add completion functions to. Functions on this list should return
2062;;; non-nil if completion occurs (i.e., further completion should not occur).
3ee91e68
RS
2063;;; You could use comint-dynamic-simple-complete to do the bulk of the
2064;;; completion job.
49116ac0 2065\f
49116ac0 2066(provide 'comint)
c0274f38
ER
2067
2068;;; comint.el ends here