;;; comint.el --- general command interpreter in a window stuff
-;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96 Free Software Foundation, Inc.
+;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98 Free Software Foundation, Inc.
-;; Author: Olin Shivers <shivers@cs.cmu.edu>
-;; Adapted-by: Simon Marshall <simon@gnu.ai.mit.edu>
+;; Author: Olin Shivers <shivers@cs.cmu.edu> then
+;; Simon Marshall <simon@gnu.ai.mit.edu>
+;; Maintainer: FSF
;; Keywords: processes
;; This file is part of GNU Emacs.
;; comint-get-old-input function Hooks for specific
;; comint-input-filter-functions hook process-in-a-buffer
;; comint-output-filter-functions hook function modes.
+;; comint-preoutput-filter-functions hook
;; comint-input-filter function ...
;; comint-input-sender function ...
;; comint-eol-on-send boolean ...
;; comint-completion-autolist boolean completion behavior
;; comint-completion-recexact boolean ...
+(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)
+
+
(defvar comint-prompt-regexp "^"
"Regexp to recognise prompts in the inferior process.
Defaults to \"^\", the null string at BOL.
This is a good thing to set in mode hooks.")
-(defvar comint-input-autoexpand nil
+(defcustom comint-input-autoexpand nil
"*If non-nil, expand input command history references on completion.
This mirrors the optional behavior of tcsh (its autoexpand and histlit).
into the buffer's input ring. See also `comint-magic-space' and
`comint-dynamic-complete'.
-This variable is buffer-local.")
+This variable is buffer-local."
+ :type '(choice (const :tag "off" nil)
+ (const :tag "on" t)
+ (const input)
+ (const history))
+ :group 'comint)
-(defvar comint-input-ignoredups nil
+(defcustom comint-input-ignoredups nil
"*If non-nil, don't add input matching the last on the input ring.
This mirrors the optional behavior of bash.
-This variable is buffer-local.")
+This variable is buffer-local."
+ :type 'boolean
+ :group 'comint)
-(defvar comint-input-ring-file-name nil
+(defcustom comint-input-ring-file-name nil
"*If non-nil, name of the file to read/write input history.
See also `comint-read-input-ring' and `comint-write-input-ring'.
-This variable is buffer-local, and is a good thing to set in mode hooks.")
+This variable is buffer-local, and is a good thing to set in mode hooks."
+ :type 'boolean
+ :group 'comint)
-(defvar comint-scroll-to-bottom-on-input nil
+(defcustom comint-scroll-to-bottom-on-input nil
"*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.
The default is nil.
-See `comint-preinput-scroll-to-bottom'. This variable is buffer-local.")
+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)
-(defvar comint-scroll-to-bottom-on-output nil
+(defcustom comint-scroll-to-bottom-on-output nil
"*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.
The default is nil.
See variable `comint-scroll-show-maximum-output' and function
-`comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
-
-(defvar comint-scroll-show-maximum-output nil
+`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
"*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
See variable `comint-scroll-to-bottom-on-output' and function
-`comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
+`comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
+ :type 'boolean
+ :group 'comint)
-(defvar comint-buffer-maximum-size 1024
+(defcustom comint-buffer-maximum-size 1024
"*The maximum size in lines for comint buffers.
Comint buffers are truncated from the top to be no greater than this number, if
-the function `comint-truncate-buffer' is on `comint-output-filter-functions'.")
+the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
+ :type 'integer
+ :group 'comint)
(defvar comint-input-ring-size 32
"Size of input history ring.")
-(defvar comint-process-echoes nil
+(defcustom comint-process-echoes nil
"*If non-nil, assume that the subprocess echoes any input.
If so, delete one copy of the input so that only one copy eventually
appears in the buffer.
-This variable is buffer-local.")
+This variable is buffer-local."
+ :type 'boolean
+ :group 'comint)
-(defvar comint-password-prompt-regexp
+;; AIX puts the name of the person being su'd to in from of the prompt.
+(defcustom comint-password-prompt-regexp
"\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|^\\)[Pp]assword\\|pass phrase\\):\\s *\\'"
"*Regexp matching prompts for passwords in the inferior process.
-This is used by `comint-watch-for-password-prompt'.")
+This is used by `comint-watch-for-password-prompt'."
+ :type 'regexp
+ :group 'comint)
;; Here are the per-interpreter hooks.
(defvar comint-get-old-input (function comint-get-old-input-default)
`comint-last-output-start' and the buffer's `process-mark', if other filter
functions have already modified the buffer.
+See also `comint-preoutput-filter-functions'.
+
This variable is buffer-local.")
(defvar comint-input-sender (function comint-simple-send)
`comint-simple-send' just sends the string plus a newline.
This is called from the user command `comint-send-input'.")
-(defvar comint-eol-on-send t
+(defcustom comint-eol-on-send t
"*Non-nil means go to the end of the line before sending input.
-See `comint-send-input'.")
+See `comint-send-input'."
+ :type 'boolean
+ :group 'comint)
-(defvar comint-mode-hook '()
+(defcustom comint-mode-hook '()
"Called upon entry into comint-mode
-This is run before the process is cranked up.")
+This is run before the process is cranked up."
+ :type 'hook
+ :group 'comint)
-(defvar comint-exec-hook '()
+(defcustom comint-exec-hook '()
"Called each time a process is exec'd by `comint-exec'.
This is called after the process is cranked up. It is useful for things that
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
-executed once when the buffer is created.")
+executed once when the buffer is created."
+ :type 'hook
+ :group 'comint)
(defvar comint-mode-map nil)
(put 'comint-input-autoexpand 'permanent-local t)
(put 'comint-input-filter-functions 'permanent-local t)
(put 'comint-output-filter-functions 'permanent-local t)
+(put 'comint-preoutput-filter-functions 'permanent-local t)
(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)
(put 'comint-ptyp 'permanent-local t)
+(put 'comint-mode 'mode-class 'special)
+
(defun comint-mode ()
"Major mode for interacting with an inferior interpreter.
Interpreter name is same as buffer name, sans the asterisks.
Input to, and output from, the subprocess can cause the window to scroll to
the end of the buffer. See variables `comint-output-filter-functions',
-`comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
+`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
+and `comint-scroll-to-bottom-on-output'.
If you accidentally suspend your process, use \\[comint-continue-subjob]
to continue it.
;; Some programs that use terminfo get very confused
;; if TERM is not a valid terminal type.
(if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
- (list "TERM=dumb"
+ (list "TERM=dumb" "TERMCAP="
(format "COLUMNS=%d" (frame-width)))
(list "TERM=emacs"
(format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
(default-directory
(if (file-accessible-directory-p default-directory)
default-directory
- "/")))
+ (char-to-string directory-sep-char))))
(apply 'start-process name buffer command switches)))
\f
;; Input history processing in a buffer
(defun comint-regexp-arg (prompt)
;; Return list of regexp and prefix arg using PROMPT.
- (let* ((minibuffer-history-sexp-flag nil)
- ;; Don't clobber this.
+ (let* (;; Don't clobber this.
(last-command last-command)
(regexp (read-from-minibuffer prompt nil nil nil
'minibuffer-history-search-history)))
(comint-previous-matching-input-from-input (- arg)))
-(defun comint-replace-by-expanded-history (&optional silent)
+(defun comint-replace-by-expanded-history (&optional silent start)
"Expand input command history references before point.
Expansion is dependent on the value of `comint-input-autoexpand'.
If the optional argument SILENT is non-nil, never complain
even if history reference seems erroneous.
+If the optional argument START is non-nil, that specifies the
+start of the text to scan for history references, rather
+than the logical beginning of line.
+
See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
Returns t if successful."
(looking-at comint-prompt-regexp)))
;; Looks like there might be history references in the command.
(let ((previous-modified-tick (buffer-modified-tick)))
- (message "Expanding history references...")
- (comint-replace-by-expanded-history-before-point silent)
+ (comint-replace-by-expanded-history-before-point silent start)
(/= previous-modified-tick (buffer-modified-tick)))))
-(defun comint-replace-by-expanded-history-before-point (silent)
+(defun comint-replace-by-expanded-history-before-point (silent &optional start)
"Expand directory stack reference before point.
-See `comint-replace-by-expanded-history'. Returns t if successful."
+See `comint-replace-by-expanded-history'. Returns t if successful.
+
+If the optional argument START is non-nil, that specifies the
+start of the text to scan for history references, rather
+than the logical beginning of line."
(save-excursion
(let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
- (start (progn (comint-bol nil) (point))))
+ (start (or start (progn (comint-bol nil) (point)))))
(while (progn
(skip-chars-forward "^!^"
(save-excursion
(replace-match new t t)
(message "History item: substituted"))))
(t
- (goto-char (match-end 0))))))))
+ (forward-char 1)))))))
(defun comint-magic-space (arg)
Also, a run of one or more of a single character
in `comint-delimiter-argument-list' is a separate argument.
Argument 0 is the command name."
- (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
+ ;; The first line handles ordinary characters and backslash-sequences.
+ ;; The second matches "-quoted strings.
+ ;; The third matches '-quoted strings.
+ ;; The fourth matches `-quoted strings.
+ ;; This seems to fit the syntax of BASH 2.0.
+ (let ((argpart "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\]+\\|\
+\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
+'[^']*'\\|\
+`[^`]*`\\)")
(args ()) (pos 0)
(count 0)
beg str value quotes)
;; Just whatever's already there
intxt
;; Expand and leave it visible in buffer
- (comint-replace-by-expanded-history t)
+ (comint-replace-by-expanded-history t pmark)
(buffer-substring pmark (point))))
(history (if (not (eq comint-input-autoexpand 'history))
input
;; This is messy 'cos ultimately the original
;; functions used do insertion, rather than return
;; strings. We have to expand, then insert back.
- (comint-replace-by-expanded-history t)
- (let ((copy (buffer-substring pmark (point))))
- (delete-region pmark (point))
- (insert-before-markers input)
+ (comint-replace-by-expanded-history t pmark)
+ (let ((copy (buffer-substring pmark (point)))
+ (start (point)))
+ (insert input)
+ (delete-region pmark start)
copy))))
(if comint-process-echoes
(delete-region pmark (point))
;; but that scrolled the buffer in undesirable ways.
(run-hook-with-args 'comint-output-filter-functions "")))))
+(defvar comint-preoutput-filter-functions nil
+ "Functions to call before output is inserted into the buffer.
+These functions get one argument, a string containing the text to be
+inserted. They return the string as it should be inserted.
+
+This variable is buffer-local.")
+
;; The purpose of using this filter for comint processes
;; is to keep comint-last-input-end from moving forward
;; when output is inserted.
(defun comint-output-filter (process string)
;; First check for killed buffer
(let ((oprocbuf (process-buffer process)))
- (if (and oprocbuf (buffer-name oprocbuf))
+ (let ((functions comint-preoutput-filter-functions))
+ (while (and functions string)
+ (setq string (funcall (car functions) string))
+ (setq functions (cdr functions))))
+ (if (and string oprocbuf (buffer-name oprocbuf))
(let ((obuf (current-buffer))
(opoint nil) (obeg nil) (oend nil))
(set-buffer oprocbuf)
(interactive)
(let ((pmark (process-mark (get-buffer-process (current-buffer)))))
(save-excursion
- (goto-char
- (if (interactive-p) comint-last-input-end comint-last-output-start))
+ (condition-case nil
+ (goto-char
+ (if (interactive-p) comint-last-input-end comint-last-output-start))
+ (error nil))
(while (re-search-forward "\r+$" pmark t)
(replace-match "" t t)))))
(defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
The string is sent using `comint-input-sender'.
Security bug: your string can still be temporarily recovered with
\\[view-lossage]."
- (interactive "P") ; Defeat snooping via C-x ESC ESC
+ (interactive "P") ; Defeat snooping via C-x ESC ESC
(let ((proc (get-buffer-process (current-buffer))))
- (if (not proc)
- (error "Current buffer has no process")
- (funcall comint-input-sender proc
- (if (stringp str) str (comint-read-noecho "Non-echoed text: " t))))))
+ (cond ((not proc)
+ (error "Current buffer has no process"))
+ ((stringp str)
+ (funcall comint-input-sender proc str))
+ (t
+ (let ((str (comint-read-noecho "Non-echoed text: " t)))
+ (if (stringp str)
+ (send-invisible str)
+ (message "Warning: text will be echoed")))))))
(defun comint-watch-for-password-prompt (string)
"Prompt in the minibuffer for password and send without echoing.
(comint-skip-prompt)))
(defun comint-interrupt-subjob ()
- "Interrupt the current subjob."
+ "Interrupt the current subjob.
+This command also kills the pending input
+between the process-mark and point."
(interactive)
+ (comint-kill-input)
(interrupt-process nil comint-ptyp))
(defun comint-kill-subjob ()
- "Send kill signal to the current subjob."
+ "Send kill signal to the current subjob.
+This command also kills the pending input
+between the process-mark and point."
(interactive)
+ (comint-kill-input)
(kill-process nil comint-ptyp))
(defun comint-quit-subjob ()
- "Send quit signal to the current subjob."
+ "Send quit signal to the current subjob.
+This command also kills the pending input
+between the process-mark and point."
(interactive)
+ (comint-kill-input)
(quit-process nil comint-ptyp))
(defun comint-stop-subjob ()
"Stop the current subjob.
+This command also kills the pending input
+between the process-mark and point.
+
WARNING: if there is no current subjob, you can end up suspending
the top-level process running in the buffer. If you accidentally do
this, use \\[comint-continue-subjob] to resume the process. (This
is not a problem with most shells, since they ignore this signal.)"
(interactive)
+ (comint-kill-input)
(stop-process nil comint-ptyp))
(defun comint-continue-subjob ()
(kill-region pmark (point)))))
(defun comint-delchar-or-maybe-eof (arg)
- "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
+ "Delete ARG characters forward or send an EOF to subprocess.
+Sends an EOF only if point is at the end of the buffer and there is no input."
(interactive "p")
- (if (eobp)
- (process-send-eof)
- (delete-char arg)))
+ (let ((proc (get-buffer-process (current-buffer))))
+ (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
+ (process-send-eof)
+ (delete-char arg))))
(defun comint-send-eof ()
"Send an EOF to the current buffer's process."
;; Try to position the proc window so you can see the answer.
;; This is bogus code. If you delete the (sit-for 0), it breaks.
;; I don't know why. Wizards invited to improve it.
- (if (not (pos-visible-in-window-p proc-pt proc-win))
- (let ((opoint (window-point proc-win)))
- (set-window-point proc-win proc-mark)
- (sit-for 0)
- (if (not (pos-visible-in-window-p opoint proc-win))
- (push-mark opoint)
- (set-window-point proc-win opoint)))))))
+ (unless (pos-visible-in-window-p proc-pt proc-win)
+ (let ((opoint (window-point proc-win)))
+ (set-window-point proc-win proc-mark)
+ (sit-for 0)
+ (if (not (pos-visible-in-window-p opoint proc-win))
+ (push-mark opoint)
+ (set-window-point proc-win opoint)))))))
\f
;; Filename/command/history completion in a buffer
;; Commands like this are fine things to put in load hooks if you
;; want them present in specific modes.
-(defvar comint-completion-autolist nil
+(defcustom comint-completion-autolist nil
"*If non-nil, automatically list possibilities on partial completion.
-This mirrors the optional behavior of tcsh.")
+This mirrors the optional behavior of tcsh."
+ :type 'boolean
+ :group 'comint-completion)
-(defvar comint-completion-addsuffix t
+(defcustom comint-completion-addsuffix t
"*If non-nil, add a `/' to completed directories, ` ' to file names.
If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
-This mirrors the optional behavior of tcsh.")
+This mirrors the optional behavior of tcsh."
+ :type 'boolean
+ :group 'comint-completion)
-(defvar comint-completion-recexact nil
+(defcustom comint-completion-recexact nil
"*If non-nil, use shortest completion if characters cannot be added.
This mirrors the optional behavior of tcsh.
-A non-nil value is useful if `comint-completion-autolist' is non-nil too.")
+A non-nil value is useful if `comint-completion-autolist' is non-nil too."
+ :type 'boolean
+ :group 'comint-completion)
-(defvar comint-completion-fignore nil
+(defcustom comint-completion-fignore nil
"*List of suffixes to be disregarded during file completion.
This mirrors the optional behavior of bash and tcsh.
-Note that this applies to `comint-dynamic-complete-filename' only.")
+Note that this applies to `comint-dynamic-complete-filename' only."
+ :type '(repeat (string :tag "Suffix"))
+ :group 'comint-completion)
(defvar comint-file-name-prefix ""
"Prefix prepended to absolute file names taken from process input.
(defvar comint-file-name-chars
(if (memq system-type '(ms-dos windows-nt))
- "~/A-Za-z0-9_^$!#%&{}@`'.()-"
+ "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
"~/A-Za-z0-9+@:_.$#%,={}-")
"String of characters valid in a file name.
+Note that all non-ASCII characters are considered valid in a file name
+regardless of what this variable says.
This is a good thing to set in mode hooks.")
(defvar comint-file-name-quote-list nil
- "List of characters to quote with `\\' when in a file name.
+ "List of characters to quote with `\' when in a file name.
This is a good thing to set in mode hooks.")
(defun comint-word (word-chars)
"Return the word of WORD-CHARS at point, or nil if non is found.
Word constituents are considered to be those in WORD-CHARS, which is like the
-inside of a \"[...]\" (see `skip-chars-forward')."
+inside of a \"[...]\" (see `skip-chars-forward'),
+plus all non-ASCII characters."
(save-excursion
(let ((non-word-chars (concat "[^\\\\" word-chars "]")) (here (point)))
(while (and (re-search-backward non-word-chars nil 'move)
- ;(memq (char-after (point)) shell-file-name-quote-list)
- (eq (preceding-char) ?\\))
+ ;;(memq (char-after (point)) shell-file-name-quote-list)
+ (or (>= (following-char) 128)
+ (eq (preceding-char) ?\\)))
(backward-char 1))
;; Don't go forward over a word-char (this can happen if we're at bob).
- (if (or (not (bobp)) (looking-at non-word-chars))
- (forward-char 1))
+ (when (or (not (bobp)) (looking-at non-word-chars))
+ (forward-char 1))
;; Set match-data to match the entire string.
- (if (< (point) here)
- (progn (store-match-data (list (point) here))
- (match-string 0))))))
+ (when (< (point) here)
+ (set-match-data (list (point) here))
+ (match-string 0)))))
(defun comint-substitute-in-file-name (filename)
"Return FILENAME with environment variables substituted.
Returns t if successful."
(interactive)
- (if (comint-match-partial-filename)
- (let ((directory-sep-char (if (memq system-type '(ms-dos windows-nt))
- ?\\
- ?/)))
- (prog2 (or (window-minibuffer-p (selected-window))
- (message "Completing file name..."))
- (comint-dynamic-complete-as-filename)))))
+ (when (comint-match-partial-filename)
+ (unless (window-minibuffer-p (selected-window))
+ (message "Completing file name..."))
+ (comint-dynamic-complete-as-filename)))
(defun comint-dynamic-complete-as-filename ()
"Dynamically complete at point as a filename.
;;(file-name-handler-alist nil)
(minibuffer-p (window-minibuffer-p (selected-window)))
(success t)
- (dirsuffix (cond ((not comint-completion-addsuffix) "")
- ((not (consp comint-completion-addsuffix)) "/")
- (t (car comint-completion-addsuffix))))
- (filesuffix (cond ((not comint-completion-addsuffix) "")
- ((not (consp comint-completion-addsuffix)) " ")
- (t (cdr comint-completion-addsuffix))))
+ (dirsuffix (cond ((not comint-completion-addsuffix)
+ "")
+ ((not (consp comint-completion-addsuffix))
+ (char-to-string directory-sep-char))
+ (t
+ (car comint-completion-addsuffix))))
+ (filesuffix (cond ((not comint-completion-addsuffix)
+ "")
+ ((not (consp comint-completion-addsuffix))
+ " ")
+ (t
+ (cdr comint-completion-addsuffix))))
(filename (or (comint-match-partial-filename) ""))
(pathdir (file-name-directory filename))
(pathnondir (file-name-nondirectory filename))
(setq success nil))
((eq completion t) ; Means already completed "file".
(insert filesuffix)
- (or minibuffer-p (message "Sole completion")))
+ (unless minibuffer-p
+ (message "Sole completion")))
((string-equal completion "") ; Means completion on "directory/".
(comint-dynamic-list-filename-completions))
(t ; Completion string returned.
(cond ((symbolp (file-name-completion completion directory))
;; We inserted a unique completion.
(insert (if (file-directory-p file) dirsuffix filesuffix))
- (or minibuffer-p (message "Completed")))
+ (unless minibuffer-p
+ (message "Completed")))
((and comint-completion-recexact comint-completion-addsuffix
(string-equal pathnondir completion)
(file-exists-p file))
;; It's not unique, but user wants shortest match.
(insert (if (file-directory-p file) dirsuffix filesuffix))
- (or minibuffer-p (message "Completed shortest")))
+ (unless minibuffer-p
+ (message "Completed shortest")))
((or comint-completion-autolist
(string-equal pathnondir completion))
;; It's not unique, list possible completions.
(comint-dynamic-list-filename-completions))
(t
- (or minibuffer-p (message "Partially completed")))))))
+ (unless minibuffer-p
+ (message "Partially completed")))))))
success))