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