;;; comint.el --- general command interpreter in a window stuff
-;; Copyright (C) 1988, 90, 92, 93, 94, 95 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 Mode Commands: (common to all derived modes, like shell & cmulisp
;; mode)
;;
-;; m-p comint-previous-input Cycle backwards in input history
-;; m-n comint-next-input Cycle forwards
+;; m-p comint-previous-input Cycle backwards in input history
+;; m-n comint-next-input Cycle forwards
;; m-r comint-previous-matching-input Previous input matching a regexp
;; m-s comint-next-matching-input Next input that matches
-;; m-c-l comint-show-output Show last batch of process output
+;; m-c-l comint-show-output Show last batch of process output
;; return comint-send-input
-;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
-;; c-c c-a comint-bol Beginning of line; skip prompt
+;; 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.
;; c-c c-u comint-kill-input ^u
;; c-c c-w backward-kill-word ^w
;; c-c c-c comint-interrupt-subjob ^c
;; comint-continue-subjob Send CONT signal to buffer's process
;; group. Useful if you accidentally
;; suspend your process (with C-c C-z).
+;; 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.
;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
;; Buffer Local Variables:
;;============================================================================
;; Comint mode buffer local variables:
-;; 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 ...
-;; comint-input-autoexpand - symbol ...
-;; comint-input-ignoredups - boolean ...
-;; comint-last-input-match - string ...
-;; comint-dynamic-complete-functions - hook For the completion mechanism
-;; comint-completion-fignore - list ...
-;; 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.
-;; 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...
+;; 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 ...
+;; comint-save-input-ring-index number ...
+;; comint-input-autoexpand symbol ...
+;; comint-input-ignoredups boolean ...
+;; comint-last-input-match string ...
+;; comint-dynamic-complete-functions hook For the completion mechanism
+;; comint-completion-fignore list ...
+;; comint-file-name-chars string ...
+;; 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.
+;; comint-preoutput-filter-functions hook
+;; 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 ...
+;; comint-accum-marker maker For comint-accumulate
;;
;; Comint mode non-buffer local variables:
-;; comint-completion-addsuffix - boolean/cons For file name completion
-;; comint-completion-autolist - boolean behavior
-;; comint-completion-recexact - boolean ...
+;; comint-completion-addsuffix boolean/cons For file name
+;; 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.
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 input)
+ (const history)
+ (other :tag "on" t))
+ :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
- "\\(\\([Oo]ld \\|[Nn]ew \\|^\\)[Pp]assword\\|pass phrase\\):\\s *\\'"
+;; 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)
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
"Functions to call after output is inserted into the buffer.
One possible function is `comint-postoutput-scroll-to-bottom'.
-These functions get one argument, a string containing the text just inserted.
+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.
+
+See also `comint-preoutput-filter-functions'.
This variable is buffer-local.")
`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)
"Index of last matched history element.")
(defvar comint-matching-input-from-input-string ""
"Input previously used to match input history.")
+(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.")
(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
(put 'comint-input-ring 'permanent-local t)
(put 'comint-input-ring-index 'permanent-local t)
+(put 'comint-save-input-ring-index 'permanent-local t)
(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.
(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)
+ (make-local-variable 'comint-save-input-ring-index)
(or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
(setq comint-input-ring-index nil))
+ (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
+ (setq comint-save-input-ring-index nil))
(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-scroll-to-bottom-on-input)
(make-local-variable 'comint-scroll-to-bottom-on-output)
(make-local-variable 'comint-scroll-show-maximum-output)
- (make-local-variable 'pre-command-hook)
- (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
+ (make-local-hook 'pre-command-hook)
+ (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
(make-local-hook 'comint-output-filter-functions)
+ (make-local-hook 'comint-exec-hook)
(make-local-variable 'comint-ptyp)
- (make-local-variable 'comint-exec-hook)
(make-local-variable 'comint-process-echoes)
+ (make-local-variable 'comint-file-name-chars)
(make-local-variable 'comint-file-name-quote-list)
+ (make-local-variable 'comint-accum-marker)
+ (setq comint-accum-marker (make-marker))
+ (set-marker comint-accum-marker nil)
(run-hooks 'comint-mode-hook))
(if comint-mode-map
(define-key comint-mode-map [C-down] 'comint-next-input)
(define-key comint-mode-map "\er" 'comint-previous-matching-input)
(define-key comint-mode-map "\es" 'comint-next-matching-input)
- (define-key comint-mode-map [?\A-\M-r] 'comint-previous-matching-input-from-input)
- (define-key comint-mode-map [?\A-\M-s] 'comint-next-matching-input-from-input)
+ (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)
(define-key comint-mode-map "\e\C-l" 'comint-show-output)
(define-key comint-mode-map "\C-m" 'comint-send-input)
(define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
- (define-key comint-mode-map "\C-c\C-a" 'comint-bol)
+ (define-key comint-mode-map "\C-c " 'comint-accumulate)
+ (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
+ (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
(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)
(let ((proc (get-buffer-process buffer)))
(and proc (memq (process-status proc) '(open run stop)))))
-;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
-;; for the second argument (program).
;;;###autoload
(defun make-comint (name program &optional startfile &rest switches)
"Make a comint process NAME in a buffer, running PROGRAM.
(nconc
;; If using termcap, we specify `emacs' as the terminal type
;; because that lets us specify a width.
- ;; If using terminfo, we specify `unknown' because that is
+ ;; If using terminfo, we specify `dumb' because that is
;; 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.
(if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
- (list "TERM=unknown"
+ (list "TERM=dumb" "TERMCAP="
(format "COLUMNS=%d" (frame-width)))
(list "TERM=emacs"
(format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
(if (getenv "EMACS") nil (list "EMACS=t"))
process-environment))
(default-directory
- (if (file-directory-p default-directory)
+ (if (file-accessible-directory-p default-directory)
default-directory
- "/")))
- (apply 'start-process name buffer command switches)))
+ (char-to-string directory-sep-char)))
+ proc decoding encoding changed)
+ (setq proc (apply 'start-process name buffer command switches))
+ (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
+ ;; data sent form the process and the coding system doesn't
+ ;; 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))
\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)))
(message "History item: %d" (1+ pos))
(delete-region
;; Can't use kill-region as it sets this-command
- (process-mark (get-buffer-process (current-buffer))) (point))
+ (or (marker-position comint-accum-marker)
+ (process-mark (get-buffer-process (current-buffer))))
+ (point))
(insert (ring-ref comint-input-ring pos)))))
(defun comint-next-matching-input (regexp arg)
;; Starting a new search
(setq comint-matching-input-from-input-string
(buffer-substring
- (process-mark (get-buffer-process (current-buffer)))
+ (or (marker-position comint-accum-marker)
+ (process-mark (get-buffer-process (current-buffer))))
(point))
comint-input-ring-index nil))
(comint-previous-matching-input
(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."
(interactive)
(if (and comint-input-autoexpand
- (string-match "[!^]" (funcall comint-get-old-input))
+ (string-match "!\\|^\\^" (funcall comint-get-old-input))
(save-excursion (beginning-of-line)
(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\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
- (args ()) (pos 0)
- (count 0)
- beg str value quotes)
+ ;; The first line handles ordinary characters and backslash-sequences
+ ;; (except with w32 msdos-like shells, where backslashes are valid).
+ ;; 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* ((first (if (and (eq system-type 'windows-nt)
+ (w32-shell-dos-semantics))
+ "[^ \n\t\"'`]+\\|"
+ "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\]+\\|"))
+ (argpart (concat first
+ "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
+'[^']*'\\|\
+`[^`]*`\\)"))
+ (args ()) (pos 0)
+ (count 0)
+ beg str value quotes)
;; Build a list of all the args until we have as many as we want.
(while (and (or (null mth) (<= count mth))
(string-match argpart string pos))
;; 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))
+ (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))
- (insert ?\n))
+ (insert-before-markers ?\n))
(if (and (funcall comint-input-filter history)
(or (null comint-input-ignoredups)
(not (ring-p comint-input-ring))
(ring-insert comint-input-ring history))
(run-hook-with-args 'comint-input-filter-functions
(concat input "\n"))
+ (setq comint-save-input-ring-index comint-input-ring-index)
(setq comint-input-ring-index nil)
;; Update the markers before we send the input
;; in case we get output amidst sending the input.
(set-marker comint-last-input-start pmark)
(set-marker comint-last-input-end (point))
(set-marker (process-mark proc) (point))
+ ;; clear the "accumulation" marker
+ (set-marker comint-accum-marker nil)
(funcall comint-input-sender proc input)
- (comint-output-filter proc "")))))
+ ;; This used to call comint-output-filter-functions,
+ ;; 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
(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)
(select-window window)
(if (and (< (point) (process-mark process))
(or (eq scroll t) (eq scroll 'all)
- ;; Maybe user wants point to jump to the end.
+ ;; Maybe user wants point to jump to end.
(and (eq scroll 'this) (eq selected window))
(and (eq scroll 'others) (not (eq selected window)))
- ;; If point was at the end, keep it at the end.
- (>= (point)
- (- (process-mark process) (length string)))))
+ ;; If point was at the end, keep it at end.
+ (and (marker-position comint-last-output-start)
+ (>= (point) comint-last-output-start))))
(goto-char (process-mark process)))
;; Optionally scroll so that the text
;; ends at the bottom of the window.
This function could be on `comint-output-filter-functions' or bound to a key."
(interactive)
(save-excursion
- (goto-char (point-max))
+ (goto-char (process-mark (get-buffer-process (current-buffer))))
(forward-line (- comint-buffer-maximum-size))
(beginning-of-line)
(delete-region (point-min) (point))))
(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)
filter and C-g is pressed, this function returns nil rather than a string).
Note that the keystrokes comprising the text can still be recovered
-\(temporarily) with \\[view-lossage]. This may be a security bug for some
-applications."
+\(temporarily) with \\[view-lossage]. Some people find this worrysome.
+Once the caller uses the password, it can erase the password
+by doing (fillarray STRING 0)."
(let ((ans "")
+ (newans nil)
(c 0)
(echo-keystrokes 0)
(cursor-in-echo-area t)
((or (= c ?\r) (= c ?\n) (= c ?\e))
(setq done t))
((= c ?\C-u)
+ (fillarray ans 0)
(setq ans ""))
((and (/= c ?\b) (/= c ?\177))
- (setq ans (concat ans (char-to-string c))))
+ (setq newans (concat ans (char-to-string c)))
+ (fillarray ans 0)
+ (setq ans newans))
((> (length ans) 0)
+ (aset ans (1- (length ans)) 0)
(setq ans (substring ans 0 -1)))))
(if quit-flag
;; Emulate a true quit, except that we have to return a value.
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
+ (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.
This is used by comint's and shell's completion functions, and by shell's
directory tracking functions.")
+(defvar comint-file-name-chars
+ (if (memq system-type '(ms-dos windows-nt))
+ "~/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.
+Supports additional environment variable syntax of the command
+interpreter (e.g., the percent notation of cmd.exe on NT)."
+ (let ((name (substitute-in-file-name filename)))
+ (if (memq system-type '(ms-dos windows-nt))
+ (let (env-var-name
+ env-var-val)
+ (save-match-data
+ (while (string-match "%\\([^\\\\/]*\\)%" name)
+ (setq env-var-name
+ (substring name (match-beginning 1) (match-end 1)))
+ (setq env-var-val (if (getenv env-var-name)
+ (getenv env-var-name)
+ ""))
+ (setq name (replace-match env-var-val nil nil name))))))
+ name))
(defun comint-match-partial-filename ()
"Return the filename at point, or nil if non is found.
Environment variables are substituted. See `comint-word'."
- (let ((filename (comint-word "~/A-Za-z0-9+@:_.$#%,={}-")))
- (and filename (substitute-in-file-name (comint-unquote-filename filename)))))
+ (let ((filename (comint-word comint-file-name-chars)))
+ (and filename (comint-substitute-in-file-name
+ (comint-unquote-filename filename)))))
(defun comint-quote-filename (filename)
(if (null comint-file-name-quote-list)
filename
(save-match-data
- (while (string-match "\\\\\\(.\\)" filename)
- (setq filename (replace-match "\\1" nil nil filename)))
+ (let ((i 0))
+ (while (string-match "\\\\\\(.\\)" filename i)
+ (setq filename (replace-match "\\1" nil nil filename))
+ (setq i (+ 1 (match-beginning 0)))))
filename)))
Returns t if successful."
(interactive)
- (if (comint-match-partial-filename)
- (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.
See `comint-dynamic-complete-filename'. Returns t if successful."
- (let* ((completion-ignore-case nil)
+ (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
(completion-ignored-extensions comint-completion-fignore)
- (file-name-handler-alist nil)
+ ;; If we bind this, it breaks remote directory tracking in rlogin.el.
+ ;; I think it was originally bound to solve file completion problems,
+ ;; but subsequent changes may have made this unnecessary. sm.
+ ;;(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))
Returns `listed' if a completion listing was shown.
See also `comint-dynamic-complete-filename'."
- (let* ((completion-ignore-case nil)
+ (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
(suffix (cond ((not comint-completion-addsuffix) "")
((not (consp comint-completion-addsuffix)) " ")
(t (cdr comint-completion-addsuffix))))
(defun comint-dynamic-list-filename-completions ()
"List in help buffer possible completions of the filename at point."
(interactive)
- (let* ((completion-ignore-case nil)
- (file-name-handler-alist nil)
+ (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
+ ;; If we bind this, it breaks remote directory tracking in rlogin.el.
+ ;; I think it was originally bound to solve file completion problems,
+ ;; but subsequent changes may have made this unnecessary. sm.
+ ;;(file-name-handler-alist nil)
(filename (or (comint-match-partial-filename) ""))
(pathdir (file-name-directory filename))
(pathnondir (file-name-nondirectory filename))
(set-window-configuration conf)
(setq unread-command-events (listify-key-sequence key)))))))
\f
+(defun comint-get-next-from-history ()
+ "After fetching a line from input history, this fetches the following line.
+In other words, this recalls the input line after the line you recalled last.
+You can use this to repeat a sequence of input lines."
+ (interactive)
+ (if comint-save-input-ring-index
+ (progn
+ (setq comint-input-ring-index (1+ comint-save-input-ring-index))
+ (comint-next-input 1))
+ (message "No previous history command")))
+
+(defun comint-accumulate ()
+ "Accumulate a line to send as input along with more lines.
+This inserts a newline so that you can enter more text
+to be sent along with this line. Use \\[comint-send-input]
+to send all the accumulated input, at once.
+The entire accumulated text becomes one item in the input history
+when you send it."
+ (interactive)
+ (insert "\n")
+ (set-marker comint-accum-marker (point))
+ (if comint-input-ring-index
+ (setq comint-save-input-ring-index
+ (- comint-input-ring-index 1))))
+
+(defun comint-goto-process-mark ()
+ "Move point to the process mark.
+The process mark separates output, and input already sent,
+from input that has not yet been sent."
+ (interactive)
+ (let ((proc (or (get-buffer-process (current-buffer))
+ (error "Current buffer has no process"))))
+ (goto-char (process-mark proc))
+ (message "Point is now at the process mark")))
+
+(defun comint-bol-or-process-mark ()
+ "Move point beginning of line (after prompt) or to the process mark.
+The first time you use this command, it moves to the beginning of the line
+\(but after the prompt, if any). If you repeat it again immediately,
+it moves point to the process mark.
+
+The process mark separates the process output, along with input already sent,
+from input that has not yet been sent. Ordinarily, the process mark
+is at the beginning of the current input line; but if you have
+used \\[comint-accumulate] to send multiple lines at once,
+the process mark is at the beginning of the accumulated input."
+ (interactive)
+ (if (not (eq last-command 'comint-bol-or-process-mark))
+ (comint-bol nil)
+ (comint-goto-process-mark)))
+
+(defun comint-set-process-mark ()
+ "Set the process mark at point."
+ (interactive)
+ (let ((proc (or (get-buffer-process (current-buffer))
+ (error "Current buffer has no process"))))
+ (set-marker (process-mark proc) (point))
+ (message "Process mark set")))
+
+\f
;; Converting process modes to use comint mode
;; ===========================================================================
;; The code in the Emacs 19 distribution has all been modified to use comint
;; (run-hooks 'shell-mode-hook))
;;
;;
-;; Note that make-comint is different from make-shell in that it
-;; doesn't have a default program argument. If you give make-shell
-;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
-;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
-;; of NIL, it barfs. Adjust your code accordingly...
-;;
;; Completion for comint-mode users
;;
;; For modes that use comint-mode, comint-dynamic-complete-functions is the