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