(pop-up-frame-function): Remove choice nil since it
[emacs.git] / lisp / term.el
blob68a8e2095586c6f2783199bc08de7bfdab09c006
1 ;;; term.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1994, 1995, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Per Bothner <per@bothner.com>
7 ;; Maintainer: Dan Nicolaescu <dann@ics.uci.edu>, Per Bothner <per@bothner.com>
8 ;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Marck 13 2001
27 ;;; Fixes for CJK support by Yong Lu <lyongu@yahoo.com>.
29 ;;; Dir/Hostname tracking and ANSI colorization by
30 ;;; Marco Melgazzi <marco@techie.com>.
32 ;;; To see what I've modified and where it came from search for '-mm'
34 ;;; Commentary:
36 ;;; Speed considerations and a few caveats
37 ;;; --------------------------------------
38 ;;;
39 ;;; While the message passing and the colorization surely introduce some
40 ;;; overhead this has became so small that IMHO is surely outweighted by
41 ;;; the benefits you get but, as usual, YMMV
42 ;;;
43 ;;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
44 ;;; make a choice: on my Linux box this choice allows me to run all the
45 ;;; ncurses applications without problems but make these keys
46 ;;; uncomprehensible to all the cursesX programs. Your mileage may vary so
47 ;;; you may consider changing the default 'emulation'. Just search for this
48 ;;; piece of code and modify it as you like:
49 ;;;
50 ;;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
51 ;;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
52 ;;; ;; For example: vi works with \eOA while elm wants \e[A ...
53 ;;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
54 ;;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
55 ;;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
56 ;;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
57 ;;;
58 ;;;
59 ;;; IMPORTANT: additions & changes
60 ;;; ------------------------------
61 ;;;
62 ;;; With this enhanced ansi-term.el you will get a reliable mechanism of
63 ;;; directory/username/host tracking: the only drawback is that you will
64 ;;; have to modify your shell start-up script. It's worth it, believe me :).
65 ;;;
66 ;;; When you rlogin/su/telnet and the account you access has a modified
67 ;;; startup script, you will be able to access the remote files as usual
68 ;;; with C-x C-f, if it's needed you will have to enter a password,
69 ;;; otherwise the file should get loaded straight away.
70 ;;;
71 ;;; This is useful even if you work only on one host: it often happens that,
72 ;;; for maintenance reasons, you have to edit files 'as root': before
73 ;;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
74 ;;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
75 ;;; 'as-root'. ( If you don't want to enter the root password every time you
76 ;;; can put it in your .netrc: note that this is -not- advisable if you're
77 ;;; connected to the internet or if somebody else works on your workstation!)
78 ;;;
79 ;;; If you use wu-ftpd you can use some of its features to avoid root ftp
80 ;;; access to the rest of the world: just put in /etc/ftphosts something like
81 ;;;
82 ;;; # Local access
83 ;;; allow root 127.0.0.1
84 ;;;
85 ;;; # By default nobody can't do anything
86 ;;; deny root *
87 ;;;
88 ;;;
89 ;;; ----------------------------------------
90 ;;;
91 ;;; If, instead of 'term', you call 'ansi-term', you get multiple term
92 ;;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
93 ;;; where <xx> is, as usual, a number...
94 ;;;
95 ;;; ----------------------------------------
96 ;;;
97 ;;; With the term-buffer-maximum-size you can finally decide how many
98 ;;; scrollback lines to keep: its default is 2048 but you can change it as
99 ;;; usual.
101 ;;; ----------------------------------------
104 ;;; ANSI colorization should work well, I've decided to limit the interpreter
105 ;;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
106 ;;; You shouldn't need more, if you do, tell me and I'll increase it. It's
107 ;;; so easy you could do it yourself...
109 ;;; Blink, is not supported. Currently it's mapped as bold.
111 ;;; Important caveat:
112 ;;; -----------------
113 ;;; if you want custom colors in term.el redefine term-default-fg-color
114 ;;; and term-default-bg-color BEFORE loading it.
116 ;;; ----------------------------------------
118 ;;; If you'd like to check out my complete configuration, you can download
119 ;;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
120 ;;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
121 ;;; that this term.el may be newer/older than the one in there, please
122 ;;; check!)
124 ;;; This complete configuration contains, among other things, a complete
125 ;;; rectangular marking solution (based on rect-mark.el and
126 ;;; pc-bindings.el) and should be a good example of how extensively Emacs
127 ;;; can be configured on a ppp-connected ws.
129 ;;; ----------------------------------------
131 ;;; TODO:
133 ;;; - Add hooks to allow raw-mode keys to be configurable
134 ;;; - Which keys are better ? \eOA or \e[A ?
137 ;;; Changes:
139 ;;; V4.0 January 1997
141 ;;; - Huge reworking of the faces code: now we only have roughly 20-30
142 ;;; faces for everything so we're even faster than the old md-term.el !
143 ;;; - Finished removing all the J-Shell code.
145 ;;; V3.0 January 1997
147 ;;; - Now all the supportable ANSI commands work well.
148 ;;; - Reworked a little the code: much less jsh-inspired stuff
150 ;;; V2.3 November
152 ;;; - Now all the faces are accessed through an array: much cleaner code.
154 ;;; V2.2 November 4 1996
156 ;;; - Implemented ANSI output colorization ( a bit rough but enough for
157 ;;; color_ls )
159 ;;; - Implemented a maximum limit for the scroll buffer (stolen from
160 ;;; comint.el)
162 ;;; v2.1 October 28 1996, first public release
164 ;;; - Some new keybindings for term-char mode ( notably home/end/...)
165 ;;; - Directory, hostname and username tracking via ange-ftp
166 ;;; - Multi-term capability via the ansi-term call
168 ;;; ----------------------------------------------------------------
169 ;;; You should/could have something like this in your .emacs to take
170 ;;; full advantage of this package
172 ;;; (add-hook 'term-mode-hook
173 ;;; (function
174 ;;; (lambda ()
175 ;;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
176 ;;; (make-local-variable 'mouse-yank-at-point)
177 ;;; (make-local-variable 'transient-mark-mode)
178 ;;; (setq mouse-yank-at-point t)
179 ;;; (setq transient-mark-mode nil)
180 ;;; (auto-fill-mode -1)
181 ;;; (setq tab-width 8 ))))
184 ;;; ----------------------------------------
186 ;;; If you want to use color ls the best setup is to have a different file
187 ;;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
188 ;;; is necessary because some terminals, rxvt for example, need non-ansi
189 ;;; hacks to work ( for example on my rxvt white is wired to fg, and to
190 ;;; obtain normal white I have to do bold-white :)
192 ;;; ----------------------------------------
195 ;;; # Configuration file for the color ls utility
196 ;;; # This file goes in the /etc directory, and must be world readable.
197 ;;; # You can copy this file to .dir_colors in your $HOME directory to
198 ;;; # override the system defaults.
200 ;;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
201 ;;; # not pipes. 'all' adds color characters to all output. 'none' shuts
202 ;;; # colorization off.
203 ;;; COLOR tty
204 ;;; OPTIONS -F
206 ;;; # Below, there should be one TERM entry for each termtype that is
207 ;;; # colorizable
208 ;;; TERM eterm
210 ;;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
211 ;;; EIGHTBIT 1
213 ;;; # Below are the color init strings for the basic file types. A color init
214 ;;; # string consists of one or more of the following numeric codes:
215 ;;; # Attribute codes:
216 ;;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
217 ;;; # Text color codes:
218 ;;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
219 ;;; # Background color codes:
220 ;;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
221 ;;; NORMAL 00 # global default, although everything should be something.
222 ;;; FILE 00 # normal file
223 ;;; DIR 00;37 # directory
224 ;;; LINK 00;36 # symbolic link
225 ;;; FIFO 00;37 # pipe
226 ;;; SOCK 40;35 # socket
227 ;;; BLK 33;01 # block device driver
228 ;;; CHR 33;01 # character device driver
230 ;;; # This is for files with execute permission:
231 ;;; EXEC 00;32
233 ;;; # List any file extensions like '.gz' or '.tar' that you would like ls
234 ;;; # to colorize below. Put the extension, a space, and the color init
235 ;;; # string. (and any comments you want to add after a '#')
236 ;;; .tar 01;33 # archives or compressed
237 ;;; .tgz 01;33
238 ;;; .arj 01;33
239 ;;; .taz 01;33
240 ;;; .lzh 01;33
241 ;;; .zip 01;33
242 ;;; .z 01;33
243 ;;; .Z 01;33
244 ;;; .gz 01;33
245 ;;; .jpg 01;35 # image formats
246 ;;; .gif 01;35
247 ;;; .bmp 01;35
248 ;;; .xbm 01;35
249 ;;; .xpm 01;35
252 ;;; ----------------------------------------
254 ;;; Notice: for directory/host/user tracking you need to have something
255 ;;; like this in your shell startup script ( this is for tcsh but should
256 ;;; be quite easy to port to other shells )
258 ;;; ----------------------------------------
261 ;;; set os = `uname`
262 ;;; set host = `hostname`
263 ;;; set date = `date`
265 ;;; # su does not change this but I'd like it to
267 ;;; set user = `whoami`
269 ;;; # ...
271 ;;; if ( eterm =~ $TERM ) then
273 ;;; echo --------------------------------------------------------------
274 ;;; echo Hello $user
275 ;;; echo Today is $date
276 ;;; echo We are on $host running $os under Emacs term mode
277 ;;; echo --------------------------------------------------------------
279 ;;; setenv EDITOR emacsclient
281 ;;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
282 ;;; # this is necessary because, f.e., certain versions of 'su' do not change
283 ;;; # $user, YMMV: if you don't want to fiddle with them define a couple
284 ;;; # of new variables and use these instead.
285 ;;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
287 ;;; # These are because we want the real cwd in the messages, not the login
288 ;;; # time one !
290 ;;; set cwd_hack='$cwd'
291 ;;; set host_hack='$host'
292 ;;; set user_hack='$user'
294 ;;; # Notice that the ^[ character is an ESC, not two chars. You can
295 ;;; # get it in various ways, for example by typing
296 ;;; # echo -e '\033' > escape.file
297 ;;; # or by using your favourite editor
299 ;;; foreach temp (cd pushd)
300 ;;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
301 ;;; end
302 ;;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
304 ;;; # Every command that can modify the user/host/directory should be aliased
305 ;;; # as follows for the tracking mechanism to work.
307 ;;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
308 ;;; alias $temp "$temp \!* ; echo '\eAnSiTh' $host_hack ; \
309 ;;; echo '\eAnSiTu' $user_hack ;echo '\eAnSiTc' $cwd_hack"
310 ;;; end
312 ;;; # Start up & use color ls
314 ;;; echo "\eAnSiTh" $host
315 ;;; echo "\eAnSiTu" $user
316 ;;; echo "\eAnSiTc" $cwd
318 ;;; # some housekeeping
320 ;;; unset cwd_hack
321 ;;; unset host_hack
322 ;;; unset user_hack
323 ;;; unset temp
325 ;;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
326 ;;; endif
328 ;;; # ...
330 ;;; # Let's not clutter user space
332 ;;; unset os
333 ;;; unset date
337 ;;; Original Commentary:
338 ;;; --------------------
340 ;; The changelog is at the end of this file.
342 ;; Please send me bug reports, bug fixes, and extensions, so that I can
343 ;; merge them into the master source.
344 ;; - Per Bothner (bothner@cygnus.com)
346 ;; This file defines a general command-interpreter-in-a-buffer package
347 ;; (term mode). The idea is that you can build specific process-in-a-buffer
348 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
349 ;; This way, all these specific packages share a common base functionality,
350 ;; and a common set of bindings, which makes them easier to use (and
351 ;; saves code, implementation time, etc., etc.).
353 ;; For hints on converting existing process modes (e.g., tex-mode,
354 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
355 ;; instead of shell-mode, see the notes at the end of this file.
358 ;; Brief Command Documentation:
359 ;;============================================================================
360 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
361 ;; mode)
363 ;; m-p term-previous-input Cycle backwards in input history
364 ;; m-n term-next-input Cycle forwards
365 ;; m-r term-previous-matching-input Previous input matching a regexp
366 ;; m-s comint-next-matching-input Next input that matches
367 ;; return term-send-input
368 ;; c-c c-a term-bol Beginning of line; skip prompt.
369 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
370 ;; c-c c-u term-kill-input ^u
371 ;; c-c c-w backward-kill-word ^w
372 ;; c-c c-c term-interrupt-subjob ^c
373 ;; c-c c-z term-stop-subjob ^z
374 ;; c-c c-\ term-quit-subjob ^\
375 ;; c-c c-o term-kill-output Delete last batch of process output
376 ;; c-c c-r term-show-output Show last batch of process output
377 ;; c-c c-h term-dynamic-list-input-ring List input history
379 ;; Not bound by default in term-mode
380 ;; term-send-invisible Read a line w/o echo, and send to proc
381 ;; (These are bound in shell-mode)
382 ;; term-dynamic-complete Complete filename at point.
383 ;; term-dynamic-list-completions List completions in help buffer.
384 ;; term-replace-by-expanded-filename Expand and complete filename at point;
385 ;; replace with expanded/completed name.
386 ;; term-kill-subjob No mercy.
387 ;; term-show-maximum-output Show as much output as possible.
388 ;; term-continue-subjob Send CONT signal to buffer's process
389 ;; group. Useful if you accidentally
390 ;; suspend your process (with C-c C-z).
392 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
393 ;; term-load-hook is run after loading in this package.
395 ;;; Code:
397 ;; This is passed to the inferior in the EMACS environment variable,
398 ;; so it is important to increase it if there are protocol-relevant changes.
399 (defconst term-protocol-version "0.96")
401 (eval-when-compile
402 (require 'ange-ftp))
403 (require 'ring)
404 (require 'ehelp)
406 (defgroup term nil
407 "General command interpreter in a window."
408 :group 'processes)
411 ;;; Buffer Local Variables:
412 ;;;============================================================================
413 ;;; Term mode buffer local variables:
414 ;;; term-prompt-regexp - string term-bol uses to match prompt.
415 ;;; term-delimiter-argument-list - list For delimiters and arguments
416 ;;; term-last-input-start - marker Handy if inferior always echoes
417 ;;; term-last-input-end - marker For term-kill-output command
418 ;; For the input history mechanism:
419 (defvar term-input-ring-size 32 "Size of input history ring.")
420 ;;; term-input-ring-size - integer
421 ;;; term-input-ring - ring
422 ;;; term-input-ring-index - number ...
423 ;;; term-input-autoexpand - symbol ...
424 ;;; term-input-ignoredups - boolean ...
425 ;;; term-last-input-match - string ...
426 ;;; term-dynamic-complete-functions - hook For the completion mechanism
427 ;;; term-completion-fignore - list ...
428 ;;; term-get-old-input - function Hooks for specific
429 ;;; term-input-filter-functions - hook process-in-a-buffer
430 ;;; term-input-filter - function modes.
431 ;;; term-input-send - function
432 ;;; term-scroll-to-bottom-on-output - symbol ...
433 ;;; term-scroll-show-maximum-output - boolean...
434 (defvar term-height) ;; Number of lines in window.
435 (defvar term-width) ;; Number of columns in window.
436 (defvar term-home-marker) ;; Marks the "home" position for cursor addressing.
437 (defvar term-saved-home-marker nil) ;; When using alternate sub-buffer,
438 ;; contains saved term-home-marker from original sub-buffer .
439 (defvar term-start-line-column 0) ;; (current-column) at start of screen line,
440 ;; or nil if unknown.
441 (defvar term-current-column 0) ;; If non-nil, is cache for (current-column).
442 (defvar term-current-row 0) ;; Current vertical row (relative to home-marker)
443 ;; or nil if unknown.
444 (defvar term-insert-mode nil)
445 (defvar term-vertical-motion)
446 (defvar term-terminal-state 0) ;; State of the terminal emulator:
447 ;; state 0: Normal state
448 ;; state 1: Last character was a graphic in the last column.
449 ;; If next char is graphic, first move one column right
450 ;; (and line warp) before displaying it.
451 ;; This emulates (more or less) the behavior of xterm.
452 ;; state 2: seen ESC
453 ;; state 3: seen ESC [ (or ESC [ ?)
454 ;; state 4: term-terminal-parameter contains pending output.
455 (defvar term-kill-echo-list nil) ;; A queue of strings whose echo
456 ;; we want suppressed.
457 (defvar term-terminal-parameter)
458 (defvar term-terminal-previous-parameter)
459 (defvar term-current-face 'default)
460 (defvar term-scroll-start 0) ;; Top-most line (inclusive) of scrolling region.
461 (defvar term-scroll-end) ;; Number of line (zero-based) after scrolling region.
462 (defvar term-pager-count nil) ;; If nil, paging is disabled.
463 ;; Otherwise, number of lines before we need to page.
464 (defvar term-saved-cursor nil)
465 (defvar term-command-hook)
466 (defvar term-log-buffer nil)
467 (defvar term-scroll-with-delete nil) ;; term-scroll-with-delete is t if
468 ;; forward scrolling should be implemented by delete to
469 ;; top-most line(s); and nil if scrolling should be implemented
470 ;; by moving term-home-marker. It is set to t if there is a
471 ;; (non-default) scroll-region OR the alternate buffer is used.
472 (defvar term-pending-delete-marker) ;; New user input in line mode needs to
473 ;; be deleted, because it gets echoed by the inferior.
474 ;; To reduce flicker, we defer the delete until the next output.
475 (defvar term-old-mode-map nil) ;; Saves the old keymap when in char mode.
476 (defvar term-old-mode-line-format) ;; Saves old mode-line-format while paging.
477 (defvar term-pager-old-local-map nil) ;; Saves old keymap while paging.
478 (defvar term-pager-old-filter) ;; Saved process-filter while paging.
480 (defcustom explicit-shell-file-name nil
481 "If non-nil, is file name to use for explicitly requested inferior shell."
482 :type '(choice (const nil) file)
483 :group 'term)
485 (defvar term-prompt-regexp "^"
486 "Regexp to recognize prompts in the inferior process.
487 Defaults to \"^\", the null string at BOL.
489 Good choices:
490 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
491 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
492 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
493 kcl: \"^>+ *\"
494 shell: \"^[^#$%>\\n]*[#$%>] *\"
495 T: \"^>+ *\"
497 This is a good thing to set in mode hooks.")
499 (defvar term-delimiter-argument-list ()
500 "List of characters to recognize as separate arguments in input.
501 Strings comprising a character in this list will separate the arguments
502 surrounding them, and also be regarded as arguments in their own right (unlike
503 whitespace). See `term-arguments'.
504 Defaults to the empty list.
506 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
508 This is a good thing to set in mode hooks.")
510 (defcustom term-input-autoexpand nil
511 "If non-nil, expand input command history references on completion.
512 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
514 If the value is `input', then the expansion is seen on input.
515 If the value is `history', then the expansion is only when inserting
516 into the buffer's input ring. See also `term-magic-space' and
517 `term-dynamic-complete'.
519 This variable is buffer-local."
520 :type '(choice (const nil) (const t) (const input) (const history))
521 :group 'term)
523 (defcustom term-input-ignoredups nil
524 "If non-nil, don't add input matching the last on the input ring.
525 This mirrors the optional behavior of bash.
527 This variable is buffer-local."
528 :type 'boolean
529 :group 'term)
531 (defcustom term-input-ring-file-name nil
532 "If non-nil, name of the file to read/write input history.
533 See also `term-read-input-ring' and `term-write-input-ring'.
535 This variable is buffer-local, and is a good thing to set in mode hooks."
536 :type 'boolean
537 :group 'term)
539 (defcustom term-scroll-to-bottom-on-output nil
540 "Controls whether interpreter output causes window to scroll.
541 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
542 If `this', scroll only the selected window.
543 If `others', scroll only those that are not the selected window.
545 The default is nil.
547 See variable `term-scroll-show-maximum-output'.
548 This variable is buffer-local."
549 :type 'boolean
550 :group 'term)
552 (defcustom term-scroll-show-maximum-output nil
553 "Controls how interpreter output causes window to scroll.
554 If non-nil, then show the maximum output when the window is scrolled.
556 See variable `term-scroll-to-bottom-on-output'.
557 This variable is buffer-local."
558 :type 'boolean
559 :group 'term)
561 ;; Where gud-display-frame should put the debugging arrow. This is
562 ;; set by the marker-filter, which scans the debugger's output for
563 ;; indications of the current pc.
564 (defvar term-pending-frame nil)
566 ;;; Here are the per-interpreter hooks.
567 (defvar term-get-old-input (function term-get-old-input-default)
568 "Function that submits old text in term mode.
569 This function is called when return is typed while the point is in old text.
570 It returns the text to be submitted as process input. The default is
571 `term-get-old-input-default', which grabs the current line, and strips off
572 leading text matching `term-prompt-regexp'.")
574 (defvar term-dynamic-complete-functions
575 '(term-replace-by-expanded-history term-dynamic-complete-filename)
576 "List of functions called to perform completion.
577 Functions should return non-nil if completion was performed.
578 See also `term-dynamic-complete'.
580 This is a good thing to set in mode hooks.")
582 (defvar term-input-filter
583 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
584 "Predicate for filtering additions to input history.
585 Only inputs answering true to this function are saved on the input
586 history list. Default is to save anything that isn't all whitespace.")
588 (defvar term-input-filter-functions '()
589 "Functions to call before input is sent to the process.
590 These functions get one argument, a string containing the text to send.
592 This variable is buffer-local.")
594 (defvar term-input-sender (function term-simple-send)
595 "Function to actually send to PROCESS the STRING submitted by user.
596 Usually this is just `term-simple-send', but if your mode needs to
597 massage the input string, this is your hook. This is called from
598 the user command `term-send-input'. `term-simple-send' just sends
599 the string plus a newline.")
601 (defcustom term-eol-on-send t
602 "Non-nil means go to the end of the line before sending input.
603 See `term-send-input'."
604 :type 'boolean
605 :group 'term)
607 (defcustom term-mode-hook '()
608 "Called upon entry into term mode.
609 This is run before the process is cranked up."
610 :type 'hook
611 :group 'term)
613 (defcustom term-exec-hook '()
614 "Called each time a process is exec'd by `term-exec'.
615 This is called after the process is cranked up. It is useful for things that
616 must be done each time a process is executed in a term mode buffer (e.g.,
617 `process-kill-without-query'). In contrast, `term-mode-hook' is only
618 executed once when the buffer is created."
619 :type 'hook
620 :group 'term)
622 (defvar term-mode-map
623 (let ((map (make-sparse-keymap)))
624 (define-key map "\ep" 'term-previous-input)
625 (define-key map "\en" 'term-next-input)
626 (define-key map "\er" 'term-previous-matching-input)
627 (define-key map "\es" 'term-next-matching-input)
628 (unless (featurep 'xemacs)
629 (define-key map [?\A-\M-r]
630 'term-previous-matching-input-from-input)
631 (define-key map [?\A-\M-s] 'term-next-matching-input-from-input))
632 (define-key map "\e\C-l" 'term-show-output)
633 (define-key map "\C-m" 'term-send-input)
634 (define-key map "\C-d" 'term-delchar-or-maybe-eof)
635 (define-key map "\C-c\C-a" 'term-bol)
636 (define-key map "\C-c\C-u" 'term-kill-input)
637 (define-key map "\C-c\C-w" 'backward-kill-word)
638 (define-key map "\C-c\C-c" 'term-interrupt-subjob)
639 (define-key map "\C-c\C-z" 'term-stop-subjob)
640 (define-key map "\C-c\C-\\" 'term-quit-subjob)
641 (define-key map "\C-c\C-m" 'term-copy-old-input)
642 (define-key map "\C-c\C-o" 'term-kill-output)
643 (define-key map "\C-c\C-r" 'term-show-output)
644 (define-key map "\C-c\C-e" 'term-show-maximum-output)
645 (define-key map "\C-c\C-l" 'term-dynamic-list-input-ring)
646 (define-key map "\C-c\C-n" 'term-next-prompt)
647 (define-key map "\C-c\C-p" 'term-previous-prompt)
648 (define-key map "\C-c\C-d" 'term-send-eof)
649 (define-key map "\C-c\C-k" 'term-char-mode)
650 (define-key map "\C-c\C-j" 'term-line-mode)
651 (define-key map "\C-c\C-q" 'term-pager-toggle)
653 ;; ;; completion:
654 ;; (define-key map [menu-bar completion]
655 ;; (cons "Complete" (make-sparse-keymap "Complete")))
656 ;; (define-key map [menu-bar completion complete-expand]
657 ;; '("Expand File Name" . term-replace-by-expanded-filename))
658 ;; (define-key map [menu-bar completion complete-listing]
659 ;; '("File Completion Listing" . term-dynamic-list-filename-completions))
660 ;; (define-key map [menu-bar completion complete-file]
661 ;; '("Complete File Name" . term-dynamic-complete-filename))
662 ;; (define-key map [menu-bar completion complete]
663 ;; '("Complete Before Point" . term-dynamic-complete))
664 ;; ;; Put them in the menu bar:
665 ;; (setq menu-bar-final-items (append '(terminal completion inout signals)
666 ;; menu-bar-final-items))
667 map))
669 (defvar term-raw-map nil
670 "Keyboard map for sending characters directly to the inferior process.")
671 (defvar term-escape-char nil
672 "Escape character for char sub-mode of term mode.
673 Do not change it directly; use `term-set-escape-char' instead.")
674 (defvar term-raw-escape-map nil)
676 (defvar term-pager-break-map nil)
678 (defvar term-ptyp t
679 "True if communications via pty; false if by pipe. Buffer local.
680 This is to work around a bug in Emacs process signaling.")
682 (defvar term-last-input-match ""
683 "Last string searched for by term input history search, for defaulting.
684 Buffer local variable.")
686 (defvar term-input-ring nil)
687 (defvar term-last-input-start)
688 (defvar term-last-input-end)
689 (defvar term-input-ring-index nil
690 "Index of last matched history element.")
691 (defvar term-matching-input-from-input-string ""
692 "Input previously used to match input history.")
693 ; This argument to set-process-filter disables reading from the process,
694 ; assuming this is Emacs 19.20 or newer.
695 (defvar term-pager-filter t)
697 (put 'term-replace-by-expanded-history 'menu-enable 'term-input-autoexpand)
698 (put 'term-input-ring 'permanent-local t)
699 (put 'term-input-ring-index 'permanent-local t)
700 (put 'term-input-autoexpand 'permanent-local t)
701 (put 'term-input-filter-functions 'permanent-local t)
702 (put 'term-scroll-to-bottom-on-output 'permanent-local t)
703 (put 'term-scroll-show-maximum-output 'permanent-local t)
704 (put 'term-ptyp 'permanent-local t)
706 (defmacro term-in-char-mode () '(eq (current-local-map) term-raw-map))
707 (defmacro term-in-line-mode () '(not (term-in-char-mode)))
708 ;; True if currently doing PAGER handling.
709 (defmacro term-pager-enabled () 'term-pager-count)
710 (defmacro term-handling-pager () 'term-pager-old-local-map)
711 (defmacro term-using-alternate-sub-buffer () 'term-saved-home-marker)
713 (defvar term-signals-menu)
714 (defvar term-terminal-menu)
716 ;;; Let's silence the byte-compiler -mm
717 (defvar term-ansi-at-host nil)
718 (defvar term-ansi-at-dir nil)
719 (defvar term-ansi-at-user nil)
720 (defvar term-ansi-at-message nil)
721 (defvar term-ansi-at-save-user nil)
722 (defvar term-ansi-at-save-pwd nil)
723 (defvar term-ansi-at-save-anon nil)
724 (defvar term-ansi-current-bold nil)
725 (defvar term-ansi-current-color 0)
726 (defvar term-ansi-face-already-done nil)
727 (defvar term-ansi-current-bg-color 0)
728 (defvar term-ansi-current-underline nil)
729 (defvar term-ansi-current-reverse nil)
730 (defvar term-ansi-current-invisible nil)
732 ;;; Four should be enough, if you want more, just add. -mm
733 (defvar term-terminal-more-parameters 0)
734 (defvar term-terminal-previous-parameter-2 -1)
735 (defvar term-terminal-previous-parameter-3 -1)
736 (defvar term-terminal-previous-parameter-4 -1)
739 ;;; faces -mm
741 (defcustom term-default-fg-color (face-foreground term-current-face)
742 "Default color for foreground in `term'."
743 :group 'term
744 :type 'string)
746 (defcustom term-default-bg-color (face-background term-current-face)
747 "Default color for background in `term'."
748 :group 'term
749 :type 'string)
751 ;;; Use the same colors that xterm uses, see `xterm-standard-colors'.
752 (defvar ansi-term-color-vector
753 [unspecified "black" "red3" "green3" "yellow3" "blue2"
754 "magenta3" "cyan3" "white"])
756 ;;; Inspiration came from comint.el -mm
757 (defvar term-buffer-maximum-size 2048
758 "*The maximum size in lines for term buffers.
759 Term buffers are truncated from the top to be no greater than this number.
760 Notice that a setting of 0 means \"don't truncate anything\". This variable
761 is buffer-local.")
764 (when (featurep 'xemacs)
765 (defvar term-terminal-menu
766 '("Terminal"
767 [ "Character mode" term-char-mode (term-in-line-mode)]
768 [ "Line mode" term-line-mode (term-in-char-mode)]
769 [ "Enable paging" term-pager-toggle (not term-pager-count)]
770 [ "Disable paging" term-pager-toggle term-pager-count])))
772 ;; Menu bars:
773 (unless (featurep 'xemacs)
774 ;; terminal:
775 (let (newmap)
776 (setq newmap (make-sparse-keymap "Terminal"))
777 (define-key newmap [terminal-pager-enable]
778 '(menu-item "Enable paging" term-fake-pager-enable
779 :help "Enable paging feature"))
780 (define-key newmap [terminal-pager-disable]
781 '(menu-item "Disable paging" term-fake-pager-disable
782 :help "Disable paging feature"))
783 (define-key newmap [terminal-char-mode]
784 '(menu-item "Character mode" term-char-mode
785 :help "Switch to char (raw) sub-mode of term mode"))
786 (define-key newmap [terminal-line-mode]
787 '(menu-item "Line mode" term-line-mode
788 :help "Switch to line (cooked) sub-mode of term mode"))
789 (setq term-terminal-menu (cons "Terminal" newmap))
791 ;; completion: (line mode only)
792 (defvar term-completion-menu (make-sparse-keymap "Complete"))
793 (define-key term-mode-map [menu-bar completion]
794 (cons "Complete" term-completion-menu))
795 (define-key term-completion-menu [complete-expand]
796 '("Expand File Name" . term-replace-by-expanded-filename))
797 (define-key term-completion-menu [complete-listing]
798 '("File Completion Listing" . term-dynamic-list-filename-completions))
799 (define-key term-completion-menu [menu-bar completion complete-file]
800 '("Complete File Name" . term-dynamic-complete-filename))
801 (define-key term-completion-menu [menu-bar completion complete]
802 '("Complete Before Point" . term-dynamic-complete))
804 ;; Input history: (line mode only)
805 (defvar term-inout-menu (make-sparse-keymap "In/Out"))
806 (define-key term-mode-map [menu-bar inout]
807 (cons "In/Out" term-inout-menu))
808 (define-key term-inout-menu [kill-output]
809 '("Kill Current Output Group" . term-kill-output))
810 (define-key term-inout-menu [next-prompt]
811 '("Forward Output Group" . term-next-prompt))
812 (define-key term-inout-menu [previous-prompt]
813 '("Backward Output Group" . term-previous-prompt))
814 (define-key term-inout-menu [show-maximum-output]
815 '("Show Maximum Output" . term-show-maximum-output))
816 (define-key term-inout-menu [show-output]
817 '("Show Current Output Group" . term-show-output))
818 (define-key term-inout-menu [kill-input]
819 '("Kill Current Input" . term-kill-input))
820 (define-key term-inout-menu [copy-input]
821 '("Copy Old Input" . term-copy-old-input))
822 (define-key term-inout-menu [forward-matching-history]
823 '("Forward Matching Input..." . term-forward-matching-input))
824 (define-key term-inout-menu [backward-matching-history]
825 '("Backward Matching Input..." . term-backward-matching-input))
826 (define-key term-inout-menu [next-matching-history]
827 '("Next Matching Input..." . term-next-matching-input))
828 (define-key term-inout-menu [previous-matching-history]
829 '("Previous Matching Input..." . term-previous-matching-input))
830 (define-key term-inout-menu [next-matching-history-from-input]
831 '("Next Matching Current Input" . term-next-matching-input-from-input))
832 (define-key term-inout-menu [previous-matching-history-from-input]
833 '("Previous Matching Current Input" .
834 term-previous-matching-input-from-input))
835 (define-key term-inout-menu [next-history]
836 '("Next Input" . term-next-input))
837 (define-key term-inout-menu [previous-history]
838 '("Previous Input" . term-previous-input))
839 (define-key term-inout-menu [list-history]
840 '("List Input History" . term-dynamic-list-input-ring))
841 (define-key term-inout-menu [expand-history]
842 '("Expand History Before Point" . term-replace-by-expanded-history))
844 ;; Signals
845 (setq newmap (make-sparse-keymap "Signals"))
846 (define-key term-mode-map [menu-bar signals]
847 (setq term-signals-menu (cons "Signals" newmap)))
848 (define-key newmap [eof]
849 '(menu-item "EOF" term-send-eof
850 :help "Send an EOF to the current buffer's process"))
851 (define-key newmap [kill]
852 '(menu-item "KILL" term-kill-subjob
853 :help "Send kill signal to the current subjob"))
854 (define-key newmap [quit]
855 '(menu-item "QUIT" term-quit-subjob
856 :help "Send quit signal to the current subjob."))
857 (define-key newmap [cont]
858 '(menu-item "CONT" term-continue-subjob
859 :help "Send CONT signal to process buffer's process group"))
860 (define-key newmap [stop]
861 '(menu-item "STOP" term-stop-subjob
862 :help "Stop the current subjob"))
863 (define-key newmap [brk]
864 '(menu-item "BREAK" term-interrupt-subjob
865 :help "Interrupt the current subjob"))
868 ;; Set up term-raw-map, etc.
870 (defun term-set-escape-char (c)
871 "Change `term-escape-char' and keymaps that depend on it."
872 (when term-escape-char
873 (define-key term-raw-map term-escape-char 'term-send-raw))
874 (setq c (make-string 1 c))
875 (define-key term-raw-map c term-raw-escape-map)
876 ;; Define standard bindings in term-raw-escape-map
877 (define-key term-raw-escape-map "\C-v"
878 (lookup-key (current-global-map) "\C-v"))
879 (define-key term-raw-escape-map "\C-u"
880 (lookup-key (current-global-map) "\C-u"))
881 (define-key term-raw-escape-map c 'term-send-raw)
882 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
883 ;; The keybinding for term-char-mode is needed by the menubar code.
884 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
885 (define-key term-raw-escape-map "\C-j" 'term-line-mode)
886 ;; It's convenient to have execute-extended-command here.
887 (define-key term-raw-escape-map [?\M-x] 'execute-extended-command))
889 (let* ((map (make-keymap))
890 (esc-map (make-keymap))
891 (i 0))
892 (while (< i 128)
893 (define-key map (make-string 1 i) 'term-send-raw)
894 ;; Avoid O and [. They are used in escape sequences for various keys.
895 (unless (or (eq i ?O) (eq i 91))
896 (define-key esc-map (make-string 1 i) 'term-send-raw-meta))
897 (setq i (1+ i)))
898 (define-key map [remap self-insert-command] 'term-send-raw)
899 (define-key map "\e" esc-map)
900 (setq term-raw-map map)
901 (setq term-raw-escape-map
902 (copy-keymap (lookup-key (current-global-map) "\C-x")))
904 ;;; Added nearly all the 'grey keys' -mm
906 (if (featurep 'xemacs)
907 (define-key term-raw-map [button2] 'term-mouse-paste)
908 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
909 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
910 (define-key term-raw-map [menu-bar signals] term-signals-menu))
911 (define-key term-raw-map [up] 'term-send-up)
912 (define-key term-raw-map [down] 'term-send-down)
913 (define-key term-raw-map [right] 'term-send-right)
914 (define-key term-raw-map [left] 'term-send-left)
915 (define-key term-raw-map [delete] 'term-send-del)
916 (define-key term-raw-map [deletechar] 'term-send-del)
917 (define-key term-raw-map [backspace] 'term-send-backspace)
918 (define-key term-raw-map [home] 'term-send-home)
919 (define-key term-raw-map [end] 'term-send-end)
920 (define-key term-raw-map [insert] 'term-send-insert)
921 (define-key term-raw-map [S-prior] 'scroll-down)
922 (define-key term-raw-map [S-next] 'scroll-up)
923 (define-key term-raw-map [S-insert] 'term-paste)
924 (define-key term-raw-map [prior] 'term-send-prior)
925 (define-key term-raw-map [next] 'term-send-next))
927 (term-set-escape-char ?\C-c)
929 (defvar overflow-newline-into-fringe)
931 (defun term-window-width ()
932 (if (featurep 'xemacs)
933 (1- (window-width))
934 (if (and window-system overflow-newline-into-fringe)
935 (window-width)
936 (1- (window-width)))))
939 (put 'term-mode 'mode-class 'special)
942 ;;; Use this variable as a display table for `term-mode'.
943 (defvar term-display-table
944 (let ((dt (or (copy-sequence standard-display-table)
945 (make-display-table)))
947 ;; avoid changing the display table for ^J
948 (setq i 0)
949 (while (< i 10)
950 (aset dt i (vector i))
951 (setq i (1+ i)))
952 (setq i 11)
953 (while (< i 32)
954 (aset dt i (vector i))
955 (setq i (1+ i)))
956 (setq i 128)
957 (while (< i 256)
958 (aset dt i (vector i))
959 (setq i (1+ i)))
960 dt))
962 (defun term-mode ()
963 "Major mode for interacting with an inferior interpreter.
964 The interpreter name is same as buffer name, sans the asterisks.
966 There are two submodes: line mode and char mode. By default, you are
967 in char mode. In char sub-mode, each character (except
968 `term-escape-char') is sent immediately to the subprocess.
969 The escape character is equivalent to the usual meaning of C-x.
971 In line mode, you send a line of input at a time; use
972 \\[term-send-input] to send.
974 In line mode, this maintains an input history of size
975 `term-input-ring-size', and you can access it with the commands
976 \\[term-next-input], \\[term-previous-input], and
977 \\[term-dynamic-list-input-ring]. Input ring history expansion can be
978 achieved with the commands \\[term-replace-by-expanded-history] or
979 \\[term-magic-space]. Input ring expansion is controlled by the
980 variable `term-input-autoexpand', and addition is controlled by the
981 variable `term-input-ignoredups'.
983 Input to, and output from, the subprocess can cause the window to scroll to
984 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
985 and `term-scroll-to-bottom-on-output'.
987 If you accidentally suspend your process, use \\[term-continue-subjob]
988 to continue it.
990 This mode can be customized to create specific modes for running
991 particular subprocesses. This can be done by setting the hooks
992 `term-input-filter-functions', `term-input-filter',
993 `term-input-sender' and `term-get-old-input' to appropriate functions,
994 and the variable `term-prompt-regexp' to the appropriate regular
995 expression.
997 Commands in raw mode:
999 \\{term-raw-map}
1001 Commands in line mode:
1003 \\{term-mode-map}
1005 Entry to this mode runs the hooks on `term-mode-hook'."
1006 (interactive)
1007 ;; Do not remove this. All major modes must do this.
1008 (kill-all-local-variables)
1009 (setq major-mode 'term-mode)
1010 (setq mode-name "Term")
1011 (use-local-map term-mode-map)
1012 ;; we do not want indent to sneak in any tabs
1013 (setq indent-tabs-mode nil)
1014 (setq buffer-display-table term-display-table)
1015 (make-local-variable 'term-home-marker)
1016 (setq term-home-marker (copy-marker 0))
1017 (make-local-variable 'term-saved-home-marker)
1018 (make-local-variable 'term-height)
1019 (make-local-variable 'term-width)
1020 (setq term-width (term-window-width))
1021 (setq term-height (1- (window-height)))
1022 (make-local-variable 'term-terminal-parameter)
1023 (make-local-variable 'term-saved-cursor)
1024 (make-local-variable 'term-last-input-start)
1025 (setq term-last-input-start (make-marker))
1026 (make-local-variable 'term-last-input-end)
1027 (setq term-last-input-end (make-marker))
1028 (make-local-variable 'term-last-input-match)
1029 (setq term-last-input-match "")
1030 (make-local-variable 'term-prompt-regexp) ; Don't set; default
1031 (make-local-variable 'term-input-ring-size) ; ...to global val.
1032 (make-local-variable 'term-input-ring)
1033 (make-local-variable 'term-input-ring-file-name)
1034 (or (and (boundp 'term-input-ring) term-input-ring)
1035 (setq term-input-ring (make-ring term-input-ring-size)))
1036 (make-local-variable 'term-input-ring-index)
1037 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
1038 (setq term-input-ring-index nil))
1040 (make-local-variable 'term-command-hook)
1041 (setq term-command-hook (symbol-function 'term-command-hook))
1043 ;;; I'm not sure these saves are necessary but, since I
1044 ;;; haven't tested the whole thing on a net connected machine with
1045 ;;; a properly configured ange-ftp, I've decided to be conservative
1046 ;;; and put them in. -mm
1048 (make-local-variable 'term-ansi-at-host)
1049 (setq term-ansi-at-host (system-name))
1051 (make-local-variable 'term-ansi-at-dir)
1052 (setq term-ansi-at-dir default-directory)
1054 (make-local-variable 'term-ansi-at-message)
1055 (setq term-ansi-at-message nil)
1057 ;;; For user tracking purposes -mm
1058 (make-local-variable 'ange-ftp-default-user)
1059 (make-local-variable 'ange-ftp-default-password)
1060 (make-local-variable 'ange-ftp-generate-anonymous-password)
1062 ;;; You may want to have different scroll-back sizes -mm
1063 (make-local-variable 'term-buffer-maximum-size)
1065 ;;; Of course these have to be buffer-local -mm
1066 (make-local-variable 'term-ansi-current-bold)
1067 (make-local-variable 'term-ansi-current-color)
1068 (make-local-variable 'term-ansi-face-already-done)
1069 (make-local-variable 'term-ansi-current-bg-color)
1070 (make-local-variable 'term-ansi-current-underline)
1071 (make-local-variable 'term-ansi-current-reverse)
1072 (make-local-variable 'term-ansi-current-invisible)
1074 (make-local-variable 'term-terminal-parameter)
1075 (make-local-variable 'term-terminal-previous-parameter)
1076 (make-local-variable 'term-terminal-previous-parameter-2)
1077 (make-local-variable 'term-terminal-previous-parameter-3)
1078 (make-local-variable 'term-terminal-previous-parameter-4)
1079 (make-local-variable 'term-terminal-more-parameters)
1081 (make-local-variable 'term-terminal-state)
1082 (make-local-variable 'term-kill-echo-list)
1083 (make-local-variable 'term-start-line-column)
1084 (make-local-variable 'term-current-column)
1085 (make-local-variable 'term-current-row)
1086 (make-local-variable 'term-log-buffer)
1087 (make-local-variable 'term-scroll-start)
1088 (make-local-variable 'term-scroll-end)
1089 (setq term-scroll-end term-height)
1090 (make-local-variable 'term-scroll-with-delete)
1091 (make-local-variable 'term-pager-count)
1092 (make-local-variable 'term-pager-old-local-map)
1093 (make-local-variable 'term-old-mode-map)
1094 (make-local-variable 'term-insert-mode)
1095 (make-local-variable 'term-dynamic-complete-functions)
1096 (make-local-variable 'term-completion-fignore)
1097 (make-local-variable 'term-get-old-input)
1098 (make-local-variable 'term-matching-input-from-input-string)
1099 (make-local-variable 'term-input-autoexpand)
1100 (make-local-variable 'term-input-ignoredups)
1101 (make-local-variable 'term-delimiter-argument-list)
1102 (make-local-variable 'term-input-filter-functions)
1103 (make-local-variable 'term-input-filter)
1104 (make-local-variable 'term-input-sender)
1105 (make-local-variable 'term-eol-on-send)
1106 (make-local-variable 'term-scroll-to-bottom-on-output)
1107 (make-local-variable 'term-scroll-show-maximum-output)
1108 (make-local-variable 'term-ptyp)
1109 (make-local-variable 'term-exec-hook)
1110 (make-local-variable 'term-vertical-motion)
1111 (make-local-variable 'term-pending-delete-marker)
1112 (setq term-pending-delete-marker (make-marker))
1113 (make-local-variable 'term-current-face)
1114 (setq term-current-face (list :background term-default-bg-color
1115 :foreground term-default-fg-color))
1116 (make-local-variable 'term-pending-frame)
1117 (setq term-pending-frame nil)
1118 ;; Cua-mode's keybindings interfere with the term keybindings, disable it.
1119 (set (make-local-variable 'cua-mode) nil)
1120 (run-mode-hooks 'term-mode-hook)
1121 (when (featurep 'xemacs)
1122 (set-buffer-menubar
1123 (append current-menubar (list term-terminal-menu))))
1124 (or term-input-ring
1125 (setq term-input-ring (make-ring term-input-ring-size)))
1126 (term-update-mode-line))
1128 (defun term-reset-size (height width)
1129 (setq term-height height)
1130 (setq term-width width)
1131 (setq term-start-line-column nil)
1132 (setq term-current-row nil)
1133 (setq term-current-column nil)
1134 (term-set-scroll-region 0 height))
1136 ;; Recursive routine used to check if any string in term-kill-echo-list
1137 ;; matches part of the buffer before point.
1138 ;; If so, delete that matched part of the buffer - this suppresses echo.
1139 ;; Also, remove that string from the term-kill-echo-list.
1140 ;; We *also* remove any older string on the list, as a sanity measure,
1141 ;; in case something gets out of sync. (Except for type-ahead, there
1142 ;; should only be one element in the list.)
1144 (defun term-check-kill-echo-list ()
1145 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1146 (unwind-protect
1147 (progn
1148 (end-of-line)
1149 (while cur
1150 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1151 (if (and (>= start (point-min))
1152 (string= str (buffer-substring start (point))))
1153 (progn (delete-backward-char len)
1154 (setq term-kill-echo-list (cdr cur))
1155 (setq term-current-column nil)
1156 (setq term-current-row nil)
1157 (setq term-start-line-column nil)
1158 (setq cur nil found t))
1159 (setq cur (cdr cur))))))
1160 (when (not found)
1161 (goto-char save-point)))
1162 found))
1164 (defun term-check-size (process)
1165 (when (or (/= term-height (1- (window-height)))
1166 (/= term-width (term-window-width)))
1167 (term-reset-size (1- (window-height)) (term-window-width))
1168 (set-process-window-size process term-height term-width)))
1170 (defun term-send-raw-string (chars)
1171 (deactivate-mark)
1172 (let ((proc (get-buffer-process (current-buffer))))
1173 (if (not proc)
1174 (error "Current buffer has no process")
1175 ;; Note that (term-current-row) must be called *after*
1176 ;; (point) has been updated to (process-mark proc).
1177 (goto-char (process-mark proc))
1178 (when (term-pager-enabled)
1179 (setq term-pager-count (term-current-row)))
1180 (process-send-string proc chars))))
1182 (defun term-send-raw ()
1183 "Send the last character typed through the terminal-emulator
1184 without any interpretation."
1185 (interactive)
1186 ;; Convert `return' to C-m, etc.
1187 (when (and (symbolp last-input-event)
1188 (get last-input-event 'ascii-character))
1189 (setq last-input-event (get last-input-event 'ascii-character)))
1190 (term-send-raw-string (make-string 1 last-input-event)))
1192 (defun term-send-raw-meta ()
1193 (interactive)
1194 (let ((char last-input-event))
1195 (when (symbolp last-input-event)
1196 ;; Convert `return' to C-m, etc.
1197 (let ((tmp (get char 'event-symbol-elements)))
1198 (when tmp
1199 (setq char (car tmp)))
1200 (when (symbolp char)
1201 (setq tmp (get char 'ascii-character))
1202 (when tmp
1203 (setq char tmp)))))
1204 (setq char (event-basic-type char))
1205 (term-send-raw-string (if (and (numberp char)
1206 (> char 127)
1207 (< char 256))
1208 (make-string 1 char)
1209 (format "\e%c" char)))))
1211 (defun term-mouse-paste (click arg)
1212 "Insert the last stretch of killed text at the position clicked on."
1213 (interactive "e\nP")
1214 (if (featurep 'xemacs)
1215 (term-send-raw-string
1216 (or (condition-case () (x-get-selection) (error ()))
1217 (x-get-cutbuffer)
1218 (error "No selection or cut buffer available")))
1219 ;; Give temporary modes such as isearch a chance to turn off.
1220 (run-hooks 'mouse-leave-buffer-hook)
1221 (setq this-command 'yank)
1222 (mouse-set-point click)
1223 (term-send-raw-string (current-kill (cond
1224 ((listp arg) 0)
1225 ((eq arg '-) -1)
1226 (t (1- arg)))))))
1228 (defun term-paste ()
1229 "Insert the last stretch of killed text at point."
1230 (interactive)
1231 (term-send-raw-string (current-kill 0)))
1233 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1234 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1235 ;; For example: vi works with \eOA while elm wants \e[A ...
1236 ;;; (terminfo: kcuu1, kcud1, kcuf1, kcub1, khome, kend, kpp, knp, kdch1, kbs)
1237 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1238 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1239 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1240 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1241 (defun term-send-home () (interactive) (term-send-raw-string "\e[1~"))
1242 (defun term-send-insert() (interactive) (term-send-raw-string "\e[2~"))
1243 (defun term-send-end () (interactive) (term-send-raw-string "\e[4~"))
1244 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1245 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1246 (defun term-send-del () (interactive) (term-send-raw-string "\e[3~"))
1247 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-?"))
1249 (defun term-char-mode ()
1250 "Switch to char (\"raw\") sub-mode of term mode.
1251 Each character you type is sent directly to the inferior without
1252 intervention from Emacs, except for the escape character (usually C-c)."
1253 (interactive)
1254 ;; FIXME: Emit message? Cfr ilisp-raw-message
1255 (when (term-in-line-mode)
1256 (setq term-old-mode-map (current-local-map))
1257 (use-local-map term-raw-map)
1259 ;; Send existing partial line to inferior (without newline).
1260 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1261 (save-input-sender term-input-sender))
1262 (when (> (point) pmark)
1263 (unwind-protect
1264 (progn
1265 (setq term-input-sender
1266 (symbol-function 'term-send-string))
1267 (end-of-line)
1268 (term-send-input))
1269 (setq term-input-sender save-input-sender))))
1270 (term-update-mode-line)))
1272 (defun term-line-mode ()
1273 "Switch to line (\"cooked\") sub-mode of term mode.
1274 This means that Emacs editing commands work as normally, until
1275 you type \\[term-send-input] which sends the current line to the inferior."
1276 (interactive)
1277 (when (term-in-char-mode)
1278 (use-local-map term-old-mode-map)
1279 (term-update-mode-line)))
1281 (defun term-update-mode-line ()
1282 (let ((term-mode (if (term-in-char-mode) "char" "line"))
1283 (term-page (when (term-pager-enabled) " page"))
1284 (serial-item-speed)
1285 (serial-item-config)
1286 (temp)
1287 (proc (get-buffer-process (current-buffer))))
1288 (when (and (term-check-proc (current-buffer))
1289 (equal (process-type nil) 'serial))
1290 (let ((temp (serial-speed)))
1291 (setq serial-item-speed
1292 `(:propertize
1293 ,(or (and temp (format " %d" temp)) "")
1294 help-echo "mouse-1: Change the speed of the serial port"
1295 mouse-face mode-line-highlight
1296 local-map (keymap (mode-line keymap
1297 (down-mouse-1 . serial-mode-line-speed-menu-1))))))
1298 (let ((temp (process-contact proc :summary)))
1299 (setq serial-item-config
1300 `(:propertize
1301 ,(or (and temp (format " %s" temp)) "")
1302 help-echo "mouse-1: Change the configuration of the serial port"
1303 mouse-face mode-line-highlight
1304 local-map (keymap (mode-line keymap
1305 (down-mouse-1 . serial-mode-line-config-menu-1)))))))
1306 (setq mode-line-process
1307 (list ": " term-mode term-page
1308 serial-item-speed
1309 serial-item-config
1310 " %s")))
1311 (force-mode-line-update))
1313 (defun term-check-proc (buffer)
1314 "True if there is a process associated w/buffer BUFFER, and it
1315 is alive. BUFFER can be either a buffer or the name of one."
1316 (let ((proc (get-buffer-process buffer)))
1317 (and proc (memq (process-status proc) '(run stop open listen connect)))))
1319 ;;;###autoload
1320 (defun make-term (name program &optional startfile &rest switches)
1321 "Make a term process NAME in a buffer, running PROGRAM.
1322 The name of the buffer is made by surrounding NAME with `*'s.
1323 If there is already a running process in that buffer, it is not restarted.
1324 Optional third arg STARTFILE is the name of a file to send the contents of to
1325 the process. Any more args are arguments to PROGRAM."
1326 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1327 ;; If no process, or nuked process, crank up a new one and put buffer in
1328 ;; term mode. Otherwise, leave buffer and existing process alone.
1329 (cond ((not (term-check-proc buffer))
1330 (save-excursion
1331 (set-buffer buffer)
1332 (term-mode)) ; Install local vars, mode, keymap, ...
1333 (term-exec buffer name program startfile switches)))
1334 buffer))
1336 ;;;###autoload
1337 (defun term (program)
1338 "Start a terminal-emulator in a new buffer.
1339 The buffer is in Term mode; see `term-mode' for the
1340 commands to use in that buffer.
1342 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
1343 (interactive (list (read-from-minibuffer "Run program: "
1344 (or explicit-shell-file-name
1345 (getenv "ESHELL")
1346 (getenv "SHELL")
1347 "/bin/sh"))))
1348 (set-buffer (make-term "terminal" program))
1349 (term-mode)
1350 (term-char-mode)
1351 (switch-to-buffer "*terminal*"))
1353 (defun term-exec (buffer name command startfile switches)
1354 "Start up a process in buffer for term modes.
1355 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1356 You can use this to cheaply run a series of processes in the same term
1357 buffer. The hook `term-exec-hook' is run after each exec."
1358 (save-excursion
1359 (set-buffer buffer)
1360 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1361 (when proc (delete-process proc)))
1362 ;; Crank up a new process
1363 (let ((proc (term-exec-1 name buffer command switches)))
1364 (make-local-variable 'term-ptyp)
1365 (setq term-ptyp process-connection-type) ; t if pty, nil if pipe.
1366 ;; Jump to the end, and set the process mark.
1367 (goto-char (point-max))
1368 (set-marker (process-mark proc) (point))
1369 (set-process-filter proc 'term-emulate-terminal)
1370 (set-process-sentinel proc 'term-sentinel)
1371 ;; Feed it the startfile.
1372 (cond (startfile
1373 ;;This is guaranteed to wait long enough
1374 ;;but has bad results if the term does not prompt at all
1375 ;; (while (= size (buffer-size))
1376 ;; (sleep-for 1))
1377 ;;I hope 1 second is enough!
1378 (sleep-for 1)
1379 (goto-char (point-max))
1380 (insert-file-contents startfile)
1381 (setq startfile (buffer-substring (point) (point-max)))
1382 (delete-region (point) (point-max))
1383 (term-send-string proc startfile)))
1384 (run-hooks 'term-exec-hook)
1385 buffer)))
1387 (defun term-sentinel (proc msg)
1388 "Sentinel for term buffers.
1389 The main purpose is to get rid of the local keymap."
1390 (let ((buffer (process-buffer proc)))
1391 (when (memq (process-status proc) '(signal exit))
1392 (if (null (buffer-name buffer))
1393 ;; buffer killed
1394 (set-process-buffer proc nil)
1395 (let ((obuf (current-buffer)))
1396 ;; save-excursion isn't the right thing if
1397 ;; process-buffer is current-buffer
1398 (unwind-protect
1399 (progn
1400 ;; Write something in the compilation buffer
1401 ;; and hack its mode line.
1402 (set-buffer buffer)
1403 ;; Get rid of local keymap.
1404 (use-local-map nil)
1405 (term-handle-exit (process-name proc)
1406 msg)
1407 ;; Since the buffer and mode line will show that the
1408 ;; process is dead, we can delete it now. Otherwise it
1409 ;; will stay around until M-x list-processes.
1410 (delete-process proc))
1411 (set-buffer obuf)))
1412 ))))
1414 (defun term-handle-exit (process-name msg)
1415 "Write process exit (or other change) message MSG in the current buffer."
1416 (let ((buffer-read-only nil)
1417 (omax (point-max))
1418 (opoint (point)))
1419 ;; Record where we put the message, so we can ignore it
1420 ;; later on.
1421 (goto-char omax)
1422 (insert ?\n "Process " process-name " " msg)
1423 ;; Force mode line redisplay soon.
1424 (force-mode-line-update)
1425 (when (and opoint (< opoint omax))
1426 (goto-char opoint))))
1429 ;;; Name to use for TERM.
1430 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1431 (defvar term-term-name "eterm-color")
1432 ; Format string, usage:
1433 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1434 (defvar term-termcap-format
1435 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1436 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1437 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=^J\
1438 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1439 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1440 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC\
1441 :kl=\\EOD:kd=\\EOB:kr=\\EOC:ku=\\EOA:kN=\\E[6~:kP=\\E[5~:@7=\\E[4~:kh=\\E[1~\
1442 :mk=\\E[8m:cb=\\E[1K:op=\\E[39;49m:Co#8:pa#64:AB=\\E[4%%dm:AF=\\E[3%%dm:cr=^M\
1443 :bl=^G:do=^J:le=^H:ta=^I:se=\\E[27m:ue=\\E24m\
1444 :kb=^?:kD=^[[3~:sc=\\E7:rc=\\E8:r1=\\Ec:"
1445 ;;; : -undefine ic
1446 ;;; don't define :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1447 "Termcap capabilities supported.")
1449 ;;; This auxiliary function cranks up the process for term-exec in
1450 ;;; the appropriate environment.
1452 (defun term-exec-1 (name buffer command switches)
1453 ;; We need to do an extra (fork-less) exec to run stty.
1454 ;; (This would not be needed if we had suitable Emacs primitives.)
1455 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1456 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1457 ;; Thus we add an extra dummy argument "..", and then remove it.
1458 (let ((process-environment
1459 (nconc
1460 (list
1461 (format "TERM=%s" term-term-name)
1462 (format "TERMINFO=%s" data-directory)
1463 (format term-termcap-format "TERMCAP="
1464 term-term-name term-height term-width)
1465 ;; We are going to get rid of the binding for EMACS,
1466 ;; probably in Emacs 23, because it breaks
1467 ;; `./configure' of some packages that expect it to
1468 ;; say where to find EMACS.
1469 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1470 (format "INSIDE_EMACS=%s,term:%s" emacs-version term-protocol-version)
1471 (format "LINES=%d" term-height)
1472 (format "COLUMNS=%d" term-width))
1473 process-environment))
1474 (process-connection-type t)
1475 ;; We should suppress conversion of end-of-line format.
1476 (inhibit-eol-conversion t)
1477 ;; The process's output contains not just chars but also binary
1478 ;; escape codes, so we need to see the raw output. We will have to
1479 ;; do the decoding by hand on the parts that are made of chars.
1480 (coding-system-for-read 'binary))
1481 (apply 'start-process name buffer
1482 "/bin/sh" "-c"
1483 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1484 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1485 term-height term-width)
1486 ".."
1487 command switches)))
1490 ;;; Input history processing in a buffer
1491 ;;; ===========================================================================
1492 ;;; Useful input history functions, courtesy of the Ergo group.
1494 ;;; Eleven commands:
1495 ;;; term-dynamic-list-input-ring List history in help buffer.
1496 ;;; term-previous-input Previous input...
1497 ;;; term-previous-matching-input ...matching a string.
1498 ;;; term-previous-matching-input-from-input ... matching the current input.
1499 ;;; term-next-input Next input...
1500 ;;; term-next-matching-input ...matching a string.
1501 ;;; term-next-matching-input-from-input ... matching the current input.
1502 ;;; term-backward-matching-input Backwards input...
1503 ;;; term-forward-matching-input ...matching a string.
1504 ;;; term-replace-by-expanded-history Expand history at point;
1505 ;;; replace with expanded history.
1506 ;;; term-magic-space Expand history and insert space.
1508 ;;; Three functions:
1509 ;;; term-read-input-ring Read into term-input-ring...
1510 ;;; term-write-input-ring Write to term-input-ring-file-name.
1511 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1513 (defun term-read-input-ring (&optional silent)
1514 "Sets the buffer's `term-input-ring' from a history file.
1515 The name of the file is given by the variable `term-input-ring-file-name'.
1516 The history ring is of size `term-input-ring-size', regardless of file size.
1517 If `term-input-ring-file-name' is nil this function does nothing.
1519 If the optional argument SILENT is non-nil, we say nothing about a
1520 failure to read the history file.
1522 This function is useful for major mode commands and mode hooks.
1524 The structure of the history file should be one input command per line,
1525 with the most recent command last.
1526 See also `term-input-ignoredups' and `term-write-input-ring'."
1527 (cond ((or (null term-input-ring-file-name)
1528 (equal term-input-ring-file-name ""))
1529 nil)
1530 ((not (file-readable-p term-input-ring-file-name))
1531 (or silent
1532 (message "Cannot read history file %s"
1533 term-input-ring-file-name)))
1535 (let ((history-buf (get-buffer-create " *temp*"))
1536 (file term-input-ring-file-name)
1537 (count 0)
1538 (ring (make-ring term-input-ring-size)))
1539 (unwind-protect
1540 (save-excursion
1541 (set-buffer history-buf)
1542 (widen)
1543 (erase-buffer)
1544 (insert-file-contents file)
1545 ;; Save restriction in case file is already visited...
1546 ;; Watch for those date stamps in history files!
1547 (goto-char (point-max))
1548 (while (and (< count term-input-ring-size)
1549 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1550 nil t))
1551 (let ((history (buffer-substring (match-beginning 1)
1552 (match-end 1))))
1553 (when (or (null term-input-ignoredups)
1554 (ring-empty-p ring)
1555 (not (string-equal (ring-ref ring 0) history)))
1556 (ring-insert-at-beginning ring history)))
1557 (setq count (1+ count))))
1558 (kill-buffer history-buf))
1559 (setq term-input-ring ring
1560 term-input-ring-index nil)))))
1562 (defun term-write-input-ring ()
1563 "Writes the buffer's `term-input-ring' to a history file.
1564 The name of the file is given by the variable `term-input-ring-file-name'.
1565 The original contents of the file are lost if `term-input-ring' is not empty.
1566 If `term-input-ring-file-name' is nil this function does nothing.
1568 Useful within process sentinels.
1570 See also `term-read-input-ring'."
1571 (cond ((or (null term-input-ring-file-name)
1572 (equal term-input-ring-file-name "")
1573 (null term-input-ring) (ring-empty-p term-input-ring))
1574 nil)
1575 ((not (file-writable-p term-input-ring-file-name))
1576 (message "Cannot write history file %s" term-input-ring-file-name))
1578 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1579 (ring term-input-ring)
1580 (file term-input-ring-file-name)
1581 (index (ring-length ring)))
1582 ;; Write it all out into a buffer first. Much faster, but messier,
1583 ;; than writing it one line at a time.
1584 (save-excursion
1585 (set-buffer history-buf)
1586 (erase-buffer)
1587 (while (> index 0)
1588 (setq index (1- index))
1589 (insert (ring-ref ring index) ?\n))
1590 (write-region (buffer-string) nil file nil 'no-message)
1591 (kill-buffer nil))))))
1594 (defun term-dynamic-list-input-ring ()
1595 "List in help buffer the buffer's input history."
1596 (interactive)
1597 (if (or (not (ring-p term-input-ring))
1598 (ring-empty-p term-input-ring))
1599 (message "No history")
1600 (let ((history nil)
1601 (history-buffer " *Input History*")
1602 (index (1- (ring-length term-input-ring)))
1603 (conf (current-window-configuration)))
1604 ;; We have to build up a list ourselves from the ring vector.
1605 (while (>= index 0)
1606 (setq history (cons (ring-ref term-input-ring index) history)
1607 index (1- index)))
1608 ;; Change "completion" to "history reference"
1609 ;; to make the display accurate.
1610 (with-output-to-temp-buffer history-buffer
1611 (display-completion-list history)
1612 (set-buffer history-buffer)
1613 (forward-line 3)
1614 (while (search-backward "completion" nil 'move)
1615 (replace-match "history reference")))
1616 (sit-for 0)
1617 (message "Hit space to flush")
1618 (let ((ch (read-event)))
1619 (if (eq ch ?\s)
1620 (set-window-configuration conf)
1621 (setq unread-command-events (list ch)))))))
1624 (defun term-regexp-arg (prompt)
1625 ;; Return list of regexp and prefix arg using PROMPT.
1626 (let* (;; Don't clobber this.
1627 (last-command last-command)
1628 (regexp (read-from-minibuffer prompt nil nil nil
1629 'minibuffer-history-search-history)))
1630 (list (if (string-equal regexp "")
1631 (setcar minibuffer-history-search-history
1632 (nth 1 minibuffer-history-search-history))
1633 regexp)
1634 (prefix-numeric-value current-prefix-arg))))
1636 (defun term-search-arg (arg)
1637 ;; First make sure there is a ring and that we are after the process mark
1638 (cond ((not (term-after-pmark-p))
1639 (error "Not at command line"))
1640 ((or (null term-input-ring)
1641 (ring-empty-p term-input-ring))
1642 (error "Empty input ring"))
1643 ((zerop arg)
1644 ;; arg of zero resets search from beginning, and uses arg of 1
1645 (setq term-input-ring-index nil)
1648 arg)))
1650 (defun term-search-start (arg)
1651 ;; Index to start a directional search, starting at term-input-ring-index
1652 (if term-input-ring-index
1653 ;; If a search is running, offset by 1 in direction of arg
1654 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1655 (ring-length term-input-ring))
1656 ;; For a new search, start from beginning or end, as appropriate
1657 (if (>= arg 0)
1658 0 ; First elt for forward search
1659 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1661 (defun term-previous-input-string (arg)
1662 "Return the string ARG places along the input ring.
1663 Moves relative to `term-input-ring-index'."
1664 (ring-ref term-input-ring (if term-input-ring-index
1665 (mod (+ arg term-input-ring-index)
1666 (ring-length term-input-ring))
1667 arg)))
1669 (defun term-previous-input (arg)
1670 "Cycle backwards through input history."
1671 (interactive "*p")
1672 (term-previous-matching-input "." arg))
1674 (defun term-next-input (arg)
1675 "Cycle forwards through input history."
1676 (interactive "*p")
1677 (term-previous-input (- arg)))
1679 (defun term-previous-matching-input-string (regexp arg)
1680 "Return the string matching REGEXP ARG places along the input ring.
1681 Moves relative to `term-input-ring-index'."
1682 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1683 (when pos (ring-ref term-input-ring pos))))
1685 (defun term-previous-matching-input-string-position
1686 (regexp arg &optional start)
1687 "Return the index matching REGEXP ARG places along the input ring.
1688 Moves relative to START, or `term-input-ring-index'."
1689 (when (or (not (ring-p term-input-ring))
1690 (ring-empty-p term-input-ring))
1691 (error "No history"))
1692 (let* ((len (ring-length term-input-ring))
1693 (motion (if (> arg 0) 1 -1))
1694 (n (mod (- (or start (term-search-start arg)) motion) len))
1695 (tried-each-ring-item nil)
1696 (prev nil))
1697 ;; Do the whole search as many times as the argument says.
1698 (while (and (/= arg 0) (not tried-each-ring-item))
1699 ;; Step once.
1700 (setq prev n
1701 n (mod (+ n motion) len))
1702 ;; If we haven't reached a match, step some more.
1703 (while (and (< n len) (not tried-each-ring-item)
1704 (not (string-match regexp (ring-ref term-input-ring n))))
1705 (setq n (mod (+ n motion) len)
1706 ;; If we have gone all the way around in this search.
1707 tried-each-ring-item (= n prev)))
1708 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1709 ;; Now that we know which ring element to use, if we found it, return that.
1710 (when (string-match regexp (ring-ref term-input-ring n))
1711 n)))
1713 (defun term-previous-matching-input (regexp n)
1714 "Search backwards through input history for match for REGEXP.
1715 \(Previous history elements are earlier commands.)
1716 With prefix argument N, search for Nth previous match.
1717 If N is negative, find the next or Nth next match."
1718 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1719 (setq n (term-search-arg n))
1720 (let ((pos (term-previous-matching-input-string-position regexp n)))
1721 ;; Has a match been found?
1722 (if (null pos)
1723 (error "Not found")
1724 (setq term-input-ring-index pos)
1725 (message "History item: %d" (1+ pos))
1726 (delete-region
1727 ;; Can't use kill-region as it sets this-command
1728 (process-mark (get-buffer-process (current-buffer))) (point))
1729 (insert (ring-ref term-input-ring pos)))))
1731 (defun term-next-matching-input (regexp n)
1732 "Search forwards through input history for match for REGEXP.
1733 \(Later history elements are more recent commands.)
1734 With prefix argument N, search for Nth following match.
1735 If N is negative, find the previous or Nth previous match."
1736 (interactive (term-regexp-arg "Next input matching (regexp): "))
1737 (term-previous-matching-input regexp (- n)))
1739 (defun term-previous-matching-input-from-input (n)
1740 "Search backwards through input history for match for current input.
1741 \(Previous history elements are earlier commands.)
1742 With prefix argument N, search for Nth previous match.
1743 If N is negative, search forwards for the -Nth following match."
1744 (interactive "p")
1745 (when (not (memq last-command '(term-previous-matching-input-from-input
1746 term-next-matching-input-from-input)))
1747 ;; Starting a new search
1748 (setq term-matching-input-from-input-string
1749 (buffer-substring
1750 (process-mark (get-buffer-process (current-buffer)))
1751 (point))
1752 term-input-ring-index nil))
1753 (term-previous-matching-input
1754 (concat "^" (regexp-quote term-matching-input-from-input-string))
1757 (defun term-next-matching-input-from-input (n)
1758 "Search forwards through input history for match for current input.
1759 \(Following history elements are more recent commands.)
1760 With prefix argument N, search for Nth following match.
1761 If N is negative, search backwards for the -Nth previous match."
1762 (interactive "p")
1763 (term-previous-matching-input-from-input (- n)))
1766 (defun term-replace-by-expanded-history (&optional silent)
1767 "Expand input command history references before point.
1768 Expansion is dependent on the value of `term-input-autoexpand'.
1770 This function depends on the buffer's idea of the input history, which may not
1771 match the command interpreter's idea, assuming it has one.
1773 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1774 cannot know the interpreter's idea of input line numbers, assuming it has one,
1775 it cannot expand absolute input line number references.
1777 If the optional argument SILENT is non-nil, never complain
1778 even if history reference seems erroneous.
1780 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1782 Returns t if successful."
1783 (interactive)
1784 (when (and term-input-autoexpand
1785 (string-match "[!^]" (funcall term-get-old-input))
1786 (save-excursion (beginning-of-line)
1787 (looking-at term-prompt-regexp)))
1788 ;; Looks like there might be history references in the command.
1789 (let ((previous-modified-tick (buffer-modified-tick)))
1790 (message "Expanding history references...")
1791 (term-replace-by-expanded-history-before-point silent)
1792 (/= previous-modified-tick (buffer-modified-tick)))))
1795 (defun term-replace-by-expanded-history-before-point (silent)
1796 "Expand directory stack reference before point.
1797 See `term-replace-by-expanded-history'. Returns t if successful."
1798 (save-excursion
1799 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1800 (start (progn (term-bol nil) (point))))
1801 (while (progn
1802 (skip-chars-forward "^!^"
1803 (save-excursion
1804 (end-of-line nil) (- (point) toend)))
1805 (< (point)
1806 (save-excursion
1807 (end-of-line nil) (- (point) toend))))
1808 ;; This seems a bit complex. We look for references such as !!, !-num,
1809 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1810 ;; If that wasn't enough, the plings can be suffixed with argument
1811 ;; range specifiers.
1812 ;; Argument ranges are complex too, so we hive off the input line,
1813 ;; referenced with plings, with the range string to `term-args'.
1814 (setq term-input-ring-index nil)
1815 (cond ((or (= (preceding-char) ?\\)
1816 (term-within-quotes start (point)))
1817 ;; The history is quoted, or we're in quotes.
1818 (goto-char (1+ (point))))
1819 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1820 ;; We cannot know the interpreter's idea of input line numbers.
1821 (goto-char (match-end 0))
1822 (message "Absolute reference cannot be expanded"))
1823 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1824 ;; Just a number of args from `number' lines backward.
1825 (let ((number (1- (string-to-number
1826 (buffer-substring (match-beginning 1)
1827 (match-end 1))))))
1828 (if (<= number (ring-length term-input-ring))
1829 (progn
1830 (replace-match
1831 (term-args (term-previous-input-string number)
1832 (match-beginning 2) (match-end 2))
1833 t t)
1834 (setq term-input-ring-index number)
1835 (message "History item: %d" (1+ number)))
1836 (goto-char (match-end 0))
1837 (message "Relative reference exceeds input history size"))))
1838 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1839 ;; Just a number of args from the previous input line.
1840 (replace-match
1841 (term-args (term-previous-input-string 0)
1842 (match-beginning 1) (match-end 1))
1843 t t)
1844 (message "History item: previous"))
1845 ((looking-at
1846 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1847 ;; Most recent input starting with or containing (possibly
1848 ;; protected) string, maybe just a number of args. Phew.
1849 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1850 (mb2 (match-beginning 2)) (me2 (match-end 2))
1851 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1852 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1853 (pos (save-match-data
1854 (term-previous-matching-input-string-position
1855 (concat pref (regexp-quote exp)) 1))))
1856 (if (null pos)
1857 (progn
1858 (goto-char (match-end 0))
1859 (or silent
1860 (progn (message "Not found")
1861 (ding))))
1862 (setq term-input-ring-index pos)
1863 (replace-match
1864 (term-args (ring-ref term-input-ring pos)
1865 (match-beginning 4) (match-end 4))
1866 t t)
1867 (message "History item: %d" (1+ pos)))))
1868 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1869 ;; Quick substitution on the previous input line.
1870 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1871 (new (buffer-substring (match-beginning 2) (match-end 2)))
1872 (pos nil))
1873 (replace-match (term-previous-input-string 0) t t)
1874 (setq pos (point))
1875 (goto-char (match-beginning 0))
1876 (if (not (search-forward old pos t))
1877 (or silent
1878 (error "Not found"))
1879 (replace-match new t t)
1880 (message "History item: substituted"))))
1882 (goto-char (match-end 0))))))))
1885 (defun term-magic-space (arg)
1886 "Expand input history references before point and insert ARG spaces.
1887 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1888 (interactive "p")
1889 (term-replace-by-expanded-history)
1890 (self-insert-command arg))
1892 (defun term-within-quotes (beg end)
1893 "Return t if the number of quotes between BEG and END is odd.
1894 Quotes are single and double."
1895 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1896 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1897 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1899 (defun term-how-many-region (regexp beg end)
1900 "Return number of matches for REGEXP from BEG to END."
1901 (let ((count 0))
1902 (save-excursion
1903 (save-match-data
1904 (goto-char beg)
1905 (while (re-search-forward regexp end t)
1906 (setq count (1+ count)))))
1907 count))
1909 (defun term-args (string begin end)
1910 ;; From STRING, return the args depending on the range specified in the text
1911 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1912 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1913 (save-match-data
1914 (if (null begin)
1915 (term-arguments string 0 nil)
1916 (let* ((range (buffer-substring
1917 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1918 (nth (cond ((string-match "^[*^]" range) 1)
1919 ((string-match "^-" range) 0)
1920 ((string-equal range "$") nil)
1921 (t (string-to-number range))))
1922 (mth (cond ((string-match "[-*$]$" range) nil)
1923 ((string-match "-" range)
1924 (string-to-number (substring range (match-end 0))))
1925 (t nth))))
1926 (term-arguments string nth mth)))))
1928 ;; Return a list of arguments from ARG. Break it up at the
1929 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1930 (defun term-delim-arg (arg)
1931 (if (null term-delimiter-argument-list)
1932 (list arg)
1933 (let ((args nil)
1934 (pos 0)
1935 (len (length arg)))
1936 (while (< pos len)
1937 (let ((char (aref arg pos))
1938 (start pos))
1939 (if (memq char term-delimiter-argument-list)
1940 (while (and (< pos len) (eq (aref arg pos) char))
1941 (setq pos (1+ pos)))
1942 (while (and (< pos len)
1943 (not (memq (aref arg pos)
1944 term-delimiter-argument-list)))
1945 (setq pos (1+ pos))))
1946 (setq args (cons (substring arg start pos) args))))
1947 args)))
1949 (defun term-arguments (string nth mth)
1950 "Return from STRING the NTH to MTH arguments.
1951 NTH and/or MTH can be nil, which means the last argument.
1952 Returned arguments are separated by single spaces.
1953 We assume whitespace separates arguments, except within quotes.
1954 Also, a run of one or more of a single character
1955 in `term-delimiter-argument-list' is a separate argument.
1956 Argument 0 is the command name."
1957 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1958 (args ()) (pos 0)
1959 (count 0)
1960 beg str quotes)
1961 ;; Build a list of all the args until we have as many as we want.
1962 (while (and (or (null mth) (<= count mth))
1963 (string-match argpart string pos))
1964 (if (and beg (= pos (match-beginning 0)))
1965 ;; It's contiguous, part of the same arg.
1966 (setq pos (match-end 0)
1967 quotes (or quotes (match-beginning 1)))
1968 ;; It's a new separate arg.
1969 (if beg
1970 ;; Put the previous arg, if there was one, onto ARGS.
1971 (setq str (substring string beg pos)
1972 args (if quotes (cons str args)
1973 (nconc (term-delim-arg str) args))
1974 count (1+ count)))
1975 (setq quotes (match-beginning 1))
1976 (setq beg (match-beginning 0))
1977 (setq pos (match-end 0))))
1978 (if beg
1979 (setq str (substring string beg pos)
1980 args (if quotes (cons str args)
1981 (nconc (term-delim-arg str) args))
1982 count (1+ count)))
1983 (let ((n (or nth (1- count)))
1984 (m (if mth (1- (- count mth)) 0)))
1985 (mapconcat
1986 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1989 ;;; Input processing stuff [line mode]
1992 (defun term-send-input ()
1993 "Send input to process.
1994 After the process output mark, sends all text from the process mark to
1995 point as input to the process. Before the process output mark, calls value
1996 of variable term-get-old-input to retrieve old input, copies it to the
1997 process mark, and sends it. A terminal newline is also inserted into the
1998 buffer and sent to the process. The list of function names contained in the
1999 value of `term-input-filter-functions' is called on the input before sending
2000 it. The input is entered into the input history ring, if the value of variable
2001 term-input-filter returns non-nil when called on the input.
2003 Any history reference may be expanded depending on the value of the variable
2004 `term-input-autoexpand'. The list of function names contained in the value
2005 of `term-input-filter-functions' is called on the input before sending it.
2006 The input is entered into the input history ring, if the value of variable
2007 `term-input-filter' returns non-nil when called on the input.
2009 If variable `term-eol-on-send' is non-nil, then point is moved to the
2010 end of line before sending the input.
2012 The values of `term-get-old-input', `term-input-filter-functions', and
2013 `term-input-filter' are chosen according to the command interpreter running
2014 in the buffer. E.g.,
2016 If the interpreter is the csh,
2017 term-get-old-input is the default: take the current line, discard any
2018 initial string matching regexp term-prompt-regexp.
2019 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
2020 \"popd\" commands. When it sees one, it cd's the buffer.
2021 term-input-filter is the default: returns t if the input isn't all white
2022 space.
2024 If the term is Lucid Common Lisp,
2025 term-get-old-input snarfs the sexp ending at point.
2026 term-input-filter-functions does nothing.
2027 term-input-filter returns nil if the input matches input-filter-regexp,
2028 which matches (1) all whitespace (2) :a, :c, etc.
2030 Similarly for Soar, Scheme, etc."
2031 (interactive)
2032 ;; Note that the input string does not include its terminal newline.
2033 (let ((proc (get-buffer-process (current-buffer))))
2034 (if (not proc) (error "Current buffer has no process")
2035 (let* ((pmark (process-mark proc))
2036 (pmark-val (marker-position pmark))
2037 (input-is-new (>= (point) pmark-val))
2038 (intxt (if input-is-new
2039 (progn (if term-eol-on-send (end-of-line))
2040 (buffer-substring pmark (point)))
2041 (funcall term-get-old-input)))
2042 (input (if (not (eq term-input-autoexpand 'input))
2043 ;; Just whatever's already there
2044 intxt
2045 ;; Expand and leave it visible in buffer
2046 (term-replace-by-expanded-history t)
2047 (buffer-substring pmark (point))))
2048 (history (if (not (eq term-input-autoexpand 'history))
2049 input
2050 ;; This is messy 'cos ultimately the original
2051 ;; functions used do insertion, rather than return
2052 ;; strings. We have to expand, then insert back.
2053 (term-replace-by-expanded-history t)
2054 (let ((copy (buffer-substring pmark (point))))
2055 (delete-region pmark (point))
2056 (insert input)
2057 copy))))
2058 (when (term-pager-enabled)
2059 (save-excursion
2060 (goto-char (process-mark proc))
2061 (setq term-pager-count (term-current-row))))
2062 (when (and (funcall term-input-filter history)
2063 (or (null term-input-ignoredups)
2064 (not (ring-p term-input-ring))
2065 (ring-empty-p term-input-ring)
2066 (not (string-equal (ring-ref term-input-ring 0)
2067 history))))
2068 (ring-insert term-input-ring history))
2069 (let ((functions term-input-filter-functions))
2070 (while functions
2071 (funcall (car functions) (concat input "\n"))
2072 (setq functions (cdr functions))))
2073 (setq term-input-ring-index nil)
2075 ;; Update the markers before we send the input
2076 ;; in case we get output amidst sending the input.
2077 (set-marker term-last-input-start pmark)
2078 (set-marker term-last-input-end (point))
2079 (when input-is-new
2080 ;; Set up to delete, because inferior should echo.
2081 (when (marker-buffer term-pending-delete-marker)
2082 (delete-region term-pending-delete-marker pmark))
2083 (set-marker term-pending-delete-marker pmark-val)
2084 (set-marker (process-mark proc) (point)))
2085 (goto-char pmark)
2086 (funcall term-input-sender proc input)))))
2088 (defun term-get-old-input-default ()
2089 "Default for `term-get-old-input'.
2090 Take the current line, and discard any initial text matching
2091 `term-prompt-regexp'."
2092 (save-excursion
2093 (beginning-of-line)
2094 (term-skip-prompt)
2095 (let ((beg (point)))
2096 (end-of-line)
2097 (buffer-substring beg (point)))))
2099 (defun term-copy-old-input ()
2100 "Insert after prompt old input at point as new input to be edited.
2101 Calls `term-get-old-input' to get old input."
2102 (interactive)
2103 (let ((input (funcall term-get-old-input))
2104 (process (get-buffer-process (current-buffer))))
2105 (if (not process)
2106 (error "Current buffer has no process")
2107 (goto-char (process-mark process))
2108 (insert input))))
2110 (defun term-skip-prompt ()
2111 "Skip past the text matching regexp `term-prompt-regexp'.
2112 If this takes us past the end of the current line, don't skip at all."
2113 (let ((eol (save-excursion (end-of-line) (point))))
2114 (when (and (looking-at term-prompt-regexp)
2115 (<= (match-end 0) eol))
2116 (goto-char (match-end 0)))))
2119 (defun term-after-pmark-p ()
2120 "Is point after the process output marker?"
2121 ;; Since output could come into the buffer after we looked at the point
2122 ;; but before we looked at the process marker's value, we explicitly
2123 ;; serialise. This is just because I don't know whether or not Emacs
2124 ;; services input during execution of lisp commands.
2125 (let ((proc-pos (marker-position
2126 (process-mark (get-buffer-process (current-buffer))))))
2127 (<= proc-pos (point))))
2129 (defun term-simple-send (proc string)
2130 "Default function for sending to PROC input STRING.
2131 This just sends STRING plus a newline. To override this,
2132 set the hook `term-input-sender'."
2133 (term-send-string proc string)
2134 (term-send-string proc "\n"))
2136 (defun term-bol (arg)
2137 "Goes to the beginning of line, then skips past the prompt, if any.
2138 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2139 -- go straight to column 0.
2141 The prompt skip is done by skipping text matching the regular expression
2142 `term-prompt-regexp', a buffer local variable."
2143 (interactive "P")
2144 (beginning-of-line)
2145 (when (null arg) (term-skip-prompt)))
2147 ;;; These two functions are for entering text you don't want echoed or
2148 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2149 ;;; Just enter m-x term-send-invisible and type in your line.
2151 (defun term-read-noecho (prompt &optional stars)
2152 "Read a single line of text from user without echoing, and return it.
2153 Prompt with argument PROMPT, a string. Optional argument STARS causes
2154 input to be echoed with '*' characters on the prompt line. Input ends with
2155 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2156 `inhibit-quit' is set because e.g. this function was called from a process
2157 filter and C-g is pressed, this function returns nil rather than a string).
2159 Note that the keystrokes comprising the text can still be recovered
2160 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2161 applications."
2162 (let ((ans "")
2163 (c 0)
2164 (echo-keystrokes 0)
2165 (cursor-in-echo-area t)
2166 (done nil))
2167 (while (not done)
2168 (if stars
2169 (message "%s%s" prompt (make-string (length ans) ?*))
2170 (message "%s" prompt))
2171 (setq c (read-char))
2172 (cond ((= c ?\C-g)
2173 ;; This function may get called from a process filter, where
2174 ;; inhibit-quit is set. In later versions of Emacs read-char
2175 ;; may clear quit-flag itself and return C-g. That would make
2176 ;; it impossible to quit this loop in a simple way, so
2177 ;; re-enable it here (for backward-compatibility the check for
2178 ;; quit-flag below would still be necessary, so this seems
2179 ;; like the simplest way to do things).
2180 (setq quit-flag t
2181 done t))
2182 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2183 (setq done t))
2184 ((= c ?\C-u)
2185 (setq ans ""))
2186 ((and (/= c ?\b) (/= c ?\177))
2187 (setq ans (concat ans (char-to-string c))))
2188 ((> (length ans) 0)
2189 (setq ans (substring ans 0 -1)))))
2190 (if quit-flag
2191 ;; Emulate a true quit, except that we have to return a value.
2192 (prog1
2193 (setq quit-flag nil)
2194 (message "Quit")
2195 (beep t))
2196 (message "")
2197 ans)))
2199 (defun term-send-invisible (str &optional proc)
2200 "Read a string without echoing.
2201 Then send it to the process running in the current buffer. A new-line
2202 is additionally sent. String is not saved on term input history list.
2203 Security bug: your string can still be temporarily recovered with
2204 \\[view-lossage]."
2205 (interactive "P") ; Defeat snooping via C-x esc
2206 (when (not (stringp str))
2207 (setq str (term-read-noecho "Non-echoed text: " t)))
2208 (when (not proc)
2209 (setq proc (get-buffer-process (current-buffer))))
2210 (if (not proc) (error "Current buffer has no process")
2211 (setq term-kill-echo-list (nconc term-kill-echo-list
2212 (cons str nil)))
2213 (term-send-string proc str)
2214 (term-send-string proc "\n")))
2217 ;;; Low-level process communication
2219 (defvar term-input-chunk-size 512
2220 "*Long inputs send to term processes are broken up into chunks of this size.
2221 If your process is choking on big inputs, try lowering the value.")
2223 (defun term-send-string (proc str)
2224 "Send to PROC the contents of STR as input.
2225 This is equivalent to `process-send-string', except that long input strings
2226 are broken up into chunks of size `term-input-chunk-size'. Processes
2227 are given a chance to output between chunks. This can help prevent processes
2228 from hanging when you send them long inputs on some OS's."
2229 (let* ((len (length str))
2230 (i (min len term-input-chunk-size)))
2231 (process-send-string proc (substring str 0 i))
2232 (while (< i len)
2233 (let ((next-i (+ i term-input-chunk-size)))
2234 (accept-process-output)
2235 (process-send-string proc (substring str i (min len next-i)))
2236 (setq i next-i)))))
2238 (defun term-send-region (proc start end)
2239 "Send to PROC the region delimited by START and END.
2240 This is a replacement for `process-send-region' that tries to keep
2241 your process from hanging on long inputs. See `term-send-string'."
2242 (term-send-string proc (buffer-substring start end)))
2245 ;;; Random input hackage
2247 (defun term-kill-output ()
2248 "Kill all output from interpreter since last input."
2249 (interactive)
2250 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2251 (kill-region term-last-input-end pmark)
2252 (goto-char pmark)
2253 (insert "*** output flushed ***\n")
2254 (set-marker pmark (point))))
2256 (defun term-show-output ()
2257 "Display start of this batch of interpreter output at top of window.
2258 Sets mark to the value of point when this command is run."
2259 (interactive)
2260 (goto-char term-last-input-end)
2261 (backward-char)
2262 (beginning-of-line)
2263 (set-window-start (selected-window) (point))
2264 (end-of-line))
2266 (defun term-interrupt-subjob ()
2267 "Interrupt the current subjob."
2268 (interactive)
2269 (interrupt-process nil term-ptyp))
2271 (defun term-kill-subjob ()
2272 "Send kill signal to the current subjob."
2273 (interactive)
2274 (kill-process nil term-ptyp))
2276 (defun term-quit-subjob ()
2277 "Send quit signal to the current subjob."
2278 (interactive)
2279 (quit-process nil term-ptyp))
2281 (defun term-stop-subjob ()
2282 "Stop the current subjob.
2283 WARNING: if there is no current subjob, you can end up suspending
2284 the top-level process running in the buffer. If you accidentally do
2285 this, use \\[term-continue-subjob] to resume the process. (This
2286 is not a problem with most shells, since they ignore this signal.)"
2287 (interactive)
2288 (stop-process nil term-ptyp))
2290 (defun term-continue-subjob ()
2291 "Send CONT signal to process buffer's process group.
2292 Useful if you accidentally suspend the top-level process."
2293 (interactive)
2294 (continue-process nil term-ptyp))
2296 (defun term-kill-input ()
2297 "Kill all text from last stuff output by interpreter to point."
2298 (interactive)
2299 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2300 (p-pos (marker-position pmark)))
2301 (when (> (point) p-pos)
2302 (kill-region pmark (point)))))
2304 (defun term-delchar-or-maybe-eof (arg)
2305 "Delete ARG characters forward, or send an EOF to process if at end of
2306 buffer."
2307 (interactive "p")
2308 (if (eobp)
2309 (process-send-eof)
2310 (delete-char arg)))
2312 (defun term-send-eof ()
2313 "Send an EOF to the current buffer's process."
2314 (interactive)
2315 (process-send-eof))
2317 (defun term-backward-matching-input (regexp n)
2318 "Search backward through buffer for match for REGEXP.
2319 Matches are searched for on lines that match `term-prompt-regexp'.
2320 With prefix argument N, search for Nth previous match.
2321 If N is negative, find the next or Nth next match."
2322 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2323 (let* ((re (concat term-prompt-regexp ".*" regexp))
2324 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2325 (when (re-search-backward re nil t n)
2326 (point)))))
2327 (if (null pos)
2328 (progn (message "Not found")
2329 (ding))
2330 (goto-char pos)
2331 (term-bol nil))))
2333 (defun term-forward-matching-input (regexp n)
2334 "Search forward through buffer for match for REGEXP.
2335 Matches are searched for on lines that match `term-prompt-regexp'.
2336 With prefix argument N, search for Nth following match.
2337 If N is negative, find the previous or Nth previous match."
2338 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2339 (term-backward-matching-input regexp (- n)))
2342 (defun term-next-prompt (n)
2343 "Move to end of Nth next prompt in the buffer.
2344 See `term-prompt-regexp'."
2345 (interactive "p")
2346 (let ((paragraph-start term-prompt-regexp))
2347 (end-of-line (if (> n 0) 1 0))
2348 (forward-paragraph n)
2349 (term-skip-prompt)))
2351 (defun term-previous-prompt (n)
2352 "Move to end of Nth previous prompt in the buffer.
2353 See `term-prompt-regexp'."
2354 (interactive "p")
2355 (term-next-prompt (- n)))
2357 ;;; Support for source-file processing commands.
2358 ;;;============================================================================
2359 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2360 ;;; commands that process files of source text (e.g. loading or compiling
2361 ;;; files). So the corresponding process-in-a-buffer modes have commands
2362 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2363 ;;; for defining these commands.
2365 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2366 ;;; and Soar, in that they don't know anything about file extensions.
2367 ;;; So the compile/load interface gets the wrong default occasionally.
2368 ;;; The load-file/compile-file default mechanism could be smarter -- it
2369 ;;; doesn't know about the relationship between filename extensions and
2370 ;;; whether the file is source or executable. If you compile foo.lisp
2371 ;;; with compile-file, then the next load-file should use foo.bin for
2372 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2373 ;;; because the extension for executable files varies so much (.o, .bin,
2374 ;;; .lbin, .mo, .vo, .ao, ...).
2377 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2378 ;;; commands.
2380 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2381 ;;; want to save the buffer before issuing any process requests to the command
2382 ;;; interpreter.
2384 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2385 ;;; for the file to process.
2387 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2388 ;;;============================================================================
2389 ;;; This function computes the defaults for the load-file and compile-file
2390 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2392 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2393 ;;; source-file processing command, or nil if there hasn't been one yet.
2394 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2395 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2396 ;;; Typically, (lisp-mode) or (scheme-mode).
2398 ;;; If the command is given while the cursor is inside a string, *and*
2399 ;;; the string is an existing filename, *and* the filename is not a directory,
2400 ;;; then the string is taken as default. This allows you to just position
2401 ;;; your cursor over a string that's a filename and have it taken as default.
2403 ;;; If the command is given in a file buffer whose major mode is in
2404 ;;; SOURCE-MODES, then the filename is the default file, and the
2405 ;;; file's directory is the default directory.
2407 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2408 ;;; then the default directory & file are what was used in the last source-file
2409 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2410 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2411 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2413 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2414 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2415 ;;; for Soar programs, etc.
2417 ;;; The function returns a pair: (default-directory . default-file).
2419 (defun term-source-default (previous-dir/file source-modes)
2420 (cond ((and buffer-file-name (memq major-mode source-modes))
2421 (cons (file-name-directory buffer-file-name)
2422 (file-name-nondirectory buffer-file-name)))
2423 (previous-dir/file)
2425 (cons default-directory nil))))
2428 ;;; (TERM-CHECK-SOURCE fname)
2429 ;;;============================================================================
2430 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2431 ;;; process-in-a-buffer modes), this function can be called on the filename.
2432 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2433 ;;; is queried to see if he wants to save the buffer before proceeding with
2434 ;;; the load or compile.
2436 (defun term-check-source (fname)
2437 (let ((buff (get-file-buffer fname)))
2438 (when (and buff
2439 (buffer-modified-p buff)
2440 (y-or-n-p (format "Save buffer %s first? "
2441 (buffer-name buff))))
2442 ;; save BUFF.
2443 (let ((old-buffer (current-buffer)))
2444 (set-buffer buff)
2445 (save-buffer)
2446 (set-buffer old-buffer)))))
2449 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2450 ;;;============================================================================
2451 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2452 ;;; commands that process source files (like loading or compiling a file).
2453 ;;; It prompts for the filename, provides a default, if there is one,
2454 ;;; and returns the result filename.
2456 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2458 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2459 ;;; from the last source processing command. SOURCE-MODES is a list of major
2460 ;;; modes used to determine what file buffers contain source files. (These
2461 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2462 ;;; then the filename reader will only accept a file that exists.
2464 ;;; A typical use:
2465 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2466 ;;; '(lisp-mode) t))
2468 ;;; This is pretty stupid about strings. It decides we're in a string
2469 ;;; if there's a quote on both sides of point on the current line.
2470 (defun term-extract-string ()
2471 "Return string around `point' that starts the current line or nil."
2472 (save-excursion
2473 (let* ((point (point))
2474 (bol (progn (beginning-of-line) (point)))
2475 (eol (progn (end-of-line) (point)))
2476 (start (progn (goto-char point)
2477 (and (search-backward "\"" bol t)
2478 (1+ (point)))))
2479 (end (progn (goto-char point)
2480 (and (search-forward "\"" eol t)
2481 (1- (point))))))
2482 (and start end
2483 (buffer-substring start end)))))
2485 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2486 (let* ((def (term-source-default prev-dir/file source-modes))
2487 (stringfile (term-extract-string))
2488 (sfile-p (and stringfile
2489 (condition-case ()
2490 (file-exists-p stringfile)
2491 (error nil))
2492 (not (file-directory-p stringfile))))
2493 (defdir (if sfile-p (file-name-directory stringfile)
2494 (car def)))
2495 (deffile (if sfile-p (file-name-nondirectory stringfile)
2496 (cdr def)))
2497 (ans (read-file-name (if deffile (format "%s(default %s) "
2498 prompt deffile)
2499 prompt)
2500 defdir
2501 (concat defdir deffile)
2502 mustmatch-p)))
2503 (list (expand-file-name (substitute-in-file-name ans)))))
2505 ;;; I am somewhat divided on this string-default feature. It seems
2506 ;;; to violate the principle-of-least-astonishment, in that it makes
2507 ;;; the default harder to predict, so you actually have to look and see
2508 ;;; what the default really is before choosing it. This can trip you up.
2509 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2510 ;;; on this.
2511 ;;; -Olin
2514 ;;; Simple process query facility.
2515 ;;; ===========================================================================
2516 ;;; This function is for commands that want to send a query to the process
2517 ;;; and show the response to the user. For example, a command to get the
2518 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2519 ;;; to an inferior Common Lisp process.
2521 ;;; This simple facility just sends strings to the inferior process and pops
2522 ;;; up a window for the process buffer so you can see what the process
2523 ;;; responds with. We don't do anything fancy like try to intercept what the
2524 ;;; process responds with and put it in a pop-up window or on the message
2525 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2527 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2528 ;;; a window for the inferior process so that its response can be seen.
2529 (defun term-proc-query (proc str)
2530 (let* ((proc-buf (process-buffer proc))
2531 (proc-mark (process-mark proc)))
2532 (display-buffer proc-buf)
2533 (set-buffer proc-buf) ; but it's not the selected *window*
2534 (let ((proc-win (get-buffer-window proc-buf))
2535 (proc-pt (marker-position proc-mark)))
2536 (term-send-string proc str) ; send the query
2537 (accept-process-output proc) ; wait for some output
2538 ;; Try to position the proc window so you can see the answer.
2539 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2540 ;; I don't know why. Wizards invited to improve it.
2541 (when (not (pos-visible-in-window-p proc-pt proc-win))
2542 (let ((opoint (window-point proc-win)))
2543 (set-window-point proc-win proc-mark) (sit-for 0)
2544 (if (not (pos-visible-in-window-p opoint proc-win))
2545 (push-mark opoint)
2546 (set-window-point proc-win opoint)))))))
2548 ;;; Returns the current column in the current screen line.
2549 ;;; Note: (current-column) yields column in buffer line.
2551 (defun term-horizontal-column ()
2552 (- (term-current-column) (term-start-line-column)))
2554 ;; Calls either vertical-motion or term-buffer-vertical-motion
2555 (defmacro term-vertical-motion (count)
2556 (list 'funcall 'term-vertical-motion count))
2558 ;; An emulation of vertical-motion that is independent of having a window.
2559 ;; Instead, it uses the term-width variable as the logical window width.
2561 (defun term-buffer-vertical-motion (count)
2562 (cond ((= count 0)
2563 (move-to-column (* term-width (/ (current-column) term-width)))
2565 ((> count 0)
2566 (let ((H)
2567 (todo (+ count (/ (current-column) term-width))))
2568 (end-of-line)
2569 ;; The loop iterates over buffer lines;
2570 ;; H is the number of screen lines in the current line, i.e.
2571 ;; the ceiling of dividing the buffer line width by term-width.
2572 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2573 term-width)
2575 todo)
2576 (not (eobp)))
2577 (setq todo (- todo H))
2578 (forward-char) ;; Move past the ?\n
2579 (end-of-line)) ;; and on to the end of the next line.
2580 (if (and (>= todo H) (> todo 0))
2581 (+ (- count todo) H -1) ;; Hit end of buffer.
2582 (move-to-column (* todo term-width))
2583 count)))
2584 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2585 (let ((H)
2586 (todo (- count)))
2587 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2588 term-width)
2590 todo)
2591 (progn (beginning-of-line)
2592 (not (bobp))))
2593 (setq todo (- todo H))
2594 (backward-char)) ;; Move to end of previous line.
2595 (if (and (>= todo H) (> todo 0))
2596 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2597 (move-to-column (* (- H todo 1) term-width))
2598 count)))))
2600 ;;; The term-start-line-column variable is used as a cache.
2601 (defun term-start-line-column ()
2602 (cond (term-start-line-column)
2603 ((let ((save-pos (point)))
2604 (term-vertical-motion 0)
2605 (setq term-start-line-column (current-column))
2606 (goto-char save-pos)
2607 term-start-line-column))))
2609 ;;; Same as (current-column), but uses term-current-column as a cache.
2610 (defun term-current-column ()
2611 (cond (term-current-column)
2612 ((setq term-current-column (current-column)))))
2614 ;;; Move DELTA column right (or left if delta < 0 limiting at column 0).
2616 (defun term-move-columns (delta)
2617 (setq term-current-column (max 0 (+ (term-current-column) delta)))
2618 (let (point-at-eol)
2619 (save-excursion
2620 (end-of-line)
2621 (setq point-at-eol (point)))
2622 (move-to-column term-current-column t)
2623 ;; If move-to-column extends the current line it will use the face
2624 ;; from the last character on the line, set the face for the chars
2625 ;; to default.
2626 (when (> (point) point-at-eol)
2627 (put-text-property point-at-eol (point) 'face 'default))))
2629 ;; Insert COUNT copies of CHAR in the default face.
2630 (defun term-insert-char (char count)
2631 (let ((old-point (point)))
2632 (insert-char char count)
2633 (put-text-property old-point (point) 'face 'default)))
2635 (defun term-current-row ()
2636 (cond (term-current-row)
2637 ((setq term-current-row
2638 (save-restriction
2639 (save-excursion
2640 (narrow-to-region term-home-marker (point-max))
2641 (- (term-vertical-motion -9999))))))))
2643 (defun term-adjust-current-row-cache (delta)
2644 (when term-current-row
2645 (setq term-current-row
2646 (max 0 (+ term-current-row delta)))))
2648 (defun term-terminal-pos ()
2649 (save-excursion ; save-restriction
2650 (let ((save-col (term-current-column))
2651 x y)
2652 (term-vertical-motion 0)
2653 (setq x (- save-col (current-column)))
2654 (setq y (term-vertical-motion term-height))
2655 (cons x y))))
2657 ;;;Function that handles term messages: code by rms ( and you can see the
2658 ;;;difference ;-) -mm
2660 (defun term-handle-ansi-terminal-messages (message)
2661 ;; Is there a command here?
2662 (while (string-match "\eAnSiT.+\n" message)
2663 ;; Extract the command code and the argument.
2664 (let* ((start (match-beginning 0))
2665 (end (match-end 0))
2666 (command-code (aref message (+ start 6)))
2667 (argument
2668 (save-match-data
2669 (substring message
2670 (+ start 8)
2671 (string-match "\r?\n" message
2672 (+ start 8)))))
2673 ignore)
2674 ;; Delete this command from MESSAGE.
2675 (setq message (replace-match "" t t message))
2677 ;; If we recognize the type of command, set the appropriate variable.
2678 (cond ((= command-code ?c)
2679 (setq term-ansi-at-dir argument))
2680 ((= command-code ?h)
2681 (setq term-ansi-at-host argument))
2682 ((= command-code ?u)
2683 (setq term-ansi-at-user argument))
2684 ;; Otherwise ignore this one.
2686 (setq ignore t)))
2688 ;; Update default-directory based on the changes this command made.
2689 (if ignore
2691 (setq default-directory
2692 (file-name-as-directory
2693 (if (and (string= term-ansi-at-host (system-name))
2694 (string= term-ansi-at-user (user-real-login-name)))
2695 (expand-file-name term-ansi-at-dir)
2696 (if (string= term-ansi-at-user (user-real-login-name))
2697 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2698 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2699 term-ansi-at-dir)))))
2701 ;; I'm not sure this is necessary,
2702 ;; but it's best to be on the safe side.
2703 (if (string= term-ansi-at-host (system-name))
2704 (progn
2705 (setq ange-ftp-default-user term-ansi-at-save-user)
2706 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2707 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2708 (setq term-ansi-at-save-user ange-ftp-default-user)
2709 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2710 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2711 (setq ange-ftp-default-user nil)
2712 (setq ange-ftp-default-password nil)
2713 (setq ange-ftp-generate-anonymous-password nil)))))
2714 message)
2717 ;;; Terminal emulation
2718 ;;; This is the standard process filter for term buffers.
2719 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2721 (defun term-emulate-terminal (proc str)
2722 (with-current-buffer (process-buffer proc)
2723 (let* ((i 0) char funny
2724 count ; number of decoded chars in substring
2725 count-bytes ; number of bytes
2726 decoded-substring
2727 save-point save-marker old-point temp win
2728 (buffer-undo-list t)
2729 (selected (selected-window))
2730 last-win
2731 handled-ansi-message
2732 (str-length (length str)))
2733 (save-selected-window
2735 ;; Let's handle the messages. -mm
2737 (let* ((newstr (term-handle-ansi-terminal-messages str)))
2738 (when (not (eq str newstr))
2739 (setq handled-ansi-message t
2740 str newstr)))
2741 (setq str-length (length str))
2743 (when (marker-buffer term-pending-delete-marker)
2744 ;; Delete text following term-pending-delete-marker.
2745 (delete-region term-pending-delete-marker (process-mark proc))
2746 (set-marker term-pending-delete-marker nil))
2748 (if (eq (window-buffer) (current-buffer))
2749 (progn
2750 (setq term-vertical-motion (symbol-function 'vertical-motion))
2751 (term-check-size proc))
2752 (setq term-vertical-motion
2753 (symbol-function 'term-buffer-vertical-motion)))
2755 (setq save-marker (copy-marker (process-mark proc)))
2757 (when (/= (point) (process-mark proc))
2758 (setq save-point (point-marker))
2759 (goto-char (process-mark proc)))
2761 (save-restriction
2762 ;; If the buffer is in line mode, and there is a partial
2763 ;; input line, save the line (by narrowing to leave it
2764 ;; outside the restriction ) until we're done with output.
2765 (when (and (> (point-max) (process-mark proc))
2766 (term-in-line-mode))
2767 (narrow-to-region (point-min) (process-mark proc)))
2769 (when term-log-buffer
2770 (princ str term-log-buffer))
2771 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2772 (setq str (concat term-terminal-parameter str))
2773 (setq term-terminal-parameter nil)
2774 (setq str-length (length str))
2775 (setq term-terminal-state 0)))
2777 (while (< i str-length)
2778 (setq char (aref str i))
2779 (cond ((< term-terminal-state 2)
2780 ;; Look for prefix of regular chars
2781 (setq funny
2782 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2783 str i))
2784 (when (not funny) (setq funny str-length))
2785 (cond ((> funny i)
2786 ;; Decode the string before counting
2787 ;; characters, to avoid garbling of certain
2788 ;; multibyte characters (bug#1006).
2789 (setq decoded-substring
2790 (decode-coding-string
2791 (substring str i funny)
2792 locale-coding-system))
2793 (cond ((eq term-terminal-state 1)
2794 ;; We are in state 1, we need to wrap
2795 ;; around. Go to the beginning of
2796 ;; the next line and switch to state
2797 ;; 0.
2798 (term-down 1 t)
2799 (term-move-columns (- (term-current-column)))
2800 (setq term-terminal-state 0)))
2801 (setq count (length decoded-substring))
2802 (setq temp (- (+ (term-horizontal-column) count)
2803 term-width))
2804 (cond ((<= temp 0)) ;; All count chars fit in line.
2805 ((> count temp) ;; Some chars fit.
2806 ;; This iteration, handle only what fits.
2807 (setq count (- count temp))
2808 (setq count-bytes
2809 (length
2810 (encode-coding-string
2811 (substring decoded-substring 0 count)
2812 'binary)))
2813 (setq temp 0)
2814 (setq funny (+ count-bytes i)))
2815 ((or (not (or term-pager-count
2816 term-scroll-with-delete))
2817 (> (term-handle-scroll 1) 0))
2818 (term-adjust-current-row-cache 1)
2819 (setq count (min count term-width))
2820 (setq count-bytes
2821 (length
2822 (encode-coding-string
2823 (substring decoded-substring 0 count)
2824 'binary)))
2825 (setq funny (+ count-bytes i))
2826 (setq term-start-line-column
2827 term-current-column))
2828 (t ;; Doing PAGER processing.
2829 (setq count 0 funny i)
2830 (setq term-current-column nil)
2831 (setq term-start-line-column nil)))
2832 (setq old-point (point))
2834 ;; Insert a string, check how many columns
2835 ;; we moved, then delete that many columns
2836 ;; following point if not eob nor insert-mode.
2837 (let ((old-column (current-column))
2838 columns pos)
2839 (insert (decode-coding-string (substring str i funny) locale-coding-system))
2840 (setq term-current-column (current-column)
2841 columns (- term-current-column old-column))
2842 (when (not (or (eobp) term-insert-mode))
2843 (setq pos (point))
2844 (term-move-columns columns)
2845 (delete-region pos (point)))
2846 ;; In insert mode if the current line
2847 ;; has become too long it needs to be
2848 ;; chopped off.
2849 (when term-insert-mode
2850 (setq pos (point))
2851 (end-of-line)
2852 (when (> (current-column) term-width)
2853 (delete-region (- (point) (- (current-column) term-width))
2854 (point)))
2855 (goto-char pos)))
2856 (setq term-current-column nil)
2858 (put-text-property old-point (point)
2859 'face term-current-face)
2860 ;; If the last char was written in last column,
2861 ;; back up one column, but remember we did so.
2862 ;; Thus we emulate xterm/vt100-style line-wrapping.
2863 (cond ((eq temp 0)
2864 (term-move-columns -1)
2865 (setq term-terminal-state 1)))
2866 (setq i (1- funny)))
2867 ((and (setq term-terminal-state 0)
2868 (eq char ?\^I)) ; TAB (terminfo: ht)
2869 (setq count (term-current-column))
2870 ;; The line cannot exceed term-width. TAB at
2871 ;; the end of a line should not cause wrapping.
2872 (setq count (min term-width
2873 (+ count 8 (- (mod count 8)))))
2874 (if (> term-width count)
2875 (progn
2876 (term-move-columns
2877 (- count (term-current-column)))
2878 (setq term-current-column count))
2879 (when (> term-width (term-current-column))
2880 (term-move-columns
2881 (1- (- term-width (term-current-column)))))
2882 (when (= term-width (term-current-column))
2883 (term-move-columns -1))))
2884 ((eq char ?\r) ;; (terminfo: cr)
2885 (term-vertical-motion 0)
2886 (setq term-current-column term-start-line-column))
2887 ((eq char ?\n) ;; (terminfo: cud1, ind)
2888 (unless (and term-kill-echo-list
2889 (term-check-kill-echo-list))
2890 (term-down 1 t)))
2891 ((eq char ?\b) ;; (terminfo: cub1)
2892 (term-move-columns -1))
2893 ((eq char ?\033) ; Escape
2894 (setq term-terminal-state 2))
2895 ((eq char 0)) ; NUL: Do nothing
2896 ((eq char ?\016)) ; Shift Out - ignored
2897 ((eq char ?\017)) ; Shift In - ignored
2898 ((eq char ?\^G) ;; (terminfo: bel)
2899 (beep t))
2900 ((and (eq char ?\032)
2901 (not handled-ansi-message))
2902 (let ((end (string-match "\r?$" str i)))
2903 (if end
2904 (funcall term-command-hook
2905 (prog1 (substring str (1+ i) end)
2906 (setq i (match-end 0))))
2907 (setq term-terminal-parameter (substring str i))
2908 (setq term-terminal-state 4)
2909 (setq i str-length))))
2910 (t ; insert char FIXME: Should never happen
2911 (term-move-columns 1)
2912 (backward-delete-char 1)
2913 (insert char))))
2914 ((eq term-terminal-state 2) ; Seen Esc
2915 (cond ((eq char ?\133) ;; ?\133 = ?[
2917 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2918 ;;; Note that now the init value of term-terminal-previous-parameter has
2919 ;;; been changed to -1
2921 (setq term-terminal-parameter 0)
2922 (setq term-terminal-previous-parameter -1)
2923 (setq term-terminal-previous-parameter-2 -1)
2924 (setq term-terminal-previous-parameter-3 -1)
2925 (setq term-terminal-previous-parameter-4 -1)
2926 (setq term-terminal-more-parameters 0)
2927 (setq term-terminal-state 3))
2928 ((eq char ?D) ;; scroll forward
2929 (term-handle-deferred-scroll)
2930 (term-down 1 t)
2931 (setq term-terminal-state 0))
2932 ;; ((eq char ?E) ;; (terminfo: nw), not used for
2933 ;; ;; now, but this is a working
2934 ;; ;; implementation
2935 ;; (term-down 1)
2936 ;; (term-goto term-current-row 0)
2937 ;; (setq term-terminal-state 0))
2938 ((eq char ?M) ;; scroll reversed (terminfo: ri)
2939 (if (or (< (term-current-row) term-scroll-start)
2940 (>= (1- (term-current-row))
2941 term-scroll-start))
2942 ;; Scrolling up will not move outside
2943 ;; the scroll region.
2944 (term-down -1)
2945 ;; Scrolling the scroll region is needed.
2946 (term-down -1 t))
2947 (setq term-terminal-state 0))
2948 ((eq char ?7) ;; Save cursor (terminfo: sc)
2949 (term-handle-deferred-scroll)
2950 (setq term-saved-cursor
2951 (list (term-current-row)
2952 (term-horizontal-column)
2953 term-ansi-current-bg-color
2954 term-ansi-current-bold
2955 term-ansi-current-color
2956 term-ansi-current-invisible
2957 term-ansi-current-reverse
2958 term-ansi-current-underline
2959 term-current-face)
2961 (setq term-terminal-state 0))
2962 ((eq char ?8) ;; Restore cursor (terminfo: rc)
2963 (when term-saved-cursor
2964 (term-goto (nth 0 term-saved-cursor)
2965 (nth 1 term-saved-cursor))
2966 (setq term-ansi-current-bg-color
2967 (nth 2 term-saved-cursor)
2968 term-ansi-current-bold
2969 (nth 3 term-saved-cursor)
2970 term-ansi-current-color
2971 (nth 4 term-saved-cursor)
2972 term-ansi-current-invisible
2973 (nth 5 term-saved-cursor)
2974 term-ansi-current-reverse
2975 (nth 6 term-saved-cursor)
2976 term-ansi-current-underline
2977 (nth 7 term-saved-cursor)
2978 term-current-face
2979 (nth 8 term-saved-cursor)))
2980 (setq term-terminal-state 0))
2981 ((eq char ?c) ;; \Ec - Reset (terminfo: rs1)
2982 ;; This is used by the "clear" program.
2983 (setq term-terminal-state 0)
2984 (term-reset-terminal))
2985 ;; The \E#8 reset sequence for xterm. We
2986 ;; probably don't need to handle it, but this
2987 ;; is the code to parse it.
2988 ;; ((eq char ?#)
2989 ;; (when (eq (aref str (1+ i)) ?8)
2990 ;; (setq i (1+ i))
2991 ;; (setq term-scroll-start 0)
2992 ;; (setq term-scroll-end term-height)
2993 ;; (setq term-terminal-state 0)))
2994 ((setq term-terminal-state 0))))
2995 ((eq term-terminal-state 3) ; Seen Esc [
2996 (cond ((and (>= char ?0) (<= char ?9))
2997 (setq term-terminal-parameter
2998 (+ (* 10 term-terminal-parameter) (- char ?0))))
2999 ((eq char ?\;)
3000 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
3001 (setq term-terminal-more-parameters 1)
3002 (setq term-terminal-previous-parameter-4
3003 term-terminal-previous-parameter-3)
3004 (setq term-terminal-previous-parameter-3
3005 term-terminal-previous-parameter-2)
3006 (setq term-terminal-previous-parameter-2
3007 term-terminal-previous-parameter)
3008 (setq term-terminal-previous-parameter
3009 term-terminal-parameter)
3010 (setq term-terminal-parameter 0))
3011 ((eq char ??)) ; Ignore ?
3013 (term-handle-ansi-escape proc char)
3014 (setq term-terminal-more-parameters 0)
3015 (setq term-terminal-previous-parameter-4 -1)
3016 (setq term-terminal-previous-parameter-3 -1)
3017 (setq term-terminal-previous-parameter-2 -1)
3018 (setq term-terminal-previous-parameter -1)
3019 (setq term-terminal-state 0)))))
3020 (when (term-handling-pager)
3021 ;; Finish stuff to get ready to handle PAGER.
3022 (if (> (% (current-column) term-width) 0)
3023 (setq term-terminal-parameter
3024 (substring str i))
3025 ;; We're at column 0. Goto end of buffer; to compensate,
3026 ;; prepend a ?\r for later. This looks more consistent.
3027 (if (zerop i)
3028 (setq term-terminal-parameter
3029 (concat "\r" (substring str i)))
3030 (setq term-terminal-parameter (substring str (1- i)))
3031 (aset term-terminal-parameter 0 ?\r))
3032 (goto-char (point-max)))
3033 (setq term-terminal-state 4)
3034 (make-local-variable 'term-pager-old-filter)
3035 (setq term-pager-old-filter (process-filter proc))
3036 (set-process-filter proc term-pager-filter)
3037 (setq i str-length))
3038 (setq i (1+ i))))
3040 (when (>= (term-current-row) term-height)
3041 (term-handle-deferred-scroll))
3043 (set-marker (process-mark proc) (point))
3044 (when save-point
3045 (goto-char save-point)
3046 (set-marker save-point nil))
3048 ;; Check for a pending filename-and-line number to display.
3049 ;; We do this before scrolling, because we might create a new window.
3050 (when (and term-pending-frame
3051 (eq (window-buffer selected) (current-buffer)))
3052 (term-display-line (car term-pending-frame)
3053 (cdr term-pending-frame))
3054 (setq term-pending-frame nil)
3055 ;; We have created a new window, so check the window size.
3056 (term-check-size proc))
3058 ;; Scroll each window displaying the buffer but (by default)
3059 ;; only if the point matches the process-mark we started with.
3060 (setq win selected)
3061 ;; Avoid infinite loop in strange case where minibuffer window
3062 ;; is selected but not active.
3063 (while (window-minibuffer-p win)
3064 (setq win (next-window win nil t)))
3065 (setq last-win win)
3066 (while (progn
3067 (setq win (next-window win nil t))
3068 (when (eq (window-buffer win) (process-buffer proc))
3069 (let ((scroll term-scroll-to-bottom-on-output))
3070 (select-window win)
3071 (when (or (= (point) save-marker)
3072 (eq scroll t) (eq scroll 'all)
3073 ;; Maybe user wants point to jump to the end.
3074 (and (eq selected win)
3075 (or (eq scroll 'this) (not save-point)))
3076 (and (eq scroll 'others)
3077 (not (eq selected win))))
3078 (goto-char term-home-marker)
3079 (recenter 0)
3080 (goto-char (process-mark proc))
3081 (if (not (pos-visible-in-window-p (point) win))
3082 (recenter -1)))
3083 ;; Optionally scroll so that the text
3084 ;; ends at the bottom of the window.
3085 (when (and term-scroll-show-maximum-output
3086 (>= (point) (process-mark proc)))
3087 (save-excursion
3088 (goto-char (point-max))
3089 (recenter -1)))))
3090 (not (eq win last-win))))
3092 ;;; Stolen from comint.el and adapted -mm
3093 (when (> term-buffer-maximum-size 0)
3094 (save-excursion
3095 (goto-char (process-mark (get-buffer-process (current-buffer))))
3096 (forward-line (- term-buffer-maximum-size))
3097 (beginning-of-line)
3098 (delete-region (point-min) (point))))
3099 (set-marker save-marker nil)))
3100 ;; This might be expensive, but we need it to handle something
3101 ;; like `sleep 5 | less -c' in more-or-less real time.
3102 (when (get-buffer-window (current-buffer))
3103 (redisplay))))
3105 (defun term-handle-deferred-scroll ()
3106 (let ((count (- (term-current-row) term-height)))
3107 (when (>= count 0)
3108 (save-excursion
3109 (goto-char term-home-marker)
3110 (term-vertical-motion (1+ count))
3111 (set-marker term-home-marker (point))
3112 (setq term-current-row (1- term-height))))))
3114 ;;; Reset the terminal, delete all the content and set the face to the
3115 ;;; default one.
3116 (defun term-reset-terminal ()
3117 (erase-buffer)
3118 (setq term-current-row 0)
3119 (setq term-current-column 1)
3120 (setq term-scroll-start 0)
3121 (setq term-scroll-end term-height)
3122 (setq term-insert-mode nil)
3123 (setq term-current-face (list :background term-default-bg-color
3124 :foreground term-default-fg-color))
3125 (setq term-ansi-current-underline nil)
3126 (setq term-ansi-current-bold nil)
3127 (setq term-ansi-current-reverse nil)
3128 (setq term-ansi-current-color 0)
3129 (setq term-ansi-current-invisible nil)
3130 (setq term-ansi-face-already-done nil)
3131 (setq term-ansi-current-bg-color 0))
3133 ;;; New function to deal with ansi colorized output, as you can see you can
3134 ;;; have any bold/underline/fg/bg/reverse combination. -mm
3136 (defun term-handle-colors-array (parameter)
3137 (cond
3139 ;;; Bold (terminfo: bold)
3140 ((eq parameter 1)
3141 (setq term-ansi-current-bold t))
3143 ;;; Underline
3144 ((eq parameter 4)
3145 (setq term-ansi-current-underline t))
3147 ;;; Blink (unsupported by Emacs), will be translated to bold.
3148 ;;; This may change in the future though.
3149 ((eq parameter 5)
3150 (setq term-ansi-current-bold t))
3152 ;;; Reverse (terminfo: smso)
3153 ((eq parameter 7)
3154 (setq term-ansi-current-reverse t))
3156 ;;; Invisible
3157 ((eq parameter 8)
3158 (setq term-ansi-current-invisible t))
3160 ;;; Reset underline (terminfo: rmul)
3161 ((eq parameter 24)
3162 (setq term-ansi-current-underline nil))
3164 ;;; Reset reverse (terminfo: rmso)
3165 ((eq parameter 27)
3166 (setq term-ansi-current-reverse nil))
3168 ;;; Foreground
3169 ((and (>= parameter 30) (<= parameter 37))
3170 (setq term-ansi-current-color (- parameter 29)))
3172 ;;; Reset foreground
3173 ((eq parameter 39)
3174 (setq term-ansi-current-color 0))
3176 ;;; Background
3177 ((and (>= parameter 40) (<= parameter 47))
3178 (setq term-ansi-current-bg-color (- parameter 39)))
3180 ;;; Reset background
3181 ((eq parameter 49)
3182 (setq term-ansi-current-bg-color 0))
3184 ;;; 0 (Reset) or unknown (reset anyway)
3186 (setq term-current-face (list :background term-default-bg-color
3187 :foreground term-default-fg-color))
3188 (setq term-ansi-current-underline nil)
3189 (setq term-ansi-current-bold nil)
3190 (setq term-ansi-current-reverse nil)
3191 (setq term-ansi-current-color 0)
3192 (setq term-ansi-current-invisible nil)
3193 (setq term-ansi-face-already-done t)
3194 (setq term-ansi-current-bg-color 0)))
3196 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3197 ; term-ansi-current-underline
3198 ; term-ansi-current-reverse
3199 ; term-ansi-current-bold
3200 ; term-ansi-current-invisible
3201 ; term-ansi-face-already-done
3202 ; term-ansi-current-color
3203 ; term-ansi-current-bg-color)
3206 (unless term-ansi-face-already-done
3207 (if term-ansi-current-reverse
3208 (if term-ansi-current-invisible
3209 (setq term-current-face
3210 (if (= term-ansi-current-color 0)
3211 (list :background
3212 term-default-fg-color
3213 :foreground
3214 term-default-fg-color)
3215 (list :background
3216 (elt ansi-term-color-vector term-ansi-current-color)
3217 :foreground
3218 (elt ansi-term-color-vector term-ansi-current-color)))
3219 ;; No need to bother with anything else if it's invisible
3221 (setq term-current-face
3222 (list :background
3223 (if (= term-ansi-current-color 0)
3224 term-default-fg-color
3225 (elt ansi-term-color-vector term-ansi-current-color))
3226 :foreground
3227 (if (= term-ansi-current-bg-color 0)
3228 term-default-bg-color
3229 (elt ansi-term-color-vector term-ansi-current-bg-color))))
3230 (when term-ansi-current-bold
3231 (setq term-current-face
3232 (append '(:weight bold) term-current-face)))
3233 (when term-ansi-current-underline
3234 (setq term-current-face
3235 (append '(:underline t) term-current-face))))
3236 (if term-ansi-current-invisible
3237 (setq term-current-face
3238 (if (= term-ansi-current-bg-color 0)
3239 (list :background
3240 term-default-bg-color
3241 :foreground
3242 term-default-bg-color)
3243 (list :foreground
3244 (elt ansi-term-color-vector term-ansi-current-bg-color)
3245 :background
3246 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3247 ;; No need to bother with anything else if it's invisible
3249 (setq term-current-face
3250 (list :foreground
3251 (if (= term-ansi-current-color 0)
3252 term-default-fg-color
3253 (elt ansi-term-color-vector term-ansi-current-color))
3254 :background
3255 (if (= term-ansi-current-bg-color 0)
3256 term-default-bg-color
3257 (elt ansi-term-color-vector term-ansi-current-bg-color))))
3258 (when term-ansi-current-bold
3259 (setq term-current-face
3260 (append '(:weight bold) term-current-face)))
3261 (when term-ansi-current-underline
3262 (setq term-current-face
3263 (append '(:underline t) term-current-face))))))
3265 ;;; (message "Debug %S" term-current-face)
3266 (setq term-ansi-face-already-done nil))
3269 ;;; Handle a character assuming (eq terminal-state 2) -
3270 ;;; i.e. we have previously seen Escape followed by ?[.
3272 (defun term-handle-ansi-escape (proc char)
3273 (cond
3274 ((or (eq char ?H) ;; cursor motion (terminfo: cup,home)
3275 ;; (eq char ?f) ;; xterm seems to handle this sequence too, not
3276 ;; needed for now
3278 (when (<= term-terminal-parameter 0)
3279 (setq term-terminal-parameter 1))
3280 (when (<= term-terminal-previous-parameter 0)
3281 (setq term-terminal-previous-parameter 1))
3282 (when (> term-terminal-previous-parameter term-height)
3283 (setq term-terminal-previous-parameter term-height))
3284 (when (> term-terminal-parameter term-width)
3285 (setq term-terminal-parameter term-width))
3286 (term-goto
3287 (1- term-terminal-previous-parameter)
3288 (1- term-terminal-parameter)))
3289 ;; \E[A - cursor up (terminfo: cuu, cuu1)
3290 ((eq char ?A)
3291 (term-handle-deferred-scroll)
3292 (let ((tcr (term-current-row)))
3293 (term-down
3294 (if (< (- tcr term-terminal-parameter) term-scroll-start)
3295 ;; If the amount to move is before scroll start, move
3296 ;; to scroll start.
3297 (- term-scroll-start tcr)
3298 (if (>= term-terminal-parameter tcr)
3299 (- tcr)
3300 (- (max 1 term-terminal-parameter)))) t)))
3301 ;; \E[B - cursor down (terminfo: cud)
3302 ((eq char ?B)
3303 (let ((tcr (term-current-row)))
3304 (unless (= tcr (1- term-scroll-end))
3305 (term-down
3306 (if (> (+ tcr term-terminal-parameter) term-scroll-end)
3307 (- term-scroll-end 1 tcr)
3308 (max 1 term-terminal-parameter)) t))))
3309 ;; \E[C - cursor right (terminfo: cuf, cuf1)
3310 ((eq char ?C)
3311 (term-move-columns
3312 (max 1
3313 (if (>= (+ term-terminal-parameter (term-current-column)) term-width)
3314 (- term-width (term-current-column) 1)
3315 term-terminal-parameter))))
3316 ;; \E[D - cursor left (terminfo: cub)
3317 ((eq char ?D)
3318 (term-move-columns (- (max 1 term-terminal-parameter))))
3319 ;; \E[J - clear to end of screen (terminfo: ed, clear)
3320 ((eq char ?J)
3321 (term-erase-in-display term-terminal-parameter))
3322 ;; \E[K - clear to end of line (terminfo: el, el1)
3323 ((eq char ?K)
3324 (term-erase-in-line term-terminal-parameter))
3325 ;; \E[L - insert lines (terminfo: il, il1)
3326 ((eq char ?L)
3327 (term-insert-lines (max 1 term-terminal-parameter)))
3328 ;; \E[M - delete lines (terminfo: dl, dl1)
3329 ((eq char ?M)
3330 (term-delete-lines (max 1 term-terminal-parameter)))
3331 ;; \E[P - delete chars (terminfo: dch, dch1)
3332 ((eq char ?P)
3333 (term-delete-chars (max 1 term-terminal-parameter)))
3334 ;; \E[@ - insert spaces (terminfo: ich)
3335 ((eq char ?@)
3336 (term-insert-spaces (max 1 term-terminal-parameter)))
3337 ;; \E[?h - DEC Private Mode Set
3338 ((eq char ?h)
3339 (cond ((eq term-terminal-parameter 4) ;; (terminfo: smir)
3340 (setq term-insert-mode t))
3341 ;; ((eq term-terminal-parameter 47) ;; (terminfo: smcup)
3342 ;; (term-switch-to-alternate-sub-buffer t))
3344 ;; \E[?l - DEC Private Mode Reset
3345 ((eq char ?l)
3346 (cond ((eq term-terminal-parameter 4) ;; (terminfo: rmir)
3347 (setq term-insert-mode nil))
3348 ;; ((eq term-terminal-parameter 47) ;; (terminfo: rmcup)
3349 ;; (term-switch-to-alternate-sub-buffer nil))
3352 ;;; Modified to allow ansi coloring -mm
3353 ;; \E[m - Set/reset modes, set bg/fg
3354 ;;(terminfo: smso,rmso,smul,rmul,rev,bold,sgr0,invis,op,setab,setaf)
3355 ((eq char ?m)
3356 (when (= term-terminal-more-parameters 1)
3357 (when (>= term-terminal-previous-parameter-4 0)
3358 (term-handle-colors-array term-terminal-previous-parameter-4))
3359 (when (>= term-terminal-previous-parameter-3 0)
3360 (term-handle-colors-array term-terminal-previous-parameter-3))
3361 (when (>= term-terminal-previous-parameter-2 0)
3362 (term-handle-colors-array term-terminal-previous-parameter-2))
3363 (term-handle-colors-array term-terminal-previous-parameter))
3364 (term-handle-colors-array term-terminal-parameter))
3366 ;; \E[6n - Report cursor position
3367 ((eq char ?n)
3368 (term-handle-deferred-scroll)
3369 (process-send-string proc
3370 (format "\e[%s;%sR"
3371 (1+ (term-current-row))
3372 (1+ (term-horizontal-column)))))
3373 ;; \E[r - Set scrolling region (terminfo: csr)
3374 ((eq char ?r)
3375 (term-set-scroll-region
3376 (1- term-terminal-previous-parameter)
3377 (1- term-terminal-parameter)))
3378 (t)))
3380 (defun term-set-scroll-region (top bottom)
3381 "Set scrolling region.
3382 TOP is the top-most line (inclusive) of the new scrolling region,
3383 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3384 The top-most line is line 0."
3385 (setq term-scroll-start
3386 (if (or (< top 0) (>= top term-height))
3388 top))
3389 (setq term-scroll-end
3390 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3391 term-height
3392 bottom))
3393 (setq term-scroll-with-delete
3394 (or (term-using-alternate-sub-buffer)
3395 (not (and (= term-scroll-start 0)
3396 (= term-scroll-end term-height)))))
3397 (term-move-columns (- (term-current-column)))
3398 (term-goto 0 0))
3400 ;; (defun term-switch-to-alternate-sub-buffer (set)
3401 ;; ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3402 ;; ;; using it, do nothing. This test is needed for some programs (including
3403 ;; ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3404 ;; (term-handle-deferred-scroll)
3405 ;; (if (eq set (not (term-using-alternate-sub-buffer)))
3406 ;; (let ((row (term-current-row))
3407 ;; (col (term-horizontal-column)))
3408 ;; (cond (set
3409 ;; (goto-char (point-max))
3410 ;; (if (not (eq (preceding-char) ?\n))
3411 ;; (term-insert-char ?\n 1))
3412 ;; (setq term-scroll-with-delete t)
3413 ;; (setq term-saved-home-marker (copy-marker term-home-marker))
3414 ;; (set-marker term-home-marker (point)))
3415 ;; (t
3416 ;; (setq term-scroll-with-delete
3417 ;; (not (and (= term-scroll-start 0)
3418 ;; (= term-scroll-end term-height))))
3419 ;; (set-marker term-home-marker term-saved-home-marker)
3420 ;; (set-marker term-saved-home-marker nil)
3421 ;; (setq term-saved-home-marker nil)
3422 ;; (goto-char term-home-marker)))
3423 ;; (setq term-current-column nil)
3424 ;; (setq term-current-row 0)
3425 ;; (term-goto row col))))
3427 ;; Default value for the symbol term-command-hook.
3429 (defun term-command-hook (string)
3430 (cond ((equal string "")
3432 ((= (aref string 0) ?\032)
3433 ;; gdb (when invoked with -fullname) prints:
3434 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3435 (let* ((first-colon (string-match ":" string 1))
3436 (second-colon
3437 (string-match ":" string (1+ first-colon)))
3438 (filename (substring string 1 first-colon))
3439 (fileline (string-to-number
3440 (substring string (1+ first-colon) second-colon))))
3441 (setq term-pending-frame (cons filename fileline))))
3442 ((= (aref string 0) ?/)
3443 (cd (substring string 1)))
3444 ;; Allowing the inferior to call functions in Emacs is
3445 ;; probably too big a security hole.
3446 ;; ((= (aref string 0) ?!)
3447 ;; (eval (car (read-from-string string 1))))
3448 (t)));; Otherwise ignore it
3450 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3451 ;; and that its line LINE is visible.
3452 ;; Put the overlay-arrow on the line LINE in that buffer.
3453 ;; This is mainly used by gdb.
3455 (defun term-display-line (true-file line)
3456 (term-display-buffer-line (find-file-noselect true-file) line))
3458 (defun term-display-buffer-line (buffer line)
3459 (let* ((window (display-buffer buffer t))
3460 (pos))
3461 (save-excursion
3462 (set-buffer buffer)
3463 (save-restriction
3464 (widen)
3465 (goto-line line)
3466 (setq pos (point))
3467 (setq overlay-arrow-string "=>")
3468 (or overlay-arrow-position
3469 (setq overlay-arrow-position (make-marker)))
3470 (set-marker overlay-arrow-position (point) (current-buffer)))
3471 (cond ((or (< pos (point-min)) (> pos (point-max)))
3472 (widen)
3473 (goto-char pos))))
3474 (set-window-point window overlay-arrow-position)))
3476 ;;; The buffer-local marker term-home-marker defines the "home position"
3477 ;;; (in terms of cursor motion). However, we move the term-home-marker
3478 ;;; "down" as needed so that is no more that a window-full above (point-max).
3480 (defun term-goto-home ()
3481 (term-handle-deferred-scroll)
3482 (goto-char term-home-marker)
3483 (setq term-current-row 0)
3484 (setq term-current-column (current-column))
3485 (setq term-start-line-column term-current-column))
3487 (defun term-goto (row col)
3488 (term-handle-deferred-scroll)
3489 (cond ((and term-current-row (>= row term-current-row))
3490 ;; I assume this is a worthwhile optimization.
3491 (term-vertical-motion 0)
3492 (setq term-current-column term-start-line-column)
3493 (setq row (- row term-current-row)))
3495 (term-goto-home)))
3496 (term-down row)
3497 (term-move-columns col))
3499 ; The page is full, so enter "pager" mode, and wait for input.
3501 (defun term-process-pager ()
3502 (when (not term-pager-break-map)
3503 (let* ((map (make-keymap))
3504 (i 0) tmp)
3505 ; (while (< i 128)
3506 ; (define-key map (make-string 1 i) 'term-send-raw)
3507 ; (setq i (1+ i)))
3508 (define-key map "\e"
3509 (lookup-key (current-global-map) "\e"))
3510 (define-key map "\C-x"
3511 (lookup-key (current-global-map) "\C-x"))
3512 (define-key map "\C-u"
3513 (lookup-key (current-global-map) "\C-u"))
3514 (define-key map " " 'term-pager-page)
3515 (define-key map "\r" 'term-pager-line)
3516 (define-key map "?" 'term-pager-help)
3517 (define-key map "h" 'term-pager-help)
3518 (define-key map "b" 'term-pager-back-page)
3519 (define-key map "\177" 'term-pager-back-line)
3520 (define-key map "q" 'term-pager-discard)
3521 (define-key map "D" 'term-pager-disable)
3522 (define-key map "<" 'term-pager-bob)
3523 (define-key map ">" 'term-pager-eob)
3525 ;; Add menu bar.
3526 (unless (featurep 'xemacs)
3527 (define-key map [menu-bar terminal] term-terminal-menu)
3528 (define-key map [menu-bar signals] term-signals-menu)
3529 (setq tmp (make-sparse-keymap "More pages?"))
3530 (define-key tmp [help] '("Help" . term-pager-help))
3531 (define-key tmp [disable]
3532 '("Disable paging" . term-fake-pager-disable))
3533 (define-key tmp [discard]
3534 '("Discard remaining output" . term-pager-discard))
3535 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3536 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3537 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3538 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3539 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3540 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3541 (define-key map [menu-bar page] (cons "More pages?" tmp))
3544 (setq term-pager-break-map map)))
3545 ; (let ((process (get-buffer-process (current-buffer))))
3546 ; (stop-process process))
3547 (setq term-pager-old-local-map (current-local-map))
3548 (use-local-map term-pager-break-map)
3549 (make-local-variable 'term-old-mode-line-format)
3550 (setq term-old-mode-line-format mode-line-format)
3551 (setq mode-line-format
3552 (list "-- **MORE** "
3553 mode-line-buffer-identification
3554 " [Type ? for help] "
3555 "%-"))
3556 (force-mode-line-update))
3558 (defun term-pager-line (lines)
3559 (interactive "p")
3560 (let* ((moved (vertical-motion (1+ lines)))
3561 (deficit (- lines moved)))
3562 (when (> moved lines)
3563 (backward-char))
3564 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3565 (recenter (1- term-height)))
3566 ((term-pager-continue deficit)))))
3568 (defun term-pager-page (arg)
3569 "Proceed past the **MORE** break, allowing the next page of output to appear."
3570 (interactive "p")
3571 (term-pager-line (* arg term-height)))
3573 ; Pager mode command to go to beginning of buffer
3574 (defun term-pager-bob ()
3575 (interactive)
3576 (goto-char (point-min))
3577 (when (= (vertical-motion term-height) term-height)
3578 (backward-char))
3579 (recenter (1- term-height)))
3581 ; pager mode command to go to end of buffer
3582 (defun term-pager-eob ()
3583 (interactive)
3584 (goto-char term-home-marker)
3585 (recenter 0)
3586 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3588 (defun term-pager-back-line (lines)
3589 (interactive "p")
3590 (vertical-motion (- 1 lines))
3591 (if (not (bobp))
3592 (backward-char)
3593 (beep)
3594 ;; Move cursor to end of window.
3595 (vertical-motion term-height)
3596 (backward-char))
3597 (recenter (1- term-height)))
3599 (defun term-pager-back-page (arg)
3600 (interactive "p")
3601 (term-pager-back-line (* arg term-height)))
3603 (defun term-pager-discard ()
3604 (interactive)
3605 (setq term-terminal-parameter "")
3606 (interrupt-process nil t)
3607 (term-pager-continue term-height))
3609 ; Disable pager processing.
3610 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3611 (defun term-pager-disable ()
3612 (interactive)
3613 (if (term-handling-pager)
3614 (term-pager-continue nil)
3615 (setq term-pager-count nil))
3616 (term-update-mode-line))
3618 ; Enable pager processing.
3619 (defun term-pager-enable ()
3620 (interactive)
3621 (or (term-pager-enabled)
3622 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3623 (term-update-mode-line))
3625 (defun term-pager-toggle ()
3626 (interactive)
3627 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3629 (unless (featurep 'xemacs)
3630 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3631 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3632 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3633 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3634 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3635 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3637 (defun term-pager-help ()
3638 "Provide help on commands available in a terminal-emulator **MORE** break."
3639 (interactive)
3640 (message "Terminal-emulator pager break help...")
3641 (sit-for 0)
3642 (with-electric-help
3643 (function (lambda ()
3644 (princ (substitute-command-keys
3645 "\\<term-pager-break-map>\
3646 Terminal-emulator MORE break.\n\
3647 Type one of the following keys:\n\n\
3648 \\[term-pager-page]\t\tMove forward one page.\n\
3649 \\[term-pager-line]\t\tMove forward one line.\n\
3650 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3651 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3652 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3653 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3654 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3655 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3656 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3657 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3658 \\{term-pager-break-map}\n\
3659 Any other key is passed through to the program
3660 running under the terminal emulator and disables pager processing until
3661 all pending output has been dealt with."))
3662 nil))))
3664 (defun term-pager-continue (new-count)
3665 (let ((process (get-buffer-process (current-buffer))))
3666 (use-local-map term-pager-old-local-map)
3667 (setq term-pager-old-local-map nil)
3668 (setq mode-line-format term-old-mode-line-format)
3669 (force-mode-line-update)
3670 (setq term-pager-count new-count)
3671 (set-process-filter process term-pager-old-filter)
3672 (funcall term-pager-old-filter process "")
3673 (continue-process process)))
3675 ;; Make sure there are DOWN blank lines below the current one.
3676 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3678 (defun term-handle-scroll (down)
3679 (let ((scroll-needed
3680 (- (+ (term-current-row) down)
3681 (if (< down 0) term-scroll-start term-scroll-end))))
3682 (when (or (and (< down 0) (< scroll-needed 0))
3683 (and (> down 0) (> scroll-needed 0)))
3684 (let ((save-point (copy-marker (point))) (save-top))
3685 (goto-char term-home-marker)
3686 (cond (term-scroll-with-delete
3687 (if (< down 0)
3688 (progn
3689 ;; Delete scroll-needed lines at term-scroll-end,
3690 ;; then insert scroll-needed lines.
3691 (term-vertical-motion term-scroll-end)
3692 (end-of-line)
3693 (setq save-top (point))
3694 (term-vertical-motion scroll-needed)
3695 (end-of-line)
3696 (delete-region save-top (point))
3697 (goto-char save-point)
3698 (setq down (- scroll-needed down))
3699 (term-vertical-motion down))
3700 ;; Delete scroll-needed lines at term-scroll-start.
3701 (term-vertical-motion term-scroll-start)
3702 (setq save-top (point))
3703 (term-vertical-motion scroll-needed)
3704 (delete-region save-top (point))
3705 (goto-char save-point)
3706 (term-vertical-motion down)
3707 (term-adjust-current-row-cache (- scroll-needed)))
3708 (setq term-current-column nil)
3709 (term-insert-char ?\n (abs scroll-needed)))
3710 ((and (numberp term-pager-count)
3711 (< (setq term-pager-count (- term-pager-count down))
3713 (setq down 0)
3714 (term-process-pager))
3716 (term-adjust-current-row-cache (- scroll-needed))
3717 (term-vertical-motion scroll-needed)
3718 (set-marker term-home-marker (point))))
3719 (goto-char save-point)
3720 (set-marker save-point nil))))
3721 down)
3723 (defun term-down (down &optional check-for-scroll)
3724 "Move down DOWN screen lines vertically."
3725 (let ((start-column (term-horizontal-column)))
3726 (when (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3727 (setq down (term-handle-scroll down)))
3728 (unless (and (= term-current-row 0) (< down 0))
3729 (term-adjust-current-row-cache down)
3730 (when (or (/= (point) (point-max)) (< down 0))
3731 (setq down (- down (term-vertical-motion down)))))
3732 (cond ((>= down 0)
3733 ;; Extend buffer with extra blank lines if needed.
3734 (term-insert-char ?\n down)
3735 (setq term-current-column 0)
3736 (setq term-start-line-column 0))
3738 (when (= term-current-row 0)
3739 ;; Insert lines if at the beginning.
3740 (save-excursion (term-insert-char ?\n (- down)))
3741 (save-excursion
3742 (let (p)
3743 ;; Delete lines from the end.
3744 (forward-line term-height)
3745 (setq p (point))
3746 (forward-line (- down))
3747 (delete-region p (point)))))
3748 (setq term-current-column 0)
3749 (setq term-start-line-column (current-column))))
3750 (when start-column
3751 (term-move-columns start-column))))
3753 ;; Assuming point is at the beginning of a screen line,
3754 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3755 ;; FIXME: Probably should be called more than it is.
3756 (defun term-unwrap-line ()
3757 (when (not (bolp)) (insert-before-markers ?\n)))
3759 (defun term-erase-in-line (kind)
3760 (when (= kind 1) ;; erase left of point
3761 (let ((cols (term-horizontal-column)) (saved-point (point)))
3762 (term-vertical-motion 0)
3763 (delete-region (point) saved-point)
3764 (term-insert-char ? cols)))
3765 (when (not (eq kind 1)) ;; erase right of point
3766 (let ((saved-point (point))
3767 (wrapped (and (zerop (term-horizontal-column))
3768 (not (zerop (term-current-column))))))
3769 (term-vertical-motion 1)
3770 (delete-region saved-point (point))
3771 ;; wrapped is true if we're at the beginning of screen line,
3772 ;; but not a buffer line. If we delete the current screen line
3773 ;; that will make the previous line no longer wrap, and (because
3774 ;; of the way Emacs display works) point will be at the end of
3775 ;; the previous screen line rather then the beginning of the
3776 ;; current one. To avoid that, we make sure that current line
3777 ;; contain a space, to force the previous line to continue to wrap.
3778 ;; We could do this always, but it seems preferable to not add the
3779 ;; extra space when wrapped is false.
3780 (when wrapped
3781 (insert ? ))
3782 (insert ?\n)
3783 (put-text-property saved-point (point) 'face 'default)
3784 (goto-char saved-point))))
3786 (defun term-erase-in-display (kind)
3787 "Erases (that is blanks out) part of the window.
3788 If KIND is 0, erase from (point) to (point-max);
3789 if KIND is 1, erase from home to point; else erase from home to point-max."
3790 (term-handle-deferred-scroll)
3791 (cond ((eq term-terminal-parameter 0)
3792 (let ((need-unwrap (bolp)))
3793 (delete-region (point) (point-max))
3794 (when need-unwrap (term-unwrap-line))))
3795 ((let ((row (term-current-row))
3796 (col (term-horizontal-column))
3797 (start-region term-home-marker)
3798 (end-region (if (eq kind 1) (point) (point-max))))
3799 (delete-region start-region end-region)
3800 (term-unwrap-line)
3801 (when (eq kind 1)
3802 (term-insert-char ?\n row))
3803 (setq term-current-column nil)
3804 (setq term-current-row nil)
3805 (term-goto row col)))))
3807 (defun term-delete-chars (count)
3808 (let ((save-point (point)))
3809 (term-vertical-motion 1)
3810 (term-unwrap-line)
3811 (goto-char save-point)
3812 (move-to-column (+ (term-current-column) count) t)
3813 (delete-region save-point (point))))
3815 ;;; Insert COUNT spaces after point, but do not change any of
3816 ;;; following screen lines. Hence we may have to delete characters
3817 ;;; at the end of this screen line to make room.
3819 (defun term-insert-spaces (count)
3820 (let ((save-point (point)) (save-eol) (pnt-at-eol))
3821 (term-vertical-motion 1)
3822 (when (bolp)
3823 (backward-char))
3824 (setq save-eol (point))
3825 (save-excursion
3826 (end-of-line)
3827 (setq pnt-at-eol (point)))
3828 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3829 ;; If move-to-column extends the current line it will use the face
3830 ;; from the last character on the line, set the face for the chars
3831 ;; to default.
3832 (when (>= (point) pnt-at-eol)
3833 (put-text-property pnt-at-eol (point) 'face 'default))
3834 (when (> save-eol (point))
3835 (delete-region (point) save-eol))
3836 (goto-char save-point)
3837 (term-insert-char ? count)
3838 (goto-char save-point)))
3840 (defun term-delete-lines (lines)
3841 (let ((start (point))
3842 (save-current-column term-current-column)
3843 (save-start-line-column term-start-line-column)
3844 (save-current-row (term-current-row)))
3845 ;; The number of inserted lines shouldn't exceed the scroll region end.
3846 ;; The `term-scroll-end' line is part of the scrolling region, so
3847 ;; we need to go one line past it in order to ensure correct
3848 ;; scrolling.
3849 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3850 (setq lines (- lines (- (+ save-current-row lines) (1+ term-scroll-end)))))
3851 (term-down lines)
3852 (delete-region start (point))
3853 (term-down (- (1+ term-scroll-end) save-current-row lines))
3854 (term-insert-char ?\n lines)
3855 (setq term-current-column save-current-column)
3856 (setq term-start-line-column save-start-line-column)
3857 (setq term-current-row save-current-row)
3858 (goto-char start)))
3860 (defun term-insert-lines (lines)
3861 (let ((start (point))
3862 (start-deleted)
3863 (save-current-column term-current-column)
3864 (save-start-line-column term-start-line-column)
3865 (save-current-row (term-current-row)))
3866 ;; Inserting lines should take into account the scroll region.
3867 ;; The `term-scroll-end' line is part of the scrolling region, so
3868 ;; we need to go one line past it in order to ensure correct
3869 ;; scrolling.
3870 (if (< save-current-row term-scroll-start)
3871 ;; If point is before scroll start,
3872 (progn
3873 (setq lines (- lines (- term-scroll-start save-current-row)))
3874 (term-down (- term-scroll-start save-current-row))
3875 (setq start (point)))
3876 ;; The number of inserted lines shouldn't exceed the scroll region end.
3877 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3878 (setq lines (- lines (- (+ save-current-row lines)(1+ term-scroll-end)))))
3879 (term-down (- (1+ term-scroll-end) save-current-row lines)))
3880 (setq start-deleted (point))
3881 (term-down lines)
3882 (delete-region start-deleted (point))
3883 (goto-char start)
3884 (setq term-current-column save-current-column)
3885 (setq term-start-line-column save-start-line-column)
3886 (setq term-current-row save-current-row)
3887 (term-insert-char ?\n lines)
3888 (goto-char start)))
3890 (defun term-start-output-log (name)
3891 "Record raw inferior process output in a buffer."
3892 (interactive (list (if term-log-buffer
3894 (read-buffer "Record output in buffer: "
3895 (format "%s output-log"
3896 (buffer-name (current-buffer)))
3897 nil))))
3898 (if (or (null name) (equal name ""))
3899 (progn (setq term-log-buffer nil)
3900 (message "Output logging off."))
3901 (if (get-buffer name)
3903 (save-excursion
3904 (set-buffer (get-buffer-create name))
3905 (fundamental-mode)
3906 (buffer-disable-undo (current-buffer))
3907 (erase-buffer)))
3908 (setq term-log-buffer (get-buffer name))
3909 (message "Recording terminal emulator output into buffer \"%s\""
3910 (buffer-name term-log-buffer))))
3912 (defun term-stop-output-log ()
3913 "Discontinue raw inferior process logging."
3914 (interactive)
3915 (term-start-output-log nil))
3917 (defun term-show-maximum-output ()
3918 "Put the end of the buffer at the bottom of the window."
3919 (interactive)
3920 (goto-char (point-max))
3921 (recenter -1))
3923 ;;; Do the user's customisation...
3925 (defvar term-load-hook nil
3926 "This hook is run when term is loaded in.
3927 This is a good place to put keybindings.")
3929 (run-hooks 'term-load-hook)
3932 ;;; Filename/command/history completion in a buffer
3933 ;;; ===========================================================================
3934 ;;; Useful completion functions, courtesy of the Ergo group.
3936 ;;; Six commands:
3937 ;;; term-dynamic-complete Complete or expand command, filename,
3938 ;;; history at point.
3939 ;;; term-dynamic-complete-filename Complete filename at point.
3940 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3941 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3942 ;;; replace with expanded/completed name.
3943 ;;; term-dynamic-simple-complete Complete stub given candidates.
3945 ;;; These are not installed in the term-mode keymap. But they are
3946 ;;; available for people who want them. Shell-mode installs them:
3947 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3948 ;;; (define-key shell-mode-map "\M-?"
3949 ;;; 'term-dynamic-list-filename-completions)))
3951 ;;; Commands like this are fine things to put in load hooks if you
3952 ;;; want them present in specific modes.
3954 (defvar term-completion-autolist nil
3955 "*If non-nil, automatically list possibilities on partial completion.
3956 This mirrors the optional behavior of tcsh.")
3958 (defvar term-completion-addsuffix t
3959 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3960 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3961 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3962 completion. This mirrors the optional behavior of tcsh.")
3964 (defvar term-completion-recexact nil
3965 "*If non-nil, use shortest completion if characters cannot be added.
3966 This mirrors the optional behavior of tcsh.
3968 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3970 (defvar term-completion-fignore nil
3971 "*List of suffixes to be disregarded during file completion.
3972 This mirrors the optional behavior of bash and tcsh.
3974 Note that this applies to `term-dynamic-complete-filename' only.")
3976 (defvar term-file-name-prefix ""
3977 "Prefix prepended to absolute file names taken from process input.
3978 This is used by term's and shell's completion functions, and by shell's
3979 directory tracking functions.")
3982 (defun term-directory (directory)
3983 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3984 (expand-file-name (if (file-name-absolute-p directory)
3985 (concat term-file-name-prefix directory)
3986 directory)))
3989 (defun term-word (word-chars)
3990 "Return the word of WORD-CHARS at point, or nil if none is found.
3991 Word constituents are considered to be those in WORD-CHARS, which is like the
3992 inside of a \"[...]\" (see `skip-chars-forward')."
3993 (save-excursion
3994 (let ((limit (point))
3995 (word (concat "[" word-chars "]"))
3996 (non-word (concat "[^" word-chars "]")))
3997 (when (re-search-backward non-word nil 'move)
3998 (forward-char 1))
3999 ;; Anchor the search forwards.
4000 (if (or (eolp) (looking-at non-word))
4002 (re-search-forward (concat word "+") limit)
4003 (buffer-substring (match-beginning 0) (match-end 0))))))
4006 (defun term-match-partial-filename ()
4007 "Return the filename at point, or nil if none is found.
4008 Environment variables are substituted. See `term-word'."
4009 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
4010 (and filename (substitute-in-file-name filename))))
4013 (defun term-dynamic-complete ()
4014 "Dynamically perform completion at point.
4015 Calls the functions in `term-dynamic-complete-functions' to perform
4016 completion until a function returns non-nil, at which point completion is
4017 assumed to have occurred."
4018 (interactive)
4019 (let ((functions term-dynamic-complete-functions))
4020 (while (and functions (null (funcall (car functions))))
4021 (setq functions (cdr functions)))))
4024 (defun term-dynamic-complete-filename ()
4025 "Dynamically complete the filename at point.
4026 Completes if after a filename. See `term-match-partial-filename' and
4027 `term-dynamic-complete-as-filename'.
4028 This function is similar to `term-replace-by-expanded-filename', except that
4029 it won't change parts of the filename already entered in the buffer; it just
4030 adds completion characters to the end of the filename. A completions listing
4031 may be shown in a help buffer if completion is ambiguous.
4033 Completion is dependent on the value of `term-completion-addsuffix',
4034 `term-completion-recexact' and `term-completion-fignore', and the timing of
4035 completions listing is dependent on the value of `term-completion-autolist'.
4037 Returns t if successful."
4038 (interactive)
4039 (when (term-match-partial-filename)
4040 (prog2 (or (eq (selected-window) (minibuffer-window))
4041 (message "Completing file name..."))
4042 (term-dynamic-complete-as-filename))))
4044 (defun term-dynamic-complete-as-filename ()
4045 "Dynamically complete at point as a filename.
4046 See `term-dynamic-complete-filename'. Returns t if successful."
4047 (let* ((completion-ignore-case nil)
4048 (completion-ignored-extensions term-completion-fignore)
4049 (success t)
4050 (dirsuffix (cond ((not term-completion-addsuffix) "")
4051 ((not (consp term-completion-addsuffix)) "/")
4052 (t (car term-completion-addsuffix))))
4053 (filesuffix (cond ((not term-completion-addsuffix) "")
4054 ((not (consp term-completion-addsuffix)) " ")
4055 (t (cdr term-completion-addsuffix))))
4056 (filename (or (term-match-partial-filename) ""))
4057 (pathdir (file-name-directory filename))
4058 (pathnondir (file-name-nondirectory filename))
4059 (directory (if pathdir (term-directory pathdir) default-directory))
4060 (completion (file-name-completion pathnondir directory))
4061 (mini-flag (eq (selected-window) (minibuffer-window))))
4062 (cond ((null completion)
4063 (message "No completions of %s" filename)
4064 (setq success nil))
4065 ((eq completion t) ; Means already completed "file".
4066 (when term-completion-addsuffix (insert " "))
4067 (or mini-flag (message "Sole completion")))
4068 ((string-equal completion "") ; Means completion on "directory/".
4069 (term-dynamic-list-filename-completions))
4070 (t ; Completion string returned.
4071 (let ((file (concat (file-name-as-directory directory) completion)))
4072 (insert (substring (directory-file-name completion)
4073 (length pathnondir)))
4074 (cond ((symbolp (file-name-completion completion directory))
4075 ;; We inserted a unique completion.
4076 (insert (if (file-directory-p file) dirsuffix filesuffix))
4077 (or mini-flag (message "Completed")))
4078 ((and term-completion-recexact term-completion-addsuffix
4079 (string-equal pathnondir completion)
4080 (file-exists-p file))
4081 ;; It's not unique, but user wants shortest match.
4082 (insert (if (file-directory-p file) dirsuffix filesuffix))
4083 (or mini-flag (message "Completed shortest")))
4084 ((or term-completion-autolist
4085 (string-equal pathnondir completion))
4086 ;; It's not unique, list possible completions.
4087 (term-dynamic-list-filename-completions))
4089 (or mini-flag (message "Partially completed")))))))
4090 success))
4093 (defun term-replace-by-expanded-filename ()
4094 "Dynamically expand and complete the filename at point.
4095 Replace the filename with an expanded, canonicalized and completed replacement.
4096 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
4097 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
4098 removed, and the filename is made absolute instead of relative. For expansion
4099 see `expand-file-name' and `substitute-in-file-name'. For completion see
4100 `term-dynamic-complete-filename'."
4101 (interactive)
4102 (replace-match (expand-file-name (term-match-partial-filename)) t t)
4103 (term-dynamic-complete-filename))
4106 (defun term-dynamic-simple-complete (stub candidates)
4107 "Dynamically complete STUB from CANDIDATES list.
4108 This function inserts completion characters at point by completing STUB from
4109 the strings in CANDIDATES. A completions listing may be shown in a help buffer
4110 if completion is ambiguous.
4112 Returns nil if no completion was inserted.
4113 Returns `sole' if completed with the only completion match.
4114 Returns `shortest' if completed with the shortest of the completion matches.
4115 Returns `partial' if completed as far as possible with the completion matches.
4116 Returns `listed' if a completion listing was shown.
4118 See also `term-dynamic-complete-filename'."
4119 (let* ((completion-ignore-case nil)
4120 (candidates (mapcar (function (lambda (x) (list x))) candidates))
4121 (completions (all-completions stub candidates)))
4122 (cond ((null completions)
4123 (message "No completions of %s" stub)
4124 nil)
4125 ((= 1 (length completions)) ; Gotcha!
4126 (let ((completion (car completions)))
4127 (if (string-equal completion stub)
4128 (message "Sole completion")
4129 (insert (substring completion (length stub)))
4130 (message "Completed"))
4131 (when term-completion-addsuffix (insert " "))
4132 'sole))
4133 (t ; There's no unique completion.
4134 (let ((completion (try-completion stub candidates)))
4135 ;; Insert the longest substring.
4136 (insert (substring completion (length stub)))
4137 (cond ((and term-completion-recexact term-completion-addsuffix
4138 (string-equal stub completion)
4139 (member completion completions))
4140 ;; It's not unique, but user wants shortest match.
4141 (insert " ")
4142 (message "Completed shortest")
4143 'shortest)
4144 ((or term-completion-autolist
4145 (string-equal stub completion))
4146 ;; It's not unique, list possible completions.
4147 (term-dynamic-list-completions completions)
4148 'listed)
4150 (message "Partially completed")
4151 'partial)))))))
4154 (defun term-dynamic-list-filename-completions ()
4155 "List in help buffer possible completions of the filename at point."
4156 (interactive)
4157 (let* ((completion-ignore-case nil)
4158 (filename (or (term-match-partial-filename) ""))
4159 (pathdir (file-name-directory filename))
4160 (pathnondir (file-name-nondirectory filename))
4161 (directory (if pathdir (term-directory pathdir) default-directory))
4162 (completions (file-name-all-completions pathnondir directory)))
4163 (if completions
4164 (term-dynamic-list-completions completions)
4165 (message "No completions of %s" filename))))
4168 (defun term-dynamic-list-completions (completions)
4169 "List in help buffer sorted COMPLETIONS.
4170 Typing SPC flushes the help buffer."
4171 (let ((conf (current-window-configuration)))
4172 (with-output-to-temp-buffer "*Completions*"
4173 (display-completion-list (sort completions 'string-lessp)))
4174 (message "Hit space to flush")
4175 (let (key first)
4176 (if (save-excursion
4177 (set-buffer (get-buffer "*Completions*"))
4178 (setq key (read-key-sequence nil)
4179 first (aref key 0))
4180 (and (consp first)
4181 (eq (window-buffer (posn-window (event-start first)))
4182 (get-buffer "*Completions*"))
4183 (eq (key-binding key) 'mouse-choose-completion)))
4184 ;; If the user does mouse-choose-completion with the mouse,
4185 ;; execute the command, then delete the completion window.
4186 (progn
4187 (mouse-choose-completion first)
4188 (set-window-configuration conf))
4189 (if (eq first ?\s)
4190 (set-window-configuration conf)
4191 (setq unread-command-events (listify-key-sequence key)))))))
4193 ;;; I need a make-term that doesn't surround with *s -mm
4194 (defun term-ansi-make-term (name program &optional startfile &rest switches)
4195 "Make a term process NAME in a buffer, running PROGRAM.
4196 The name of the buffer is NAME.
4197 If there is already a running process in that buffer, it is not restarted.
4198 Optional third arg STARTFILE is the name of a file to send the contents of to
4199 the process. Any more args are arguments to PROGRAM."
4200 (let ((buffer (get-buffer-create name )))
4201 ;; If no process, or nuked process, crank up a new one and put buffer in
4202 ;; term mode. Otherwise, leave buffer and existing process alone.
4203 (cond ((not (term-check-proc buffer))
4204 (save-excursion
4205 (set-buffer buffer)
4206 (term-mode)) ; Install local vars, mode, keymap, ...
4207 (term-exec buffer name program startfile switches)))
4208 buffer))
4210 (defvar term-ansi-buffer-name nil)
4211 (defvar term-ansi-default-program nil)
4212 (defvar term-ansi-buffer-base-name nil)
4214 ;;;###autoload
4215 (defun ansi-term (program &optional new-buffer-name)
4216 "Start a terminal-emulator in a new buffer."
4217 (interactive (list (read-from-minibuffer "Run program: "
4218 (or explicit-shell-file-name
4219 (getenv "ESHELL")
4220 (getenv "SHELL")
4221 "/bin/sh"))))
4223 ;; Pick the name of the new buffer.
4224 (setq term-ansi-buffer-name
4225 (if new-buffer-name
4226 new-buffer-name
4227 (if term-ansi-buffer-base-name
4228 (if (eq term-ansi-buffer-base-name t)
4229 (file-name-nondirectory program)
4230 term-ansi-buffer-base-name)
4231 "ansi-term")))
4233 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
4235 ;; In order to have more than one term active at a time
4236 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
4237 ;; for now they have the *term-ansi-term*<?> form but we'll see...
4239 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
4240 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
4242 (set-buffer term-ansi-buffer-name)
4243 (term-mode)
4244 (term-char-mode)
4246 ;; I wanna have find-file on C-x C-f -mm
4247 ;; your mileage may definitely vary, maybe it's better to put this in your
4248 ;; .emacs ...
4250 (term-set-escape-char ?\C-x)
4252 (switch-to-buffer term-ansi-buffer-name))
4255 ;;; Serial terminals
4256 ;;; ===========================================================================
4257 (defun serial-port-is-file-p ()
4258 "Guess whether serial ports are files on this system.
4259 Return t if this is a Unix-based system, where serial ports are
4260 files, such as /dev/ttyS0.
4261 Return nil if this is Windows or DOS, where serial ports have
4262 special identifiers such as COM1."
4263 (not (member system-type (list 'windows-nt 'cygwin 'ms-dos))))
4265 (defvar serial-name-history
4266 (if (serial-port-is-file-p)
4267 (or (when (file-exists-p "/dev/ttys0") (list "/dev/ttys0"))
4268 (when (file-exists-p "/dev/ttyS0") (list "/dev/ttyS0")))
4269 (list "COM1"))
4270 "History of serial ports used by `serial-read-name'.")
4272 (defvar serial-speed-history
4273 ;; Initialised with reasonable values for newbies.
4274 (list "9600" ;; Given twice because 9600 b/s is the most common speed
4275 "1200" "2400" "4800" "9600" "14400" "19200"
4276 "28800" "38400" "57600" "115200")
4277 "History of serial port speeds used by `serial-read-speed'.")
4279 (defun serial-nice-speed-history ()
4280 "Return `serial-speed-history' cleaned up for a mouse-menu."
4281 (let ((x) (y))
4282 (setq x
4283 (sort
4284 (copy-sequence serial-speed-history)
4285 '(lambda (a b) (when (and (stringp a) (stringp b))
4286 (> (string-to-number a) (string-to-number b))))))
4287 (dolist (i x) (when (not (equal i (car y))) (push i y)))
4290 (defconst serial-no-speed "nil"
4291 "String for `serial-read-speed' for special serial ports.
4292 If `serial-read-speed' reads this string from the user, it
4293 returns nil, which is recognized by `serial-process-configure'
4294 for special serial ports that cannot be configured.")
4296 (defun serial-supported-or-barf ()
4297 "Signal an error if serial processes are not supported"
4298 (unless (fboundp 'make-serial-process)
4299 (error "Serial processes are not supported on this system")))
4301 (defun serial-read-name ()
4302 "Read a serial port name from the user.
4303 Try to be nice by providing useful defaults and history.
4304 On Windows, prepend \\.\ to the port name unless it already
4305 contains a backslash. This handles the legacy ports COM1-COM9 as
4306 well as the newer ports COM10 and higher."
4307 (serial-supported-or-barf)
4308 (let* ((file-name-history serial-name-history)
4309 (h (car file-name-history))
4310 (x (if (serial-port-is-file-p)
4311 (read-file-name
4312 ;; `prompt': The most recently used port is provided as
4313 ;; the default value, which is used when the user
4314 ;; simply presses return.
4315 (if (stringp h) (format "Serial port (default %s): " h)
4316 "Serial port: ")
4317 ;; `directory': Most systems have their serial ports
4318 ;; in the same directory, so start in the directory
4319 ;; of the most recently used port, or in a reasonable
4320 ;; default directory.
4321 (or (and h (file-name-directory h))
4322 (and (file-exists-p "/dev/") "/dev/")
4323 (and (file-exists-p "/") "/"))
4324 ;; `default': This causes (read-file-name) to return
4325 ;; the empty string if he user simply presses return.
4326 ;; Using nil here may result in a default directory
4327 ;; of the current buffer, which is not useful for
4328 ;; serial port.
4330 (read-from-minibuffer
4331 (if (stringp h) (format "Serial port (default %s): " h)
4332 "Serial port: ")
4333 nil nil nil '(file-name-history . 1) nil nil))))
4334 (if (or (null x) (and (stringp x) (zerop (length x))))
4335 (setq x h)
4336 (setq serial-name-history file-name-history))
4337 (when (or (null x) (and (stringp x) (zerop (length x))))
4338 (error "No serial port selected"))
4339 (when (and (not (serial-port-is-file-p))
4340 (not (string-match "\\\\" x)))
4341 (set 'x (concat "\\\\.\\" x)))
4344 (defun serial-read-speed ()
4345 "Read a serial port speed (in bits per second) from the user.
4346 Try to be nice by providing useful defaults and history."
4347 (serial-supported-or-barf)
4348 (let* ((history serial-speed-history)
4349 (h (car history))
4350 (x (read-from-minibuffer
4351 (cond ((string= h serial-no-speed)
4352 "Speed (default nil = set by port): ")
4354 (format "Speed (default %s b/s): " h))
4356 (format "Speed (b/s): ")))
4357 nil nil nil '(history . 1) nil nil)))
4358 (when (or (null x) (and (stringp x) (zerop (length x))))
4359 (setq x h))
4360 (when (or (null x) (not (stringp x)) (zerop (length x)))
4361 (error "Invalid speed"))
4362 (if (string= x serial-no-speed)
4363 (setq x nil)
4364 (setq x (string-to-number x))
4365 (when (or (null x) (not (integerp x)) (<= x 0))
4366 (error "Invalid speed")))
4367 (setq serial-speed-history history)
4370 ;;;###autoload
4371 (defun serial-term (port speed)
4372 "Start a terminal-emulator for a serial port in a new buffer.
4373 PORT is the path or name of the serial port. For example, this
4374 could be \"/dev/ttyS0\" on Unix. On Windows, this could be
4375 \"COM1\" or \"\\\\.\\COM10\".
4376 SPEED is the speed of the serial port in bits per second. 9600
4377 is a common value. SPEED can be nil, see
4378 `serial-process-configure' for details.
4379 The buffer is in Term mode; see `term-mode' for the commands to
4380 use in that buffer.
4381 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
4382 (interactive (list (serial-read-name) (serial-read-speed)))
4383 (serial-supported-or-barf)
4384 (let* ((process (make-serial-process
4385 :port port
4386 :speed speed
4387 :coding 'no-conversion
4388 :noquery t))
4389 (buffer (process-buffer process)))
4390 (save-excursion
4391 (set-buffer buffer)
4392 (term-mode)
4393 (term-char-mode)
4394 (goto-char (point-max))
4395 (set-marker (process-mark process) (point))
4396 (set-process-filter process 'term-emulate-terminal)
4397 (set-process-sentinel process 'term-sentinel))
4398 (switch-to-buffer buffer)
4399 buffer))
4401 (defvar serial-mode-line-speed-menu nil)
4402 (defvar serial-mode-line-config-menu nil)
4404 (defun serial-speed ()
4405 "Return the speed of the serial port of the current buffer's process.
4406 The return value may be nil for a special serial port."
4407 (process-contact (get-buffer-process (current-buffer)) :speed))
4409 (defun serial-mode-line-speed-menu-1 (event)
4410 (interactive "e")
4411 (save-selected-window
4412 (select-window (posn-window (event-start event)))
4413 (serial-update-speed-menu)
4414 (let* ((selection (serial-mode-line-speed-menu event))
4415 (binding (and selection (lookup-key serial-mode-line-speed-menu
4416 (vector (car selection))))))
4417 (when binding (call-interactively binding)))))
4419 (defun serial-mode-line-speed-menu (event)
4420 (x-popup-menu event serial-mode-line-speed-menu))
4422 (defun serial-update-speed-menu ()
4423 (setq serial-mode-line-speed-menu (make-sparse-keymap "Speed (b/s)"))
4424 (define-key serial-mode-line-speed-menu [serial-mode-line-speed-menu-other]
4425 '(menu-item "Other..."
4426 (lambda (event) (interactive "e")
4427 (let ((speed (serial-read-speed)))
4428 (serial-process-configure :speed speed)
4429 (term-update-mode-line)
4430 (message "Speed set to %d b/s" speed)))))
4431 (dolist (str (serial-nice-speed-history))
4432 (let ((num (or (and (stringp str) (string-to-number str)) 0)))
4433 (define-key
4434 serial-mode-line-speed-menu
4435 (vector (make-symbol (format "serial-mode-line-speed-menu-%s" str)))
4436 `(menu-item
4437 ,str
4438 (lambda (event) (interactive "e")
4439 (serial-process-configure :speed ,num)
4440 (term-update-mode-line)
4441 (message "Speed set to %d b/s" ,num))
4442 :button (:toggle . (= (serial-speed) ,num)))))))
4444 (defun serial-mode-line-config-menu-1 (event)
4445 (interactive "e")
4446 (save-selected-window
4447 (select-window (posn-window (event-start event)))
4448 (serial-update-config-menu)
4449 (let* ((selection (serial-mode-line-config-menu event))
4450 (binding (and selection (lookup-key serial-mode-line-config-menu
4451 (vector (car selection))))))
4452 (when binding (call-interactively binding)))))
4454 (defun serial-mode-line-config-menu (event)
4455 (x-popup-menu event serial-mode-line-config-menu))
4457 (defun serial-update-config-menu ()
4458 (setq serial-mode-line-config-menu (make-sparse-keymap "Configuration"))
4459 (let ((config (process-contact
4460 (get-buffer-process (current-buffer)) t))
4462 (str))
4463 (dolist (y '((:flowcontrol hw "Hardware flowcontrol (RTS/CTS)")
4464 (:flowcontrol sw "Software flowcontrol (XON/XOFF)")
4465 (:flowcontrol nil "No flowcontrol")
4466 (:stopbits 2 "2 stopbits")
4467 (:stopbits 1 "1 stopbit")
4468 (:parity odd "Odd parity")
4469 (:parity even "Even parity")
4470 (:parity nil "No parity")
4471 (:bytesize 7 "7 bits per byte")
4472 (:bytesize 8 "8 bits per byte")))
4473 (define-key serial-mode-line-config-menu
4474 (vector (make-symbol (format "%s-%s" (nth 0 y) (nth 1 y))))
4475 `(menu-item
4476 ,(nth 2 y)
4477 (lambda (event) (interactive "e")
4478 (serial-process-configure ,(nth 0 y) ',(nth 1 y))
4479 (term-update-mode-line)
4480 (message "%s" ,(nth 2 y)))
4481 ;; Use :toggle instead of :radio because a non-standard port
4482 ;; configuration may not match any menu items.
4483 :button (:toggle . ,(equal (plist-get config (nth 0 y))
4484 (nth 1 y))))))))
4487 ;;; Converting process modes to use term mode
4488 ;;; ===========================================================================
4489 ;;; Renaming variables
4490 ;;; Most of the work is renaming variables and functions. These are the common
4491 ;;; ones:
4492 ;;; Local variables:
4493 ;;; last-input-start term-last-input-start
4494 ;;; last-input-end term-last-input-end
4495 ;;; shell-prompt-pattern term-prompt-regexp
4496 ;;; shell-set-directory-error-hook <no equivalent>
4497 ;;; Miscellaneous:
4498 ;;; shell-set-directory <unnecessary>
4499 ;;; shell-mode-map term-mode-map
4500 ;;; Commands:
4501 ;;; shell-send-input term-send-input
4502 ;;; shell-send-eof term-delchar-or-maybe-eof
4503 ;;; kill-shell-input term-kill-input
4504 ;;; interrupt-shell-subjob term-interrupt-subjob
4505 ;;; stop-shell-subjob term-stop-subjob
4506 ;;; quit-shell-subjob term-quit-subjob
4507 ;;; kill-shell-subjob term-kill-subjob
4508 ;;; kill-output-from-shell term-kill-output
4509 ;;; show-output-from-shell term-show-output
4510 ;;; copy-last-shell-input Use term-previous-input/term-next-input
4512 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4513 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4514 ;;; Term mode does not provide functionality equivalent to
4515 ;;; shell-set-directory-error-hook; it is gone.
4517 ;;; term-last-input-start is provided for modes which want to munge
4518 ;;; the buffer after input is sent, perhaps because the inferior
4519 ;;; insists on echoing the input. The LAST-INPUT-START variable in
4520 ;;; the old shell package was used to implement a history mechanism,
4521 ;;; but you should think twice before using term-last-input-start
4522 ;;; for this; the input history ring often does the job better.
4524 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4525 ;;; *not* create the term-mode local variables in your foo-mode function.
4526 ;;; This is not modular. Instead, call term-mode, and let *it* create the
4527 ;;; necessary term-specific local variables. Then create the
4528 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4529 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4530 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
4531 ;;; get-old-input) that need to be different from the defaults. Call
4532 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4533 ;;; term-mode will take care of it. The following example, from shell.el,
4534 ;;; is typical:
4536 ;;; (defvar shell-mode-map '())
4537 ;;; (cond ((not shell-mode-map)
4538 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4539 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4540 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4541 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4542 ;;; (define-key shell-mode-map "\M-?"
4543 ;;; 'term-dynamic-list-filename-completions)))
4545 ;;; (defun shell-mode ()
4546 ;;; (interactive)
4547 ;;; (term-mode)
4548 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4549 ;;; (setq major-mode 'shell-mode)
4550 ;;; (setq mode-name "Shell")
4551 ;;; (use-local-map shell-mode-map)
4552 ;;; (make-local-variable 'shell-directory-stack)
4553 ;;; (setq shell-directory-stack nil)
4554 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4555 ;;; (run-mode-hooks 'shell-mode-hook))
4558 ;;; Completion for term-mode users
4560 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4561 ;;; hook to add completion functions to. Functions on this list should return
4562 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4563 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4564 ;;; completion job.
4566 (provide 'term)
4568 ;; arch-tag: eee16bc8-2cd7-4147-9534-a5694752f716
4569 ;;; term.el ends here