comint.el 116 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; comint.el --- general command interpreter in a window stuff
2

3 4
;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000
;;	Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Simon Marshall's avatar
Simon Marshall committed
6
;; Author: Olin Shivers <shivers@cs.cmu.edu> then
Karl Heuer's avatar
Karl Heuer committed
7
;;	Simon Marshall <simon@gnu.org>
Simon Marshall's avatar
Simon Marshall committed
8
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
9
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
10

11
;; This file is part of GNU Emacs.
David Lawrence's avatar
David Lawrence committed
12

13 14 15 16
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
David Lawrence's avatar
David Lawrence committed
17

18 19 20 21
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
David Lawrence's avatar
David Lawrence committed
22

23
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24 25 26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
David Lawrence's avatar
David Lawrence committed
27

Eric S. Raymond's avatar
Eric S. Raymond committed
28 29
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
30 31 32
;; Please send me bug reports, bug fixes, and extensions, so that I can
;; merge them into the master source.
;;     - Olin Shivers (shivers@cs.cmu.edu)
Karl Heuer's avatar
Karl Heuer committed
33
;;     - Simon Marshall (simon@gnu.org)
Erik Naggum's avatar
Erik Naggum committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

;; This file defines a general command-interpreter-in-a-buffer package
;; (comint mode). The idea is that you can build specific process-in-a-buffer
;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
;; This way, all these specific packages share a common base functionality, 
;; and a common set of bindings, which makes them easier to use (and
;; saves code, implementation time, etc., etc.).

;; Several packages are already defined using comint mode:
;; - shell.el defines a shell-in-a-buffer mode.
;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
;;
;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
;; - The file tea.el tunes scheme and inferior-scheme modes for T.
;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
;;   previewers, and printers from within emacs.
;; - background.el allows csh-like job control inside emacs.
;; It is pretty easy to make new derived modes for other processes.

;; For documentation on the functionality provided by comint mode, and
;; the hooks available for customising it, see the comments below.
;; For further information on the standard derived modes (shell, 
;; inferior-lisp, inferior-scheme, ...), see the relevant source files.

;; For hints on converting existing process modes (e.g., tex-mode,
;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
;; instead of shell-mode, see the notes at the end of this file.
David Lawrence's avatar
David Lawrence committed
62 63


Erik Naggum's avatar
Erik Naggum committed
64 65 66 67 68
;; Brief Command Documentation:
;;============================================================================
;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
;; mode)
;;
69 70
;; m-p	   comint-previous-input   	   Cycle backwards in input history
;; m-n	   comint-next-input  	   	   Cycle forwards
Erik Naggum's avatar
Erik Naggum committed
71 72
;; m-r     comint-previous-matching-input  Previous input matching a regexp
;; m-s     comint-next-matching-input      Next input that matches
73
;; m-c-l   comint-show-output		   Show last batch of process output
Erik Naggum's avatar
Erik Naggum committed
74
;; return  comint-send-input
75 76 77
;; c-d	   comint-delchar-or-maybe-eof     Delete char unless at end of buff
;; c-c c-a comint-bol-or-process-mark      First time, move point to bol;
;;					    second time, move to process-mark.
Erik Naggum's avatar
Erik Naggum committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
;; c-c c-u comint-kill-input	    	    ^u
;; c-c c-w backward-kill-word    	    ^w
;; c-c c-c comint-interrupt-subjob 	    ^c
;; c-c c-z comint-stop-subjob	    	    ^z
;; c-c c-\ comint-quit-subjob	    	    ^\
;; c-c c-o comint-kill-output		    Delete last batch of process output
;; c-c c-r comint-show-output		    Show last batch of process output
;; c-c c-l comint-dynamic-list-input-ring  List input history
;;
;; Not bound by default in comint-mode (some are in shell mode)
;; comint-run				Run a program under comint-mode
;; send-invisible			Read a line w/o echo, and send to proc
;; comint-dynamic-complete-filename	Complete filename at point.
;; comint-dynamic-complete-variable    Complete variable name at point.
;; comint-dynamic-list-filename-completions List completions in help buffer.
;; comint-replace-by-expanded-filename	Expand and complete filename at point;
;;					replace with expanded/completed name.
;; comint-replace-by-expanded-history	Expand history at point;
;;					replace with expanded name.
;; comint-magic-space                  Expand history and add (a) space(s).
;; comint-kill-subjob			No mercy.
;; comint-show-maximum-output          Show as much output as possible.
;; comint-continue-subjob		Send CONT signal to buffer's process
;;					group. Useful if you accidentally
;;					suspend your process (with C-c C-z).
103 104 105 106 107
;; comint-get-next-from-history        Fetch successive input history lines
;; comint-accumulate		       Combine lines to send them together
;;					as input.
;; comint-goto-process-mark	       Move point to where process-mark is.
;; comint-set-process-mark	       Set process-mark to point.
Erik Naggum's avatar
Erik Naggum committed
108 109

;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
David Lawrence's avatar
David Lawrence committed
110

Eric S. Raymond's avatar
Eric S. Raymond committed
111 112
;;; Code:

