X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/dcdc526cc3fb50399ee82bc9f1f6cd78fb06b7c5..fb597fe85a4c5212f54f97124c83b6af30d5d722:/lisp/comint.el diff --git a/lisp/comint.el b/lisp/comint.el index 3a34330359..370564617c 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -1,9 +1,10 @@ ;;; comint.el --- general command interpreter in a window stuff -;; Copyright (C) 1988, 1990, 1992, 1993, 1994 Free Software Foundation, Inc. +;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98 Free Software Foundation, Inc. -;; Author: Olin Shivers -;; Adapted-by: Simon Marshall +;; Author: Olin Shivers then +;; Simon Marshall +;; Maintainer: FSF ;; Keywords: processes ;; This file is part of GNU Emacs. @@ -19,120 +20,146 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to -;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. +;; 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. ;;; Commentary: -;;; 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) -;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk) - -;;; 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. +;; 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) +;; - Simon Marshall (simon@gnu.ai.mit.edu) + +;; 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. -;;; Brief Command Documentation: -;;;============================================================================ -;;; 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-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 -;;; return comint-send-input -;;; 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-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-h 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). - -;;; comint-mode-hook is the comint mode hook. Basically for your keybindings. +;; Brief Command Documentation: +;;============================================================================ +;; 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-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 +;; return comint-send-input +;; 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 +;; 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). +;; 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. ;;; Code: (require 'ring) -;;; 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-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-send - 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 mode non-buffer local variables: -;;; comint-completion-addsuffix - boolean For file name completion -;;; comint-completion-autolist - boolean behavior -;;; comint-completion-recexact - boolean ... +;; 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-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 +;; 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. @@ -159,7 +186,7 @@ For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;). 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). @@ -168,30 +195,44 @@ 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'. -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. @@ -200,26 +241,51 @@ If `others', scroll only those that are not 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) + +(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'." + :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) -;;; Here are the per-interpreter hooks. +;; 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'." + :type 'regexp + :group 'comint) + +;; Here are the per-interpreter hooks. (defvar comint-get-old-input (function comint-get-old-input-default) "Function that returns old text in comint mode. This function is called when return is typed while the point is in old text. @@ -250,7 +316,12 @@ This variable is buffer-local.") (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.") @@ -261,26 +332,32 @@ 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'.") -(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) (defvar comint-ptyp t "Non-nil if communications via pty; false if by pipe. Buffer local. -This is to work around a bug in Emacs process signalling.") +This is to work around a bug in Emacs process signaling.") (defvar comint-input-ring nil) (defvar comint-last-input-start) @@ -290,18 +367,29 @@ This is to work around a bug in Emacs process signalling.") "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. @@ -329,7 +417,8 @@ Commands with no default key bindings include `send-invisible', 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. @@ -359,16 +448,19 @@ Entry to this mode runs the hooks on `comint-mode-hook'." (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-delimiter-argument-list) - (make-local-variable 'comint-dynamic-complete-functions) + (make-local-hook 'comint-dynamic-complete-functions) (make-local-variable 'comint-completion-fignore) (make-local-variable 'comint-get-old-input) - (make-local-variable 'comint-input-filter-functions) + (make-local-hook 'comint-input-filter-functions) (make-local-variable 'comint-input-filter) (make-local-variable 'comint-input-sender) (make-local-variable 'comint-eol-on-send) @@ -377,10 +469,15 @@ Entry to this mode runs the hooks on `comint-mode-hook'." (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-variable 'comint-output-filter-functions) + (make-local-hook 'comint-output-filter-functions) (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 @@ -389,14 +486,18 @@ Entry to this mode runs the hooks on `comint-mode-hook'." (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) + (define-key comint-mode-map [C-up] 'comint-previous-input) + (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-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) @@ -481,20 +582,24 @@ Entry to this mode runs the hooks on `comint-mode-hook'." (defun comint-check-proc (buffer) "Return t if there is a living process associated w/buffer BUFFER. -Living means the status is `run' or `stop'. +Living means the status is `open', `run', or `stop'. BUFFER can be either a buffer or the name of one." (let ((proc (get-buffer-process buffer))) - (and proc (memq (process-status proc) '(run stop))))) + (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. The name of the buffer is made by surrounding NAME with `*'s. -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. Any more args are arguments to PROGRAM." +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." + (or (fboundp 'start-process) + (error "Multi-processing is not supported for this system")) (let ((buffer (get-buffer-create (concat "*" name "*")))) ;; If no process, or nuked process, crank up a new one and put buffer in ;; comint mode. Otherwise, leave buffer and existing process alone. @@ -527,7 +632,10 @@ buffer. The hook `comint-exec-hook' is run after each exec." (let ((proc (get-buffer-process buffer))) ; Blast any old process. (if proc (delete-process proc))) ;; Crank up a new process - (let ((proc (comint-exec-1 name buffer command switches))) + (let ((proc + (if (consp command) + (open-network-stream name buffer (car command) (cdr command)) + (comint-exec-1 name buffer command switches)))) (set-process-filter proc 'comint-output-filter) (make-local-variable 'comint-ptyp) (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe. @@ -550,49 +658,54 @@ buffer. The hook `comint-exec-hook' is run after each exec." (run-hooks 'comint-exec-hook) buffer))) -;;; This auxiliary function cranks up the process for comint-exec in -;;; the appropriate environment. +;; This auxiliary function cranks up the process for comint-exec in +;; the appropriate environment. (defun comint-exec-1 (name buffer command switches) (let ((process-environment (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 "EMACS=t" "TERM=unknown" + (list "TERM=dumb" "TERMCAP=" (format "COLUMNS=%d" (frame-width))) - (list "EMACS=t" "TERM=emacs" - (format "TERMCAP=emacs:co#%d:tc=unknown" (frame-width)))) - process-environment))) + (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-accessible-directory-p default-directory) + default-directory + (char-to-string directory-sep-char)))) (apply 'start-process name buffer command switches))) -;;; 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. +;; 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. (defun comint-read-input-ring (&optional silent) "Sets the buffer's `comint-input-ring' from a history file. @@ -707,8 +820,7 @@ See also `comint-read-input-ring'." (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))) @@ -809,7 +921,9 @@ If N is negative, find the next or Nth next match." (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) @@ -831,7 +945,8 @@ If N is negative, search forwards for the -Nth following match." ;; 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 @@ -847,7 +962,7 @@ If N is negative, search backwards for the -Nth previous match." (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'. @@ -861,27 +976,34 @@ it cannot expand absolute input line number references. 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 @@ -963,7 +1085,7 @@ See `comint-replace-by-expanded-history'. Returns t if successful." (replace-match new t t) (message "History item: substituted")))) (t - (goto-char (match-end 0)))))))) + (forward-char 1))))))) (defun comint-magic-space (arg) @@ -1038,24 +1160,48 @@ We assume whitespace separates arguments, except within quotes. 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 ((arg "\\(\\(\"[^\"]*\"\\|\'[^\']*\'\\|\`[^\`]*\`\\)\\|\\S \\)+") - (args ()) (pos 0) (str nil)) - ;; We build a list of all the args. Unnecessary, but more efficient, when - ;; ranges of args are required, than picking out one by one and recursing. - (while (string-match arg string pos) - (setq pos (match-end 0) - str (substring string (match-beginning 0) pos) - ;; (match-end 2) is non-nil if we found quotes. - args (if (match-end 2) (cons str args) - (nconc (comint-delim-arg str) args)))) - (let ((n (or nth (1- (length args)))) - (m (if mth (1- (- (length args) mth)) 0))) + ;; 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) + ;; 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)) + (if (and beg (= pos (match-beginning 0))) + ;; It's contiguous, part of the same arg. + (setq pos (match-end 0) + quotes (or quotes (match-beginning 1))) + ;; It's a new separate arg. + (if beg + ;; Put the previous arg, if there was one, onto ARGS. + (setq str (substring string beg pos) + args (if quotes (cons str args) + (nconc (comint-delim-arg str) args)) + count (1+ count))) + (setq quotes (match-beginning 1)) + (setq beg (match-beginning 0)) + (setq pos (match-end 0)))) + (if beg + (setq str (substring string beg pos) + args (if quotes (cons str args) + (nconc (comint-delim-arg str) args)) + count (1+ count))) + (let ((n (or nth (1- count))) + (m (if mth (1- (- count mth)) 0))) (mapconcat (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " ")))) -;;; -;;; Input processing stuff -;;; +;; +;; Input processing stuff +;; (defun comint-send-input () "Send input to process. @@ -1111,21 +1257,22 @@ Similarly for Soar, Scheme, etc." ;; 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)) @@ -1133,18 +1280,28 @@ Similarly for Soar, Scheme, etc." (not (string-equal (ring-ref comint-input-ring 0) history)))) (ring-insert comint-input-ring history)) - (let ((functions comint-input-filter-functions)) - (while functions - (funcall (car functions) (concat input "\n")) - (setq functions (cdr functions)))) + (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 @@ -1152,7 +1309,11 @@ Similarly for Soar, Scheme, etc." (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) @@ -1186,10 +1347,7 @@ Similarly for Soar, Scheme, etc." (narrow-to-region obeg oend) (goto-char opoint) - (let ((functions comint-output-filter-functions)) - (while functions - (funcall (car functions) string) - (setq functions (cdr functions)))) + (run-hook-with-args 'comint-output-filter-functions string) (set-buffer obuf))))) (defun comint-preinput-scroll-to-bottom () @@ -1240,12 +1398,11 @@ This function should be in the list `comint-output-filter-functions'." (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. + (>= (point) comint-last-output-start))) (goto-char (process-mark process))) ;; Optionally scroll so that the text ;; ends at the bottom of the window. @@ -1258,6 +1415,30 @@ This function should be in the list `comint-output-filter-functions'." nil t)) (set-buffer current)))) +(defun comint-truncate-buffer (&optional string) + "Truncate the buffer to `comint-buffer-maximum-size'. +This function could be on `comint-output-filter-functions' or bound to a key." + (interactive) + (save-excursion + (goto-char (process-mark (get-buffer-process (current-buffer)))) + (forward-line (- comint-buffer-maximum-size)) + (beginning-of-line) + (delete-region (point-min) (point)))) + +(defun comint-strip-ctrl-m (&optional string) + "Strip trailing `^M' characters from the current output group. +This function could be on `comint-output-filter-functions' or bound to a key." + (interactive) + (let ((pmark (process-mark (get-buffer-process (current-buffer))))) + (save-excursion + (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) + (defun comint-show-maximum-output () "Put the end of the buffer at the bottom of the window." (interactive) @@ -1311,18 +1492,15 @@ set the hook `comint-input-sender'." If prefix argument is given (\\[universal-argument]) the prompt is not skipped. The prompt skip is done by skipping text matching the regular expression -`comint-prompt-regexp', a buffer local variable. - -If you don't like this command, bind C-a to `beginning-of-line' -in your hook, `comint-mode-hook'." +`comint-prompt-regexp', a buffer local variable." (interactive "P") (beginning-of-line) (if (null arg) (comint-skip-prompt))) -;;; These three functions are for entering text you don't want echoed or -;;; saved -- typically passwords to ftp, telnet, or somesuch. -;;; Just enter m-x send-invisible and type in your line, or add -;;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'. +;; These three functions are for entering text you don't want echoed or +;; saved -- typically passwords to ftp, telnet, or somesuch. +;; Just enter m-x send-invisible and type in your line, or add +;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'. (defun comint-read-noecho (prompt &optional stars) "Read a single line of text from user without echoing, and return it. @@ -1333,36 +1511,44 @@ RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if 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) - (done nil)) + (message-log-max nil) + (done nil)) (while (not done) (if stars - (message "%s%s" prompt (make-string (length ans) ?*)) - (message prompt)) - (setq c (read-char)) + (message "%s%s" prompt (make-string (length ans) ?*)) + (message "%s" prompt)) + ;; Use this instead of `read-char' to avoid "Non-character input-event". + (setq c (read-char-exclusive)) (cond ((= c ?\C-g) - ;; This function may get called from a process filter, where - ;; inhibit-quit is set. In later versions of emacs read-char - ;; may clear quit-flag itself and return C-g. That would make - ;; it impossible to quit this loop in a simple way, so - ;; re-enable it here (for backward-compatibility the check for - ;; quit-flag below would still be necessary, so this seems - ;; like the simplest way to do things). - (setq quit-flag t - done t)) - ((or (= c ?\r) (= c ?\n) (= c ?\e)) - (setq done t)) - ((= c ?\C-u) - (setq ans "")) - ((and (/= c ?\b) (/= c ?\177)) - (setq ans (concat ans (char-to-string c)))) - ((> (length ans) 0) - (setq ans (substring ans 0 -1))))) + ;; This function may get called from a process filter, where + ;; inhibit-quit is set. In later versions of emacs read-char + ;; may clear quit-flag itself and return C-g. That would make + ;; it impossible to quit this loop in a simple way, so + ;; re-enable it here (for backward-compatibility the check for + ;; quit-flag below would still be necessary, so this seems + ;; like the simplest way to do things). + (setq quit-flag t + done 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 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. (prog1 @@ -1374,56 +1560,38 @@ applications." (defun send-invisible (str) "Read a string without echoing. -Then send it to the process running in the current buffer. A new-line -is additionally sent. String is not saved on comint input history list. +Then send it to the process running in the current buffer. +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") - (comint-send-string - proc (if (stringp str) str (comint-read-noecho "Non-echoed text: " t))) - (comint-send-string proc "\n")))) + (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. This function uses `send-invisible' to read and send a password to the buffer's -process if STRING contains a password prompt (matches \"^[Pp]assword:\\\\s *\\\\'\"). +process if STRING contains a password prompt defined by +`comint-password-prompt-regexp'. This function could be in the list `comint-output-filter-functions'." - (if (string-match "^[Pp]assword:\\s *\\'" string) + (if (string-match comint-password-prompt-regexp string) (send-invisible nil))) -;;; Low-level process communication - -(defvar comint-input-chunk-size 512 - "*Long inputs are sent to comint processes in chunks of this size. -If your process is choking on big inputs, try lowering the value.") - -(defun comint-send-string (proc str) - "Send PROCESS the contents of STRING as input. -This is equivalent to `process-send-string', except that long input strings -are broken up into chunks of size `comint-input-chunk-size'. Processes -are given a chance to output between chunks. This can help prevent processes -from hanging when you send them long inputs on some OS's." - (let* ((len (length str)) - (i (min len comint-input-chunk-size))) - (process-send-string proc (substring str 0 i)) - (while (< i len) - (let ((next-i (+ i comint-input-chunk-size))) - (accept-process-output) - (sit-for 0) - (process-send-string proc (substring str i (min len next-i))) - (setq i next-i))))) - -(defun comint-send-region (proc start end) - "Sends to PROC the region delimited by START and END. -This is a replacement for `process-send-region' that tries to keep -your process from hanging on long inputs. See `comint-send-string'." - (comint-send-string proc (buffer-substring start end))) +;; Low-level process communication + +(defalias 'comint-send-string 'process-send-string) +(defalias 'comint-send-region 'process-send-region) -;;; Random input hackage +;; Random input hackage (defun comint-kill-output () "Kill all output from interpreter since last input. @@ -1436,7 +1604,7 @@ Does not delete the prompt." (beginning-of-line nil) (point-marker)))) (delete-region comint-last-input-end pmark) - (comint-skip-prompt) + (goto-char (process-mark proc)) (setq replacement (concat "*** output flushed ***\n" (buffer-substring pmark (point)))) (delete-region pmark (point)))) @@ -1455,27 +1623,40 @@ Sets mark to the value of point when this command is run." (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 () @@ -1492,11 +1673,13 @@ Useful if you accidentally suspend the top-level process." (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." @@ -1544,67 +1727,67 @@ See `comint-prompt-regexp'." (interactive "p") (comint-next-prompt (- n))) -;;; Support for source-file processing commands. -;;;============================================================================ -;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have -;;; commands that process files of source text (e.g. loading or compiling -;;; files). So the corresponding process-in-a-buffer modes have commands -;;; for doing this (e.g., lisp-load-file). The functions below are useful -;;; for defining these commands. -;;; -;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme -;;; and Soar, in that they don't know anything about file extensions. -;;; So the compile/load interface gets the wrong default occasionally. -;;; The load-file/compile-file default mechanism could be smarter -- it -;;; doesn't know about the relationship between filename extensions and -;;; whether the file is source or executable. If you compile foo.lisp -;;; with compile-file, then the next load-file should use foo.bin for -;;; the default, not foo.lisp. This is tricky to do right, particularly -;;; because the extension for executable files varies so much (.o, .bin, -;;; .lbin, .mo, .vo, .ao, ...). - - -;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing -;;; commands. -;;; -;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you -;;; want to save the buffer before issuing any process requests to the command -;;; interpreter. -;;; -;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt -;;; for the file to process. - -;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes) -;;;============================================================================ -;;; This function computes the defaults for the load-file and compile-file -;;; commands for tea, soar, cmulisp, and cmuscheme modes. -;;; -;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last -;;; source-file processing command. NIL if there hasn't been one yet. -;;; - SOURCE-MODES is a list used to determine what buffers contain source -;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source. -;;; Typically, (lisp-mode) or (scheme-mode). -;;; -;;; If the command is given while the cursor is inside a string, *and* -;;; the string is an existing filename, *and* the filename is not a directory, -;;; then the string is taken as default. This allows you to just position -;;; your cursor over a string that's a filename and have it taken as default. -;;; -;;; If the command is given in a file buffer whose major mode is in -;;; SOURCE-MODES, then the the filename is the default file, and the -;;; file's directory is the default directory. -;;; -;;; If the buffer isn't a source file buffer (e.g., it's the process buffer), -;;; then the default directory & file are what was used in the last source-file -;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time -;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory -;;; is the cwd, with no default file. (\"no default file\" = nil) -;;; -;;; SOURCE-REGEXP is typically going to be something like (tea-mode) -;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode) -;;; for Soar programs, etc. -;;; -;;; The function returns a pair: (default-directory . default-file). +;; Support for source-file processing commands. +;;============================================================================ +;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have +;; commands that process files of source text (e.g. loading or compiling +;; files). So the corresponding process-in-a-buffer modes have commands +;; for doing this (e.g., lisp-load-file). The functions below are useful +;; for defining these commands. +;; +;; Alas, these guys don't do exactly the right thing for Lisp, Scheme +;; and Soar, in that they don't know anything about file extensions. +;; So the compile/load interface gets the wrong default occasionally. +;; The load-file/compile-file default mechanism could be smarter -- it +;; doesn't know about the relationship between filename extensions and +;; whether the file is source or executable. If you compile foo.lisp +;; with compile-file, then the next load-file should use foo.bin for +;; the default, not foo.lisp. This is tricky to do right, particularly +;; because the extension for executable files varies so much (.o, .bin, +;; .lbin, .mo, .vo, .ao, ...). + + +;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing +;; commands. +;; +;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you +;; want to save the buffer before issuing any process requests to the command +;; interpreter. +;; +;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt +;; for the file to process. + +;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes) +;;============================================================================ +;; This function computes the defaults for the load-file and compile-file +;; commands for tea, soar, cmulisp, and cmuscheme modes. +;; +;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last +;; source-file processing command. NIL if there hasn't been one yet. +;; - SOURCE-MODES is a list used to determine what buffers contain source +;; files: if the major mode of the buffer is in SOURCE-MODES, it's source. +;; Typically, (lisp-mode) or (scheme-mode). +;; +;; If the command is given while the cursor is inside a string, *and* +;; the string is an existing filename, *and* the filename is not a directory, +;; then the string is taken as default. This allows you to just position +;; your cursor over a string that's a filename and have it taken as default. +;; +;; If the command is given in a file buffer whose major mode is in +;; SOURCE-MODES, then the the filename is the default file, and the +;; file's directory is the default directory. +;; +;; If the buffer isn't a source file buffer (e.g., it's the process buffer), +;; then the default directory & file are what was used in the last source-file +;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time +;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory +;; is the cwd, with no default file. (\"no default file\" = nil) +;; +;; SOURCE-REGEXP is typically going to be something like (tea-mode) +;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode) +;; for Soar programs, etc. +;; +;; The function returns a pair: (default-directory . default-file). (defun comint-source-default (previous-dir/file source-modes) (cond ((and buffer-file-name (memq major-mode source-modes)) @@ -1615,13 +1798,13 @@ See `comint-prompt-regexp'." (cons default-directory nil)))) -;;; (COMINT-CHECK-SOURCE fname) -;;;============================================================================ -;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU -;;; process-in-a-buffer modes), this function can be called on the filename. -;;; If the file is loaded into a buffer, and the buffer is modified, the user -;;; is queried to see if he wants to save the buffer before proceeding with -;;; the load or compile. +;; (COMINT-CHECK-SOURCE fname) +;;============================================================================ +;; Prior to loading or compiling (or otherwise processing) a file (in the CMU +;; process-in-a-buffer modes), this function can be called on the filename. +;; If the file is loaded into a buffer, and the buffer is modified, the user +;; is queried to see if he wants to save the buffer before proceeding with +;; the load or compile. (defun comint-check-source (fname) (let ((buff (get-file-buffer fname))) @@ -1635,27 +1818,27 @@ See `comint-prompt-regexp'." (set-buffer old-buffer))))) -;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p) -;;;============================================================================ -;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter -;;; commands that process source files (like loading or compiling a file). -;;; It prompts for the filename, provides a default, if there is one, -;;; and returns the result filename. -;;; -;;; See COMINT-SOURCE-DEFAULT for more on determining defaults. -;;; -;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair -;;; from the last source processing command. SOURCE-MODES is a list of major -;;; modes used to determine what file buffers contain source files. (These -;;; two arguments are used for determining defaults). If MUSTMATCH-P is true, -;;; then the filename reader will only accept a file that exists. -;;; -;;; A typical use: -;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file -;;; '(lisp-mode) t)) - -;;; This is pretty stupid about strings. It decides we're in a string -;;; if there's a quote on both sides of point on the current line. +;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p) +;;============================================================================ +;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter +;; commands that process source files (like loading or compiling a file). +;; It prompts for the filename, provides a default, if there is one, +;; and returns the result filename. +;; +;; See COMINT-SOURCE-DEFAULT for more on determining defaults. +;; +;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair +;; from the last source processing command. SOURCE-MODES is a list of major +;; modes used to determine what file buffers contain source files. (These +;; two arguments are used for determining defaults). If MUSTMATCH-P is true, +;; then the filename reader will only accept a file that exists. +;; +;; A typical use: +;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file +;; '(lisp-mode) t)) + +;; This is pretty stupid about strings. It decides we're in a string +;; if there's a quote on both sides of point on the current line. (defun comint-extract-string () "Return string around POINT that starts the current line, or nil." (save-excursion @@ -1691,30 +1874,30 @@ See `comint-prompt-regexp'." mustmatch-p))) (list (expand-file-name (substitute-in-file-name ans))))) -;;; I am somewhat divided on this string-default feature. It seems -;;; to violate the principle-of-least-astonishment, in that it makes -;;; the default harder to predict, so you actually have to look and see -;;; what the default really is before choosing it. This can trip you up. -;;; On the other hand, it can be useful, I guess. I would appreciate feedback -;;; on this. -;;; -Olin +;; I am somewhat divided on this string-default feature. It seems +;; to violate the principle-of-least-astonishment, in that it makes +;; the default harder to predict, so you actually have to look and see +;; what the default really is before choosing it. This can trip you up. +;; On the other hand, it can be useful, I guess. I would appreciate feedback +;; on this. +;; -Olin -;;; Simple process query facility. -;;; =========================================================================== -;;; This function is for commands that want to send a query to the process -;;; and show the response to the user. For example, a command to get the -;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query -;;; to an inferior Common Lisp process. -;;; -;;; This simple facility just sends strings to the inferior process and pops -;;; up a window for the process buffer so you can see what the process -;;; responds with. We don't do anything fancy like try to intercept what the -;;; process responds with and put it in a pop-up window or on the message -;;; line. We just display the buffer. Low tech. Simple. Works good. - -;;; Send to the inferior process PROC the string STR. Pop-up but do not select -;;; a window for the inferior process so that its response can be seen. +;; Simple process query facility. +;; =========================================================================== +;; This function is for commands that want to send a query to the process +;; and show the response to the user. For example, a command to get the +;; arglist for a Common Lisp function might send a "(arglist 'foo)" query +;; to an inferior Common Lisp process. +;; +;; This simple facility just sends strings to the inferior process and pops +;; up a window for the process buffer so you can see what the process +;; responds with. We don't do anything fancy like try to intercept what the +;; process responds with and put it in a pop-up window or on the message +;; line. We just display the buffer. Low tech. Simple. Works good. + +;; Send to the inferior process PROC the string STR. Pop-up but do not select +;; a window for the inferior process so that its response can be seen. (defun comint-proc-query (proc str) (let* ((proc-buf (process-buffer proc)) (proc-mark (process-mark proc))) @@ -1727,62 +1910,87 @@ See `comint-prompt-regexp'." ;; 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))))))) -;;; Filename/command/history completion in a buffer -;;; =========================================================================== -;;; Useful completion functions, courtesy of the Ergo group. - -;;; Six commands: -;;; comint-dynamic-complete Complete or expand command, filename, -;;; history at point. -;;; comint-dynamic-complete-filename Complete filename 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-dynamic-simple-complete Complete stub given candidates. - -;;; These are not installed in the comint-mode keymap. But they are -;;; available for people who want them. Shell-mode installs them: -;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete) -;;; (define-key shell-mode-map "\M-?" -;;; 'comint-dynamic-list-filename-completions))) -;;; -;;; Commands like this are fine things to put in load hooks if you -;;; want them present in specific modes. - -(defvar comint-completion-autolist nil - "*If non-nil, automatically list possiblities on partial completion. -This mirrors the optional behavior of tcsh.") - -(defvar comint-completion-addsuffix t +;; Filename/command/history completion in a buffer +;; =========================================================================== +;; Useful completion functions, courtesy of the Ergo group. + +;; Six commands: +;; comint-dynamic-complete Complete or expand command, filename, +;; history at point. +;; comint-dynamic-complete-filename Complete filename 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-dynamic-simple-complete Complete stub given candidates. + +;; These are not installed in the comint-mode keymap. But they are +;; available for people who want them. Shell-mode installs them: +;; (define-key shell-mode-map "\t" 'comint-dynamic-complete) +;; (define-key shell-mode-map "\M-?" +;; 'comint-dynamic-list-filename-completions))) +;; +;; Commands like this are fine things to put in load hooks if you +;; want them present in specific modes. + +(defcustom comint-completion-autolist nil + "*If non-nil, automatically list possibilities on partial completion. +This mirrors the optional behavior of tcsh." + :type 'boolean + :group 'comint-completion) + +(defcustom comint-completion-addsuffix t "*If non-nil, add a `/' to completed directories, ` ' to file names. -This mirrors the optional behavior of tcsh.") +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." + :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. + +This is a good thing to set in mode hooks.") + (defun comint-directory (directory) ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute. @@ -1794,25 +2002,72 @@ directory tracking functions.") (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 ((limit (point)) - (word (concat "[" word-chars "]")) - (non-word (concat "[^" word-chars "]"))) - (if (re-search-backward non-word nil 'move) - (forward-char 1)) - ;; Anchor the search forwards. - (if (or (eolp) (looking-at non-word)) - nil - (re-search-forward (concat word "+") limit) - (buffer-substring (match-beginning 0) (match-end 0)))))) - + (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) + (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). + (when (or (not (bobp)) (looking-at non-word-chars)) + (forward-char 1)) + ;; Set match-data to match the entire string. + (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 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) + "Return FILENAME with magic characters quoted. +Magic characters are those in `comint-file-name-quote-list'." + (if (null comint-file-name-quote-list) + filename + (let ((regexp + (format "\\(^\\|[^\\]\\)\\([%s]\\)" + (mapconcat 'char-to-string comint-file-name-quote-list "")))) + (save-match-data + (while (string-match regexp filename) + (setq filename (replace-match "\\1\\\\\\2" nil nil filename))) + filename)))) + +(defun comint-unquote-filename (filename) + "Return FILENAME with quoted characters unquoted." + (if (null comint-file-name-quote-list) + filename + (save-match-data + (let ((i 0)) + (while (string-match "\\\\\\(.\\)" filename i) + (setq filename (replace-match "\\1" nil nil filename)) + (setq i (+ 1 (match-beginning 0))))) + filename))) (defun comint-dynamic-complete () @@ -1821,9 +2076,7 @@ Calls the functions in `comint-dynamic-complete-functions' to perform completion until a function returns non-nil, at which point completion is assumed to have occurred." (interactive) - (let ((functions comint-dynamic-complete-functions)) - (while (and functions (null (funcall (car functions)))) - (setq functions (cdr functions))))) + (run-hook-with-args-until-success 'comint-dynamic-complete-functions)) (defun comint-dynamic-complete-filename () @@ -1841,53 +2094,72 @@ completions listing is dependent on the value of `comint-completion-autolist'. Returns t if successful." (interactive) - (if (comint-match-partial-filename) - (prog2 (or (eq (selected-window) (minibuffer-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) + ;; 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)) + (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)) (directory (if pathdir (comint-directory pathdir) default-directory)) - (completion (file-name-completion pathnondir directory)) - (mini-flag (eq (selected-window) (minibuffer-window)))) + (completion (file-name-completion pathnondir directory))) (cond ((null completion) (message "No completions of %s" filename) (setq success nil)) ((eq completion t) ; Means already completed "file". - (if comint-completion-addsuffix (insert " ")) - (or mini-flag (message "Sole completion"))) + (insert filesuffix) + (unless minibuffer-p + (message "Sole completion"))) ((string-equal completion "") ; Means completion on "directory/". (comint-dynamic-list-filename-completions)) (t ; Completion string returned. (let ((file (concat (file-name-as-directory directory) completion))) - (insert (substring (directory-file-name completion) - (length pathnondir))) + (insert (comint-quote-filename + (substring (directory-file-name completion) + (length pathnondir)))) (cond ((symbolp (file-name-completion completion directory)) ;; We inserted a unique completion. - (if comint-completion-addsuffix - (insert (if (file-directory-p file) "/" " "))) - (or mini-flag (message "Completed"))) + (insert (if (file-directory-p file) dirsuffix filesuffix)) + (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) "/" " ")) - (or mini-flag (message "Completed shortest"))) + (insert (if (file-directory-p file) dirsuffix filesuffix)) + (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 mini-flag (message "Partially completed"))))))) + (unless minibuffer-p + (message "Partially completed"))))))) success)) @@ -1917,7 +2189,10 @@ Returns `partial' if completed as far as possible with the completion matches. 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)))) (candidates (mapcar (function (lambda (x) (list x))) candidates)) (completions (all-completions stub candidates))) (cond ((null completions) @@ -1929,7 +2204,7 @@ See also `comint-dynamic-complete-filename'." (message "Sole completion") (insert (substring completion (length stub))) (message "Completed")) - (if comint-completion-addsuffix (insert " ")) + (insert suffix) 'sole)) (t ; There's no unique completion. (let ((completion (try-completion stub candidates))) @@ -1939,7 +2214,7 @@ See also `comint-dynamic-complete-filename'." (string-equal stub completion) (member completion completions)) ;; It's not unique, but user wants shortest match. - (insert " ") + (insert suffix) (message "Completed shortest") 'shortest) ((or comint-completion-autolist @@ -1955,15 +2230,20 @@ See also `comint-dynamic-complete-filename'." (defun comint-dynamic-list-filename-completions () "List in help buffer possible completions of the filename at point." (interactive) - (let* ((completion-ignore-case 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)) (directory (if pathdir (comint-directory pathdir) default-directory)) (completions (file-name-all-completions pathnondir directory))) - (if completions - (comint-dynamic-list-completions completions) - (message "No completions of %s" filename)))) + (if (not completions) + (message "No completions of %s" filename) + (comint-dynamic-list-completions + (mapcar 'comint-quote-filename completions))))) (defun comint-dynamic-list-completions (completions) @@ -1978,7 +2258,7 @@ Typing SPC flushes the help buffer." (set-buffer (get-buffer "*Completions*")) (setq key (read-key-sequence nil) first (aref key 0)) - (and (consp first) + (and (consp first) (consp (event-start first)) (eq (window-buffer (posn-window (event-start first))) (get-buffer "*Completions*")) (eq (key-binding key) 'mouse-choose-completion))) @@ -1989,97 +2269,151 @@ Typing SPC flushes the help buffer." (set-window-configuration conf)) (if (eq first ?\ ) (set-window-configuration conf) - (setq unread-command-events (append key nil))))))) + (setq unread-command-events (listify-key-sequence key))))))) + +(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-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"))) + -;;; Converting process modes to use comint mode -;;; =========================================================================== -;;; The code in the Emacs 19 distribution has all been modified to use comint -;;; where needed. However, there are `third-party' packages out there that -;;; still use the old shell mode. Here's a guide to conversion. -;;; -;;; Renaming variables -;;; Most of the work is renaming variables and functions. These are the common -;;; ones: -;;; Local variables: -;;; last-input-start comint-last-input-start -;;; last-input-end comint-last-input-end -;;; shell-prompt-pattern comint-prompt-regexp -;;; shell-set-directory-error-hook -;;; Miscellaneous: -;;; shell-set-directory -;;; shell-mode-map comint-mode-map -;;; Commands: -;;; shell-send-input comint-send-input -;;; shell-send-eof comint-delchar-or-maybe-eof -;;; kill-shell-input comint-kill-input -;;; interrupt-shell-subjob comint-interrupt-subjob -;;; stop-shell-subjob comint-stop-subjob -;;; quit-shell-subjob comint-quit-subjob -;;; kill-shell-subjob comint-kill-subjob -;;; kill-output-from-shell comint-kill-output -;;; show-output-from-shell comint-show-output -;;; copy-last-shell-input Use comint-previous-input/comint-next-input -;;; -;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by -;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions. -;;; Comint mode does not provide functionality equivalent to -;;; shell-set-directory-error-hook; it is gone. -;;; -;;; comint-last-input-start is provided for modes which want to munge -;;; the buffer after input is sent, perhaps because the inferior -;;; insists on echoing the input. The LAST-INPUT-START variable in -;;; the old shell package was used to implement a history mechanism, -;;; but you should think twice before using comint-last-input-start -;;; for this; the input history ring often does the job better. -;;; -;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do -;;; *not* create the comint-mode local variables in your foo-mode function. -;;; This is not modular. Instead, call comint-mode, and let *it* create the -;;; necessary comint-specific local variables. Then create the -;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to -;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks -;;; (comint-{prompt-regexp, input-filter, input-filter-functions, -;;; get-old-input) that need to be different from the defaults. Call -;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself; -;;; comint-mode will take care of it. The following example, from shell.el, -;;; is typical: -;;; -;;; (defvar shell-mode-map '()) -;;; (cond ((not shell-mode-map) -;;; (setq shell-mode-map (copy-keymap comint-mode-map)) -;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command) -;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command) -;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete) -;;; (define-key shell-mode-map "\M-?" -;;; 'comint-dynamic-list-filename-completions))) -;;; -;;; (defun shell-mode () -;;; (interactive) -;;; (comint-mode) -;;; (setq comint-prompt-regexp shell-prompt-pattern) -;;; (setq major-mode 'shell-mode) -;;; (setq mode-name "Shell") -;;; (use-local-map shell-mode-map) -;;; (make-local-variable 'shell-directory-stack) -;;; (setq shell-directory-stack nil) -;;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker) -;;; (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 -;;; hook to add completion functions to. Functions on this list should return -;;; non-nil if completion occurs (i.e., further completion should not occur). -;;; You could use comint-dynamic-simple-complete to do the bulk of the -;;; completion job. +;; Converting process modes to use comint mode +;; =========================================================================== +;; The code in the Emacs 19 distribution has all been modified to use comint +;; where needed. However, there are `third-party' packages out there that +;; still use the old shell mode. Here's a guide to conversion. +;; +;; Renaming variables +;; Most of the work is renaming variables and functions. These are the common +;; ones: +;; Local variables: +;; last-input-start comint-last-input-start +;; last-input-end comint-last-input-end +;; shell-prompt-pattern comint-prompt-regexp +;; shell-set-directory-error-hook +;; Miscellaneous: +;; shell-set-directory +;; shell-mode-map comint-mode-map +;; Commands: +;; shell-send-input comint-send-input +;; shell-send-eof comint-delchar-or-maybe-eof +;; kill-shell-input comint-kill-input +;; interrupt-shell-subjob comint-interrupt-subjob +;; stop-shell-subjob comint-stop-subjob +;; quit-shell-subjob comint-quit-subjob +;; kill-shell-subjob comint-kill-subjob +;; kill-output-from-shell comint-kill-output +;; show-output-from-shell comint-show-output +;; copy-last-shell-input Use comint-previous-input/comint-next-input +;; +;; SHELL-SET-DIRECTORY is gone, its functionality taken over by +;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions. +;; Comint mode does not provide functionality equivalent to +;; shell-set-directory-error-hook; it is gone. +;; +;; comint-last-input-start is provided for modes which want to munge +;; the buffer after input is sent, perhaps because the inferior +;; insists on echoing the input. The LAST-INPUT-START variable in +;; the old shell package was used to implement a history mechanism, +;; but you should think twice before using comint-last-input-start +;; for this; the input history ring often does the job better. +;; +;; If you are implementing some process-in-a-buffer mode, called foo-mode, do +;; *not* create the comint-mode local variables in your foo-mode function. +;; This is not modular. Instead, call comint-mode, and let *it* create the +;; necessary comint-specific local variables. Then create the +;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to +;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks +;; (comint-{prompt-regexp, input-filter, input-filter-functions, +;; get-old-input) that need to be different from the defaults. Call +;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself; +;; comint-mode will take care of it. The following example, from shell.el, +;; is typical: +;; +;; (defvar shell-mode-map '()) +;; (cond ((not shell-mode-map) +;; (setq shell-mode-map (copy-keymap comint-mode-map)) +;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command) +;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command) +;; (define-key shell-mode-map "\t" 'comint-dynamic-complete) +;; (define-key shell-mode-map "\M-?" +;; 'comint-dynamic-list-filename-completions))) +;; +;; (defun shell-mode () +;; (interactive) +;; (comint-mode) +;; (setq comint-prompt-regexp shell-prompt-pattern) +;; (setq major-mode 'shell-mode) +;; (setq mode-name "Shell") +;; (use-local-map shell-mode-map) +;; (make-local-variable 'shell-directory-stack) +;; (setq shell-directory-stack nil) +;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker) +;; (run-hooks 'shell-mode-hook)) +;; +;; +;; Completion for comint-mode users +;; +;; For modes that use comint-mode, comint-dynamic-complete-functions is the +;; hook to add completion functions to. Functions on this list should return +;; non-nil if completion occurs (i.e., further completion should not occur). +;; You could use comint-dynamic-simple-complete to do the bulk of the +;; completion job. (provide 'comint) -;;; comint.el ends here +;; comint.el ends here