Richard M. Stallman's avatar
Richard M. Stallman committed
113
(require 'ring)
David Lawrence's avatar
David Lawrence committed
114

Erik Naggum's avatar
Erik Naggum committed
115 116 117
;; Buffer Local Variables:
;;============================================================================
;; Comint mode buffer local variables:
118 119 120 121 122 123 124
;;  comint-prompt-regexp    		string	comint-bol uses to match prompt
;;  comint-delimiter-argument-list	list	For delimiters and arguments
;;  comint-last-input-start		marker	Handy if inferior always echoes
;;  comint-last-input-end		marker	For comint-kill-output command
;;  comint-input-ring-size		integer	For the input history
;;  comint-input-ring			ring	mechanism
;;  comint-input-ring-index		number	...
125
;;  comint-save-input-ring-index	number	...
126 127 128 129
;;  comint-input-autoexpand		symbol	...
;;  comint-input-ignoredups		boolean	...
;;  comint-dynamic-complete-functions	hook   For the completion mechanism
;;  comint-completion-fignore		list	...
130
;;  comint-file-name-chars		string	...
131 132 133 134
;;  comint-file-name-quote-list		list	...
;;  comint-get-old-input		function Hooks for specific 
;;  comint-input-filter-functions	hook	process-in-a-buffer
;;  comint-output-filter-functions	hook	function modes.
135
;;  comint-preoutput-filter-functions   hook
136 137 138 139 140 141 142
;;  comint-input-filter			function ...
;;  comint-input-sender			function ...
;;  comint-eol-on-send			boolean	...
;;  comint-process-echoes		boolean	...
;;  comint-scroll-to-bottom-on-input	symbol	For scroll behavior
;;  comint-scroll-to-bottom-on-output	symbol	...
;;  comint-scroll-show-maximum-output	boolean	...	
143
;;  comint-accum-marker			maker	  For comint-accumulate
Erik Naggum's avatar
Erik Naggum committed
144 145
;;
;; Comint mode non-buffer local variables:
146 147 148
;;  comint-completion-addsuffix		boolean/cons	For file name
;;  comint-completion-autolist		boolean		completion behavior
;;  comint-completion-recexact		boolean		...
David Lawrence's avatar
David Lawrence committed
149

150 151 152 153 154 155 156 157 158 159 160 161 162 163
(defgroup comint nil
  "General command interpreter in a window stuff."
  :group 'processes)

(defgroup comint-completion nil
  "Completion facilities in comint"
  :group 'comint)

(defgroup comint-source nil
  "Source finding facilities in comint"
  :prefix "comint-"
  :group 'comint)


Jim Blandy's avatar
Jim Blandy committed
164 165 166
(defvar comint-prompt-regexp "^"
  "Regexp to recognise prompts in the inferior process.
Defaults to \"^\", the null string at BOL.
David Lawrence's avatar
David Lawrence committed
167 168

Good choices:
169
  Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
170 171
  Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
  franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
Jim Blandy's avatar
Jim Blandy committed
172
  kcl: \"^>+ *\"
173
  shell: \"^[^#$%>\\n]*[#$%>] *\"
Jim Blandy's avatar
Jim Blandy committed
174
  T: \"^>+ *\"
David Lawrence's avatar
David Lawrence committed
175

Jim Blandy's avatar
Jim Blandy committed
176
This is a good thing to set in mode hooks.")
David Lawrence's avatar
David Lawrence committed
177

178 179 180 181 182
(defvar comint-delimiter-argument-list ()
  "List of characters to recognise as separate arguments in input.
Strings comprising a character in this list will separate the arguments
surrounding them, and also be regarded as arguments in their own right (unlike
whitespace).  See `comint-arguments'.
183
Defaults to the empty list.
184

185
For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
186 187 188

This is a good thing to set in mode hooks.")

189
(defcustom comint-input-autoexpand nil
190
  "*If non-nil, expand input command history references on completion.
191
This mirrors the optional behavior of tcsh (its autoexpand and histlit).
192 193 194 195 196 197

If the value is `input', then the expansion is seen on input.
If the value is `history', then the expansion is only when inserting
into the buffer's input ring.  See also `comint-magic-space' and
`comint-dynamic-complete'.

198 199 200
This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const input)
201 202
		 (const history)
		 (other :tag "on" t))
203 204
  :group 'comint)

205 206 207 208 209 210 211 212 213 214 215
(defcustom comint-highlight-input t
  "*If non-nil, highlight input; also allow choosing previous input with a mouse.
See also `comint-highlight-face'."
  :type 'boolean
  :group 'comint)

(defcustom comint-highlight-face 'bold
  "*Face to use to highlight input when `comint-highlight-input' is non-nil."
  :type 'face
  :group 'comint)

216
(defcustom comint-input-ignoredups nil
217
  "*If non-nil, don't add input matching the last on the input ring.
218
This mirrors the optional behavior of bash.
219

220 221 222
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
223

224
(defcustom comint-input-ring-file-name nil
225 226 227
  "*If non-nil, name of the file to read/write input history.
See also `comint-read-input-ring' and `comint-write-input-ring'.

228
This variable is buffer-local, and is a good thing to set in mode hooks."
229 230
  :type '(choice (const :tag "nil" nil)
		 file)
231
  :group 'comint)
232

233
(defcustom comint-scroll-to-bottom-on-input nil
234 235 236 237
  "*Controls whether input to interpreter causes window to scroll.
If nil, then do not scroll.  If t or `all', scroll all windows showing buffer.
If `this', scroll only the selected window.

238
The default is nil.
239

240 241 242 243 244 245
See `comint-preinput-scroll-to-bottom'.  This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const t)
		 (const all)
		 (const this))
  :group 'comint)
246

247
(defcustom comint-scroll-to-bottom-on-output nil
248 249 250 251
  "*Controls whether interpreter output causes window to scroll.
If nil, then do not scroll.  If t or `all', scroll all windows showing buffer.
If `this', scroll only the selected window.
If `others', scroll only those that are not the selected window.
252 253

The default is nil.
254

255
See variable `comint-scroll-show-maximum-output' and function
256 257 258 259 260 261 262 263 264
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const t)
		 (const all)
		 (const this)
		 (const others))
  :group 'comint)

(defcustom comint-scroll-show-maximum-output nil
265 266
  "*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
267

268
See variable `comint-scroll-to-bottom-on-output' and function
269 270 271
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type 'boolean
  :group 'comint)
272

273
(defcustom comint-buffer-maximum-size 1024
274 275
  "*The maximum size in lines for comint buffers.
Comint buffers are truncated from the top to be no greater than this number, if
276 277 278
the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
  :type 'integer
  :group 'comint)
279

280
(defvar comint-input-ring-size 32
Jim Blandy's avatar
Jim Blandy committed
281
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
282

283 284 285
(defvar comint-input-ring-separator "\n"
  "Separator between commands in the history file.")

286
(defcustom comint-process-echoes nil
287
  "*If non-nil, assume that the subprocess echoes any input.
Noah Friedman's avatar
Noah Friedman committed
288
If so, delete one copy of the input so that only one copy eventually
289
appears in the buffer.
Noah Friedman's avatar
Noah Friedman committed
290

291 292 293
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
Noah Friedman's avatar
Noah Friedman committed
294

295
;; AIX puts the name of the person being su'd to in front of the prompt.
296
;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
297 298
;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
;; ssh-add prints a prompt like `Enter passphrase: '.
299
;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
300
(defcustom comint-password-prompt-regexp
301 302
  "\\(\\([Oo]ld \\|[Nn]ew \\|Kerberos \\|'s \\|login \\|^\\)\
[Pp]assword\\( (again)\\)?\\|pass phrase\\|Enter passphrase\\)\
303
\\( for [^@ \t\n]+@[^@ \t\n]+\\)?:\\s *\\'"
304
  "*Regexp matching prompts for passwords in the inferior process.
305 306 307
This is used by `comint-watch-for-password-prompt'."
  :type 'regexp
  :group 'comint)
308

Erik Naggum's avatar
Erik Naggum committed
309
;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
310
(defvar comint-get-old-input (function comint-get-old-input-default)
311
  "Function that returns old text in comint mode.
David Lawrence's avatar
David Lawrence committed
312 313
This function is called when return is typed while the point is in old text.
It returns the text to be submitted as process input.  The default is
314 315
`comint-get-old-input-default', which grabs the current line, and strips off
leading text matching `comint-prompt-regexp'.")
David Lawrence's avatar
David Lawrence committed
316

317 318 319 320 321
(defvar comint-dynamic-complete-functions
  '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
  "List of functions called to perform completion.
Functions should return non-nil if completion was performed.
See also `comint-dynamic-complete'.
322 323 324

This is a good thing to set in mode hooks.")

Jim Blandy's avatar
Jim Blandy committed
325 326 327
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
328 329 330
Takes one argument, the input.  If non-nil, the input may be saved on the input
history list.  Default is to save anything that isn't all whitespace.")

331
(defvar comint-input-filter-functions '()
332 333 334 335 336
  "Functions to call before input is sent to the process.
These functions get one argument, a string containing the text to send.

This variable is buffer-local.")

337
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom) 
338
  "Functions to call after output is inserted into the buffer.
339
One possible function is `comint-postoutput-scroll-to-bottom'.
340 341 342 343
These functions get one argument, a string containing the text as originally
inserted.  Note that this might not be the same as the buffer contents between
`comint-last-output-start' and the buffer's `process-mark', if other filter
functions have already modified the buffer.
344

345 346
See also `comint-preoutput-filter-functions'.

347
This variable is buffer-local.")
Jim Blandy's avatar
Jim Blandy committed
348 349 350

(defvar comint-input-sender (function comint-simple-send)
  "Function to actually send to PROCESS the STRING submitted by user.
351 352 353 354
Usually this is just `comint-simple-send', but if your mode needs to 
massage the input string, put a different function here.
`comint-simple-send' just sends the string plus a newline.
This is called from the user command `comint-send-input'.")
Jim Blandy's avatar
Jim Blandy committed
355

356
(defcustom comint-eol-on-send t
357
  "*Non-nil means go to the end of the line before sending input.
358 359 360
See `comint-send-input'."
  :type 'boolean
  :group 'comint)
David Lawrence's avatar
David Lawrence committed
361

362
(defcustom comint-mode-hook '()
Jim Blandy's avatar
Jim Blandy committed
363
  "Called upon entry into comint-mode
364 365 366
This is run before the process is cranked up."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
367

368
(defcustom comint-exec-hook '()
369
  "Called each time a process is exec'd by `comint-exec'.
Jim Blandy's avatar
Jim Blandy committed
370
This is called after the process is cranked up.  It is useful for things that
371 372
must be done each time a process is executed in a comint mode buffer (e.g.,
`(process-kill-without-query)').  In contrast, the `comint-mode-hook' is only
373 374 375
executed once when the buffer is created."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
376 377

(defvar comint-mode-map nil)
David Lawrence's avatar
David Lawrence committed
378

Richard M. Stallman's avatar
Richard M. Stallman committed
379
(defvar comint-ptyp t
380
  "Non-nil if communications via pty; false if by pipe.  Buffer local.
381
This is to work around a bug in Emacs process signaling.")
Richard M. Stallman's avatar
Richard M. Stallman committed
382

383
(defvar comint-input-ring nil)
384 385
(defvar comint-last-input-start)
(defvar comint-last-input-end)
386
(defvar comint-last-output-start)
387 388 389 390
(defvar comint-input-ring-index nil
  "Index of last matched history element.")
(defvar comint-matching-input-from-input-string ""
  "Input previously used to match input history.")
391 392 393 394 395 396 397
(defvar comint-save-input-ring-index
  "Last input ring index which you copied.
This is to support the command \\[comint-get-next-from-history].")

(defvar comint-accum-marker nil
  "Non-nil if you are accumulating input lines to send as input together.
The command \\[comint-accumulate] sets this.")
398 399

(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
Richard M. Stallman's avatar
Richard M. Stallman committed
400
(put 'comint-input-ring 'permanent-local t)
401
(put 'comint-input-ring-index 'permanent-local t)
402
(put 'comint-save-input-ring-index 'permanent-local t)
403
(put 'comint-input-autoexpand 'permanent-local t)
404 405
(put 'comint-input-filter-functions 'permanent-local t)
(put 'comint-output-filter-functions 'permanent-local t)
406
(put 'comint-preoutput-filter-functions 'permanent-local t)
407 408 409
(put 'comint-scroll-to-bottom-on-input 'permanent-local t)
(put 'comint-scroll-to-bottom-on-output 'permanent-local t)
(put 'comint-scroll-show-maximum-output 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
410
(put 'comint-ptyp 'permanent-local t)
411

412 413
(put 'comint-mode 'mode-class 'special)

David Lawrence's avatar
David Lawrence committed
414 415 416 417 418
(defun comint-mode ()
  "Major mode for interacting with an inferior interpreter.
Interpreter name is same as buffer name, sans the asterisks.
Return at end of buffer sends line as input.
Return not at end copies rest of line to end and sends it.
419
Setting variable `comint-eol-on-send' means jump to the end of the line
Jim Blandy's avatar
Jim Blandy committed
420
before submitting new input.
David Lawrence's avatar
David Lawrence committed
421

422 423
This mode is customised to create major modes such as Inferior Lisp
mode, Shell mode, etc.  This can be done by setting the hooks
424
`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
425
and `comint-get-old-input' to appropriate functions, and the variable
426
`comint-prompt-regexp' to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
427

428
An input history is maintained of size `comint-input-ring-size', and
429 430 431 432 433 434
can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
Input ring history expansion can be achieved with the commands
\\[comint-replace-by-expanded-history] or \\[comint-magic-space].
Input ring expansion is controlled by the variable `comint-input-autoexpand',
and addition is controlled by the variable `comint-input-ignoredups'.

435
Commands with no default key bindings include `send-invisible',
436
`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and 
437 438 439
`comint-magic-space'.

Input to, and output from, the subprocess can cause the window to scroll to
440
the end of the buffer.  See variables `comint-output-filter-functions',
441 442
`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
and `comint-scroll-to-bottom-on-output'.
David Lawrence's avatar
David Lawrence committed
443 444 445 446 447 448

If you accidentally suspend your process, use \\[comint-continue-subjob]
to continue it.

\\{comint-mode-map}

449
Entry to this mode runs the hooks on `comint-mode-hook'."
David Lawrence's avatar
David Lawrence committed
450
  (interactive)
451 452 453 454
  ;; Do not remove this.  All major modes must do this.
  (kill-all-local-variables)
  (setq major-mode 'comint-mode)
  (setq mode-name "Comint")
455
  (setq mode-line-process '(":%s"))
456 457 458
  (use-local-map comint-mode-map)
  (make-local-variable 'comint-last-input-start)
  (setq comint-last-input-start (make-marker))
459
  (set-marker comint-last-input-start (point-min))
460 461
  (make-local-variable 'comint-last-input-end)
  (setq comint-last-input-end (make-marker))
462
  (set-marker comint-last-input-end (point-min))
463 464 465 466 467 468 469 470 471
  (make-local-variable 'comint-last-output-start)
  (setq comint-last-output-start (make-marker))
  (make-local-variable 'comint-prompt-regexp)        ; Don't set; default
  (make-local-variable 'comint-input-ring-size)      ; ...to global val.
  (make-local-variable 'comint-input-ring)
  (make-local-variable 'comint-input-ring-file-name)
  (or (and (boundp 'comint-input-ring) comint-input-ring)
      (setq comint-input-ring (make-ring comint-input-ring-size)))
  (make-local-variable 'comint-input-ring-index)
472
  (make-local-variable 'comint-save-input-ring-index)
473 474
  (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
      (setq comint-input-ring-index nil))
475 476
  (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
      (setq comint-save-input-ring-index nil))
477 478 479 480
  (make-local-variable 'comint-matching-input-from-input-string)
  (make-local-variable 'comint-input-autoexpand)
  (make-local-variable 'comint-input-ignoredups)
  (make-local-variable 'comint-delimiter-argument-list)
481
  (make-local-hook 'comint-dynamic-complete-functions)
482
  (make-local-variable 'comint-completion-fignore)
483
  (make-local-variable 'comint-get-old-input)
484
  (make-local-hook 'comint-input-filter-functions)
485 486 487 488 489 490
  (make-local-variable 'comint-input-filter)
  (make-local-variable 'comint-input-sender)
  (make-local-variable 'comint-eol-on-send)
  (make-local-variable 'comint-scroll-to-bottom-on-input)
  (make-local-variable 'comint-scroll-to-bottom-on-output)
  (make-local-variable 'comint-scroll-show-maximum-output)
491 492
  (make-local-hook 'pre-command-hook)
  (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
493
  (make-local-hook 'comint-output-filter-functions)
494
  (make-local-hook 'comint-exec-hook)
495 496
  (make-local-variable 'comint-ptyp)
  (make-local-variable 'comint-process-echoes)
497
  (make-local-variable 'comint-file-name-chars)
498
  (make-local-variable 'comint-file-name-quote-list)
499 500 501
  (make-local-variable 'comint-accum-marker)
  (setq comint-accum-marker (make-marker))
  (set-marker comint-accum-marker nil)
502
  (run-hooks 'comint-mode-hook))
David Lawrence's avatar
David Lawrence committed
503

Jim Blandy's avatar
Jim Blandy committed
504 505
(if comint-mode-map
    nil
506
  ;; Keys:
Jim Blandy's avatar
Jim Blandy committed
507 508 509
  (setq comint-mode-map (make-sparse-keymap))
  (define-key comint-mode-map "\ep" 'comint-previous-input)
  (define-key comint-mode-map "\en" 'comint-next-input)
510 511
  (define-key comint-mode-map [C-up] 'comint-previous-input)
  (define-key comint-mode-map [C-down] 'comint-next-input)
512 513
  (define-key comint-mode-map "\er" 'comint-previous-matching-input)
  (define-key comint-mode-map "\es" 'comint-next-matching-input)
514 515
  (define-key comint-mode-map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
  (define-key comint-mode-map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
516
  (define-key comint-mode-map "\e\C-l" 'comint-show-output)
Jim Blandy's avatar
Jim Blandy committed
517 518
  (define-key comint-mode-map "\C-m" 'comint-send-input)
  (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
519
  (define-key comint-mode-map "\C-c " 'comint-accumulate)
520
  (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
521
  (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526
  (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
  (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
  (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
  (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
  (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
527
  (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
Jim Blandy's avatar
Jim Blandy committed
528 529
  (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
  (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
530
  (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
531
  (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
532
  (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
533
  (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
534
  (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
535 536 537 538
  ;; Mouse Buttons:
  ;; Note, if you change this, you will have to change
  ;; comint-insert-clicked-input as well
  (define-key comint-mode-map [mouse-2] 'comint-insert-clicked-input)
539 540 541
  ;; Menu bars:
  ;; completion:
  (define-key comint-mode-map [menu-bar completion] 
542
    (cons "Complete" (make-sparse-keymap "Complete")))
543 544 545 546 547 548 549 550 551
  (define-key comint-mode-map [menu-bar completion complete-expand]
    '("Expand File Name" . comint-replace-by-expanded-filename))
  (define-key comint-mode-map [menu-bar completion complete-listing]
    '("File Completion Listing" . comint-dynamic-list-filename-completions))
  (define-key comint-mode-map [menu-bar completion complete-file]
    '("Complete File Name" . comint-dynamic-complete-filename))
  (define-key comint-mode-map [menu-bar completion complete]
    '("Complete Before Point" . comint-dynamic-complete))
  ;; Input history:
552
  (define-key comint-mode-map [menu-bar inout] 
553
    (cons "In/Out" (make-sparse-keymap "In/Out")))
554
  (define-key comint-mode-map [menu-bar inout kill-output]
555
    '("Kill Current Output Group" . comint-kill-output))
556
  (define-key comint-mode-map [menu-bar inout next-prompt]
557
    '("Forward Output Group" . comint-next-prompt))
558
  (define-key comint-mode-map [menu-bar inout previous-prompt]
559
    '("Backward Output Group" . comint-previous-prompt))
560
  (define-key comint-mode-map [menu-bar inout show-maximum-output]
561
    '("Show Maximum Output" . comint-show-maximum-output))
562
  (define-key comint-mode-map [menu-bar inout show-output]
563
    '("Show Current Output Group" . comint-show-output))
564
  (define-key comint-mode-map [menu-bar inout kill-input]
565
    '("Kill Current Input" . comint-kill-input))
566
  (define-key comint-mode-map [menu-bar inout copy-input]
567
    '("Copy Old Input" . comint-copy-old-input))
568
  (define-key comint-mode-map [menu-bar inout forward-matching-history]
569
    '("Forward Matching Input..." . comint-forward-matching-input))
570
  (define-key comint-mode-map [menu-bar inout backward-matching-history]
571
    '("Backward Matching Input..." . comint-backward-matching-input))
572
  (define-key comint-mode-map [menu-bar inout next-matching-history]
573
    '("Next Matching Input..." . comint-next-matching-input))
574
  (define-key comint-mode-map [menu-bar inout previous-matching-history]
575
    '("Previous Matching Input..." . comint-previous-matching-input))
576
  (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
577
    '("Next Matching Current Input" . comint-next-matching-input-from-input))
578
  (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
579
    '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
580
  (define-key comint-mode-map [menu-bar inout next-history]
581
    '("Next Input" . comint-next-input))
582
  (define-key comint-mode-map [menu-bar inout previous-history]
583
    '("Previous Input" . comint-previous-input))
584
  (define-key comint-mode-map [menu-bar inout list-history]
585
    '("List Input History" . comint-dynamic-list-input-ring))
586
  (define-key comint-mode-map [menu-bar inout expand-history]
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
    '("Expand History Before Point" . comint-replace-by-expanded-history))
  ;; Signals
  (define-key comint-mode-map [menu-bar signals]
    (cons "Signals" (make-sparse-keymap "Signals")))
  (define-key comint-mode-map [menu-bar signals eof]
    '("EOF" . comint-send-eof))
  (define-key comint-mode-map [menu-bar signals kill]
    '("KILL" . comint-kill-subjob))
  (define-key comint-mode-map [menu-bar signals quit]
    '("QUIT" . comint-quit-subjob))
  (define-key comint-mode-map [menu-bar signals cont]
    '("CONT" . comint-continue-subjob))
  (define-key comint-mode-map [menu-bar signals stop]
    '("STOP" . comint-stop-subjob))
  (define-key comint-mode-map [menu-bar signals break]
    '("BREAK" . comint-interrupt-subjob))
  ;; Put them in the menu bar:
604
  (setq menu-bar-final-items (append '(completion inout signals)
605
				     menu-bar-final-items))
Jim Blandy's avatar
Jim Blandy committed
606 607 608
  )

(defun comint-check-proc (buffer)
609
  "Return t if there is a living process associated w/buffer BUFFER.
610
Living means the status is `open', `run', or `stop'.
611
BUFFER can be either a buffer or the name of one."
Jim Blandy's avatar
Jim Blandy committed
612
  (let ((proc (get-buffer-process buffer)))
613
    (and proc (memq (process-status proc) '(open run stop)))))
David Lawrence's avatar
David Lawrence committed
614

615
;;;###autoload
David Lawrence's avatar
David Lawrence committed
616
(defun make-comint (name program &optional startfile &rest switches)
617 618
  "Make a comint process NAME in a buffer, running PROGRAM.
The name of the buffer is made by surrounding NAME with `*'s.
619 620 621 622 623 624 625
PROGRAM should be either a string denoting an executable program to create
via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
connection to be opened via `open-network-stream'.  If there is already a
running process in that buffer, it is not restarted.  Optional third arg
STARTFILE is the name of a file to send the contents of to the process.

If PROGRAM is a string, any more args are arguments to PROGRAM."
626 627
  (or (fboundp 'start-process)
      (error "Multi-processing is not supported for this system"))
Jim Blandy's avatar
Jim Blandy committed
628
  (let ((buffer (get-buffer-create (concat "*" name "*"))))
David Lawrence's avatar
David Lawrence committed
629
    ;; If no process, or nuked process, crank up a new one and put buffer in
630
    ;; comint mode.  Otherwise, leave buffer and existing process alone.
Jim Blandy's avatar
Jim Blandy committed
631
    (cond ((not (comint-check-proc buffer))
Jim Blandy's avatar
Jim Blandy committed
632
	   (save-excursion
David Lawrence's avatar
David Lawrence committed
633 634 635 636 637
	     (set-buffer buffer)
	     (comint-mode)) ; Install local vars, mode, keymap, ...
	   (comint-exec buffer name program startfile switches)))
    buffer))

638
;;;###autoload
639 640 641 642 643 644 645 646 647 648 649
(defun comint-run (program)
  "Run PROGRAM in a comint buffer and switch to it.
The buffer name is made by surrounding the file name of PROGRAM with `*'s.
The file name is used to make a symbol name, such as `comint-sh-hook', and any
hooks on this symbol are run in the buffer.
See `make-comint' and `comint-exec'."
  (interactive "sRun program: ")
  (let ((name (file-name-nondirectory program)))
    (switch-to-buffer (make-comint name program))
    (run-hooks (intern-soft (concat "comint-" name "-hook")))))

David Lawrence's avatar
David Lawrence committed
650
(defun comint-exec (buffer name command startfile switches)
651
  "Start up a process in buffer BUFFER for comint modes.
652
Blasts any old process running in the buffer.  Doesn't set the buffer mode.
Jim Blandy's avatar
Jim Blandy committed
653
You can use this to cheaply run a series of processes in the same comint
654
buffer.  The hook `comint-exec-hook' is run after each exec."
David Lawrence's avatar
David Lawrence committed
655 656 657 658 659
  (save-excursion
    (set-buffer buffer)
    (let ((proc (get-buffer-process buffer)))	; Blast any old process.
      (if proc (delete-process proc)))
    ;; Crank up a new process
660 661 662 663
    (let ((proc
	   (if (consp command)
	       (open-network-stream name buffer (car command) (cdr command))
	     (comint-exec-1 name buffer command switches))))
664
      (set-process-filter proc 'comint-output-filter)
Jim Blandy's avatar
Jim Blandy committed
665 666
      (make-local-variable 'comint-ptyp)
      (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
David Lawrence's avatar
David Lawrence committed
667
      ;; Jump to the end, and set the process mark.
Jim Blandy's avatar
Jim Blandy committed
668
      (goto-char (point-max))
Jim Blandy's avatar
Jim Blandy committed
669
      (set-marker (process-mark proc) (point))
David Lawrence's avatar
David Lawrence committed
670 671 672 673 674 675 676 677 678 679 680 681
      ;; Feed it the startfile.
      (cond (startfile
	     ;;This is guaranteed to wait long enough
	     ;;but has bad results if the comint does not prompt at all
	     ;;	     (while (= size (buffer-size))
	     ;;	       (sleep-for 1))
	     ;;I hope 1 second is enough!
	     (sleep-for 1)
	     (goto-char (point-max))
	     (insert-file-contents startfile)
	     (setq startfile (buffer-substring (point) (point-max)))
	     (delete-region (point) (point-max))
Jim Blandy's avatar
Jim Blandy committed
682 683
	     (comint-send-string proc startfile)))
    (run-hooks 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
684
    buffer)))
David Lawrence's avatar
David Lawrence committed
685

Erik Naggum's avatar
Erik Naggum committed
686 687
;; This auxiliary function cranks up the process for comint-exec in
;; the appropriate environment.
David Lawrence's avatar
David Lawrence committed
688 689

(defun comint-exec-1 (name buffer command switches)
690
  (let ((process-environment
691
	 (nconc
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693
	  ;; If using termcap, we specify `emacs' as the terminal type
	  ;; because that lets us specify a width.
694
	  ;; If using terminfo, we specify `dumb' because that is
Richard M. Stallman's avatar
Richard M. Stallman committed
695 696 697 698
	  ;; a defined terminal type.  `emacs' is not a defined terminal type
	  ;; and there is no way for us to define it here.
	  ;; Some programs that use terminfo get very confused
	  ;; if TERM is not a valid terminal type.
699
	  (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
700
	      (list "TERM=dumb" "TERMCAP="
701
		    (format "COLUMNS=%d" (frame-width)))
702
	    (list "TERM=emacs"
703
		  (format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
704
	  (if (getenv "EMACS") nil (list "EMACS=t"))
705 706
	  process-environment))
	(default-directory
707
	  (if (file-accessible-directory-p default-directory)
708
	      default-directory
709 710
	    (char-to-string directory-sep-char)))
	proc decoding encoding changed)
711 712 713 714 715
    (let ((exec-path (if (file-name-directory command)
			 ;; If the command has slashes, make sure we
			 ;; first look relative to the current directory.
			 (cons default-directory exec-path) exec-path)))
      (setq proc (apply 'start-process name buffer command switches)))
716 717 718 719
    (let ((coding-systems (process-coding-system proc)))
      (setq decoding (car coding-systems)
	    encoding (cdr coding-systems)))
    ;; If start-process decided to use some coding system for decoding
720
    ;; data sent from the process and the coding system doesn't
721 722 723 724 725 726 727 728 729 730 731 732 733 734
    ;; specify EOL conversion, we had better convert CRLF to LF.
    (if (vectorp (coding-system-eol-type decoding))
	(setq decoding (coding-system-change-eol-conversion decoding 'dos)
	      changed t))
    ;; Even if start-process left the coding system for encoding data
    ;; sent from the process undecided, we had better use the same one
    ;; as what we use for decoding.  But, we should suppress EOL
    ;; conversion.
    (if (and decoding (not encoding))
	(setq encoding (coding-system-change-eol-conversion decoding 'unix)
	      changed t))
    (if changed
	(set-process-coding-system proc decoding encoding))
    proc))
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761


(defun comint-insert-clicked-input (event)
  "In a comint buffer, set the current input to the clicked-on previous input."
  (interactive "e")
  ;; This won't play nicely with other overlays...
  (let ((overs (overlays-at (posn-point (event-end event)))))
    ;; do we have input in this area?
    (if overs
	(let ((input-str (buffer-substring (overlay-start (car overs))
					   (overlay-end (car overs)))))
	  (if (not (comint-after-pmark-p))
	      (error "Not at command line"))
	  (delete-region 
	   ;; Can't use kill-region as it sets this-command
	   (or  (marker-position comint-accum-marker)
		(process-mark (get-buffer-process (current-buffer))))
	   (point))	  
	  (insert input-str))
      ;; fall back to the user's previous definition if we aren't
      ;; on previous input region (note, if you change [mouse-2]
      ;; to something else, you should also change the default
      ;; keybinding above)
      (let ((fun (lookup-key global-map [mouse-2])))
	(if fun
	    (call-interactively fun event nil))))))
  
David Lawrence's avatar
David Lawrence committed
762

Erik Naggum's avatar
Erik Naggum committed
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
;; Input history processing in a buffer
;; ===========================================================================
;; Useful input history functions, courtesy of the Ergo group.

;; Eleven commands:
;; comint-dynamic-list-input-ring	List history in help buffer.
;; comint-previous-input		Previous input...
;; comint-previous-matching-input	...matching a string.
;; comint-previous-matching-input-from-input ... matching the current input.
;; comint-next-input			Next input...
;; comint-next-matching-input		...matching a string.
;; comint-next-matching-input-from-input     ... matching the current input.
;; comint-backward-matching-input      Backwards input...
;; comint-forward-matching-input       ...matching a string.
;; comint-replace-by-expanded-history	Expand history at point;
;;					replace with expanded history.
;; comint-magic-space			Expand history and insert space.
;;
;; Three functions:
;; comint-read-input-ring              Read into comint-input-ring...
;; comint-write-input-ring             Write to comint-input-ring-file-name.
;; comint-replace-by-expanded-history-before-point Workhorse function.
785

786
(defun comint-read-input-ring (&optional silent)
787 788 789 790 791
  "Sets the buffer's `comint-input-ring' from a history file.
The name of the file is given by the variable `comint-input-ring-file-name'.
The history ring is of size `comint-input-ring-size', regardless of file size.
If `comint-input-ring-file-name' is nil this function does nothing.

792 793
If the optional argument SILENT is non-nil, we say nothing about a
failure to read the history file.
794

795 796
This function is useful for major mode commands and mode hooks.

797 798 799
The commands stored in the history file are separated by the
`comint-input-ring-separator'.  The most recent command comes last.

800
See also `comint-input-ignoredups' and `comint-write-input-ring'."
801 802
  (cond ((or (null comint-input-ring-file-name)
	     (equal comint-input-ring-file-name ""))
803 804
	 nil)
	((not (file-readable-p comint-input-ring-file-name))
805 806 807
	 (or silent
	     (message "Cannot read history file %s"
		      comint-input-ring-file-name)))
808
	(t
809 810 811 812 813
	 (let* ((history-buf (get-buffer-create " *temp*"))
		(file comint-input-ring-file-name)
		(count 0)
		(size comint-input-ring-size)
		(ring (make-ring size)))
814 815 816
	   (unwind-protect
	       (save-excursion
		 (set-buffer history-buf)
817
		 (widen)
818 819 820 821 822
		 (erase-buffer)
		 (insert-file-contents file)
		 ;; Save restriction in case file is already visited...
		 ;; Watch for those date stamps in history files!
		 (goto-char (point-max))
823
		 (while (and (< count size)
824 825
			     (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
						 nil t))
826 827 828 829 830 831 832 833 834 835 836 837 838
	       (let (start end history)
		 (while (and (< count comint-input-ring-size)
			     (re-search-backward comint-input-ring-separator nil t)
			     (setq end (match-beginning 0))
			     (re-search-backward comint-input-ring-separator nil t)
			     (setq start (match-end 0))
			     (setq history (buffer-substring start end))
			     (goto-char start))
		   (if (or (null comint-input-ignoredups)
			   (ring-empty-p ring)
			   (not (string-equal (ring-ref ring 0) history)))
		       (ring-insert-at-beginning ring history)))
		 (setq count (1+ count)))))
839
	     (kill-buffer history-buf))
840 841 842 843 844 845 846 847 848 849 850 851 852
	   (setq comint-input-ring ring
		 comint-input-ring-index nil)))))

(defun comint-write-input-ring ()
  "Writes the buffer's `comint-input-ring' to a history file.
The name of the file is given by the variable `comint-input-ring-file-name'.
The original contents of the file are lost if `comint-input-ring' is not empty.
If `comint-input-ring-file-name' is nil this function does nothing.

Useful within process sentinels.

See also `comint-read-input-ring'."
  (cond ((or (null comint-input-ring-file-name)
853
	     (equal comint-input-ring-file-name "")
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
	     (null comint-input-ring) (ring-empty-p comint-input-ring))
	 nil)
	((not (file-writable-p comint-input-ring-file-name))
	 (message "Cannot write history file %s" comint-input-ring-file-name))
	(t
	 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
		(ring comint-input-ring)
		(file comint-input-ring-file-name)
		(index (ring-length ring)))
	   ;; Write it all out into a buffer first.  Much faster, but messier,
	   ;; than writing it one line at a time.
	   (save-excursion
	     (set-buffer history-buf)
	     (erase-buffer)
	     (while (> index 0)
	       (setq index (1- index))
870
               (insert (ring-ref ring index) comint-input-ring-separator))
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
	     (write-region (buffer-string) nil file nil 'no-message)
	     (kill-buffer nil))))))


(defun comint-dynamic-list-input-ring ()
  "List in help buffer the buffer's input history."
  (interactive)
  (if (or (not (ring-p comint-input-ring))
	  (ring-empty-p comint-input-ring))
      (message "No history")
    (let ((history nil)
	  (history-buffer " *Input History*")
	  (index (1- (ring-length comint-input-ring)))
	  (conf (current-window-configuration)))
      ;; We have to build up a list ourselves from the ring vector.
      (while (>= index 0)
	(setq history (cons (ring-ref comint-input-ring index) history)
	      index (1- index)))
      ;; Change "completion" to "history reference"
      ;; to make the display accurate.
      (with-output-to-temp-buffer history-buffer
	(display-completion-list history)
	(set-buffer history-buffer)
	(forward-line 3)
	(while (search-backward "completion" nil 'move)
	  (replace-match "history reference")))
      (sit-for 0)
      (message "Hit space to flush")
      (let ((ch (read-event)))
	(if (eq ch ?\ )
	    (set-window-configuration conf)
	  (setq unread-command-events (list ch)))))))


(defun comint-regexp-arg (prompt)
  ;; Return list of regexp and prefix arg using PROMPT.
907
  (let* (;; Don't clobber this.
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
	 (last-command last-command)
	 (regexp (read-from-minibuffer prompt nil nil nil
				       'minibuffer-history-search-history)))
    (list (if (string-equal regexp "")
	      (setcar minibuffer-history-search-history
		      (nth 1 minibuffer-history-search-history))
	    regexp)
	  (prefix-numeric-value current-prefix-arg))))

(defun comint-search-arg (arg)
  ;; First make sure there is a ring and that we are after the process mark
  (cond ((not (comint-after-pmark-p))
	 (error "Not at command line"))
	((or (null comint-input-ring)
	     (ring-empty-p comint-input-ring))
	 (error "Empty input ring"))
	((zerop arg)
	 ;; arg of zero resets search from beginning, and uses arg of 1
	 (setq comint-input-ring-index nil)
	 1)
	(t
	 arg)))

(defun comint-search-start (arg)
  ;; Index to start a directional search, starting at comint-input-ring-index
  (if comint-input-ring-index
      ;; If a search is running, offset by 1 in direction of arg
      (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
	   (ring-length comint-input-ring))
    ;; For a new search, start from beginning or end, as appropriate
    (if (>= arg 0)
	0				       ; First elt for forward search
      (1- (ring-length comint-input-ring)))))  ; Last elt for backward search

(defun comint-previous-input-string (arg)
  "Return the string ARG places along the input ring.
Moves relative to `comint-input-ring-index'."
  (ring-ref comint-input-ring (if comint-input-ring-index
				  (mod (+ arg comint-input-ring-index) 
				       (ring-length comint-input-ring))
				arg)))
David Lawrence's avatar
David Lawrence committed
949 950 951 952

(defun comint-previous-input (arg)
  "Cycle backwards through input history."
  (interactive "*p")
953
  (comint-previous-matching-input "." arg))
954

David Lawrence's avatar
David Lawrence committed
955 956 957 958 959
(defun comint-next-input (arg)
  "Cycle forwards through input history."
  (interactive "*p")
  (comint-previous-input (- arg)))

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
(defun comint-previous-matching-input-string (regexp arg)
  "Return the string matching REGEXP ARG places along the input ring.
Moves relative to `comint-input-ring-index'."
  (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
    (if pos (ring-ref comint-input-ring pos))))

(defun comint-previous-matching-input-string-position (regexp arg &optional start)
  "Return the index matching REGEXP ARG places along the input ring.
Moves relative to START, or `comint-input-ring-index'."
  (if (or (not (ring-p comint-input-ring))
	  (ring-empty-p comint-input-ring))
      (error "No history"))
  (let* ((len (ring-length comint-input-ring))
	 (motion (if (> arg 0) 1 -1))
	 (n (mod (- (or start (comint-search-start arg)) motion) len))
	 (tried-each-ring-item nil)
	 (prev nil))
    ;; Do the whole search as many times as the argument says.
    (while (and (/= arg 0) (not tried-each-ring-item))
      ;; Step once.
      (setq prev n
	    n (mod (+ n motion) len))
      ;; If we haven't reached a match, step some more.
      (while (and (< n len) (not tried-each-ring-item)
		  (not (string-match regexp (ring-ref comint-input-ring n))))
	(setq n (mod (+ n motion) len)
	      ;; If we have gone all the way around in this search.
	      tried-each-ring-item (= n prev)))
      (setq arg (if (> arg 0) (1- arg) (1+ arg))))
    ;; Now that we know which ring element to use, if we found it, return that.
    (if (string-match regexp (ring-ref comint-input-ring n))
	n)))

993 994 995 996 997
(defun comint-previous-matching-input (regexp arg)
  "Search backwards through input history for match for REGEXP.
\(Previous history elements are earlier commands.)
With prefix argument N, search for Nth previous match.
If N is negative, find the next or Nth next match."
998 999 1000 1001 1002 1003 1004 1005 1006 1007
  (interactive (comint-regexp-arg "Previous input matching (regexp): "))
  (setq arg (comint-search-arg arg))
  (let ((pos (comint-previous-matching-input-string-position regexp arg)))
    ;; Has a match been found?
    (if (null pos)
	(error "Not found")
      (setq comint-input-ring-index pos)
      (message "History item: %d" (1+ pos))
      (delete-region 
       ;; Can't use kill-region as it sets this-command
1008 1009 1010
       (or  (marker-position comint-accum-marker)
	    (process-mark (get-buffer-process (current-buffer))))
       (point))
1011
      (insert (ring-ref comint-input-ring pos)))))
1012 1013 1014 1015 1016 1017

(defun comint-next-matching-input (regexp arg)
  "Search forwards through input history for match for REGEXP.
\(Later history elements are more recent commands.)
With prefix argument N, search for Nth following match.
If N is negative, find the previous or Nth previous match."