(GETPGRP_NO_ARG): If Glibc 2.1 or later,
[emacs.git] / lisp / term.el
blob63624fecc0914092c6a0878778464c0b75c1cdc8
1 ;;; term.el --- general command interpreter in a window stuff
3 ;;; Copyright (C) 1988, 1990, 1992, 1994, 1995 Free Software Foundation, Inc.
5 ;;; Author: Per Bothner <bothner@cygnus.com>
6 ;;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
7 ;;; Keyword: processes
9 ;;; Dir/Hostname tracking and ANSI colorization by
10 ;;; Marco Melgazzi <marco@techie.com>.
12 ;;; To see what I've modified and where it came from search for '-mm'
14 ;;; Speed considerations and a few caveats
15 ;;; --------------------------------------
16 ;;;
17 ;;; While the message passing and the colorization surely introduce some
18 ;;; overhead this has became so small that IMHO is surely outweighted by
19 ;;; the benefits you get but, as usual, YMMV
20 ;;;
21 ;;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
22 ;;; make a choice: on my Linux box this choice allows me to run all the
23 ;;; ncurses applications without problems but make these keys
24 ;;; uncomprehensible to all the cursesX programs. Your mileage may vary so
25 ;;; you may consider changing the default 'emulation'. Just search for this
26 ;;; piece of code and modify it as you like:
27 ;;;
28 ;;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
29 ;;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
30 ;;; ;; For example: vi works with \eOA while elm wants \e[A ...
31 ;;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
32 ;;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
33 ;;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
34 ;;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
35 ;;;
36 ;;;
37 ;;; IMPORTANT: additions & changes
38 ;;; ------------------------------
39 ;;;
40 ;;; With this enhanced ansi-term.el you will get a reliable mechanism of
41 ;;; directory/username/host tracking: the only drawback is that you will
42 ;;; have to modify your shell start-up script. It's worth it, believe me :).
43 ;;;
44 ;;; When you rlogin/su/telnet and the account you access has a modified
45 ;;; startup script, you will be able to access the remote files as usual
46 ;;; with C-x C-f, if it's needed you will have to enter a password,
47 ;;; otherwise the file should get loaded straight away.
48 ;;;
49 ;;; This is useful even if you work only on one host: it often happens that,
50 ;;; for maintenance reasons, you have to edit files 'as root': before
51 ;;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
52 ;;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
53 ;;; 'as-root'. ( If you don't want to enter the root password every time you
54 ;;; can put it in your .netrc: note that this is -not- advisable if you're
55 ;;; connected to the internet or if somebody else works on your workstation!)
56 ;;;
57 ;;; If you use wu-ftpd you can use some of its features to avoid root ftp
58 ;;; access to the rest of the world: just put in /etc/ftphosts something like
59 ;;;
60 ;;; # Local access
61 ;;; allow root 127.0.0.1
62 ;;;
63 ;;; # By default nobody can't do anything
64 ;;; deny root *
65 ;;;
66 ;;;
67 ;;; ----------------------------------------
68 ;;;
69 ;;; If, instead of 'term', you call 'ansi-term', you get multiple term
70 ;;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
71 ;;; where <xx> is, as usual, a number...
72 ;;;
73 ;;; ----------------------------------------
74 ;;;
75 ;;; With the term-buffer-maximum-size you can finally decide how many
76 ;;; scrollback lines to keep: its default is 2048 but you can change it as
77 ;;; usual.
78 ;;;
79 ;;; ----------------------------------------
80 ;;;
81 ;;;
82 ;;; ANSI colorization should work well, I've decided to limit the interpreter
83 ;;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
84 ;;; You shouldn't need more, if you do, tell me and I'll increase it. It's
85 ;;; so easy you could do it yourself...
86 ;;;
87 ;;; Blink, is not supported. Currently it's mapped as bold.
88 ;;;
89 ;;; Important caveat:
90 ;;; -----------------
91 ;;; if you want custom colors in term.el redefine term-default-fg-color
92 ;;; and term-default-bg-color BEFORE loading it.
93 ;;;
94 ;;; ----------------------------------------
95 ;;;
96 ;;; If you'd like to check out my complete configuration, you can download
97 ;;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
98 ;;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
99 ;;; that this term.el may be newer/older than the one in there, please
100 ;;; check!)
102 ;;; This complete configuration contains, among other things, a complete
103 ;;; rectangular marking solution (based on rect-mark.el and
104 ;;; pc-bindings.el) and should be a good example of how extensively Emacs
105 ;;; can be configured on a ppp-connected ws.
107 ;;; ----------------------------------------
109 ;;; TODO:
111 ;;; - Add hooks to allow raw-mode keys to be configurable
112 ;;; - Which keys are better ? \eOA or \e[A ?
115 ;;; Changes:
117 ;;; V4.0 January 1997
119 ;;; - Huge reworking of the faces code: now we only have roughly 20-30
120 ;;; faces for everything so we're even faster than the old md-term.el !
121 ;;; - Finished removing all the J-Shell code.
123 ;;; V3.0 January 1997
125 ;;; - Now all the supportable ANSI commands work well.
126 ;;; - Reworked a little the code: much less jsh-inspired stuff
128 ;;; V2.3 November
130 ;;; - Now all the faces are accessed through an array: much cleaner code.
132 ;;; V2.2 November 4 1996
134 ;;; - Implemented ANSI output colorization ( a bit rough but enough for
135 ;;; color_ls )
137 ;;; - Implemented a maximum limit for the scroll buffer (stolen from
138 ;;; comint.el)
140 ;;; v2.1 October 28 1996, first public release
142 ;;; - Some new keybindings for term-char mode ( notably home/end/...)
143 ;;; - Directory, hostname and username tracking via ange-ftp
144 ;;; - Multi-term capability via the ansi-term call
146 ;;; ----------------------------------------------------------------
147 ;;; You should/could have something like this in your .emacs to take
148 ;;; full advantage of this package
150 ;;; (add-hook 'term-mode-hook
151 ;;; (function
152 ;;; (lambda ()
153 ;;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
154 ;;; (make-local-variable 'mouse-yank-at-point)
155 ;;; (make-local-variable 'transient-mark-mode)
156 ;;; (setq mouse-yank-at-point t)
157 ;;; (setq transient-mark-mode nil)
158 ;;; (auto-fill-mode -1)
159 ;;; (setq tab-width 8 ))))
162 ;;; ----------------------------------------
164 ;;; If you want to use color ls the best setup is to have a different file
165 ;;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
166 ;;; is necessary because some terminals, rxvt for example, need non-ansi
167 ;;; hacks to work ( for example on my rxvt white is wired to fg, and to
168 ;;; obtain normal white I have to do bold-white :)
170 ;;; ----------------------------------------
173 ;;; # Configuration file for the color ls utility
174 ;;; # This file goes in the /etc directory, and must be world readable.
175 ;;; # You can copy this file to .dir_colors in your $HOME directory to
176 ;;; # override the system defaults.
178 ;;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
179 ;;; # not pipes. 'all' adds color characters to all output. 'none' shuts
180 ;;; # colorization off.
181 ;;; COLOR tty
182 ;;; OPTIONS -F
184 ;;; # Below, there should be one TERM entry for each termtype that is
185 ;;; # colorizable
186 ;;; TERM eterm
188 ;;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
189 ;;; EIGHTBIT 1
191 ;;; # Below are the color init strings for the basic file types. A color init
192 ;;; # string consists of one or more of the following numeric codes:
193 ;;; # Attribute codes:
194 ;;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
195 ;;; # Text color codes:
196 ;;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
197 ;;; # Background color codes:
198 ;;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
199 ;;; NORMAL 00 # global default, although everything should be something.
200 ;;; FILE 00 # normal file
201 ;;; DIR 00;37 # directory
202 ;;; LINK 00;36 # symbolic link
203 ;;; FIFO 00;37 # pipe
204 ;;; SOCK 40;35 # socket
205 ;;; BLK 33;01 # block device driver
206 ;;; CHR 33;01 # character device driver
208 ;;; # This is for files with execute permission:
209 ;;; EXEC 00;32
211 ;;; # List any file extensions like '.gz' or '.tar' that you would like ls
212 ;;; # to colorize below. Put the extension, a space, and the color init
213 ;;; # string. (and any comments you want to add after a '#')
214 ;;; .tar 01;33 # archives or compressed
215 ;;; .tgz 01;33
216 ;;; .arj 01;33
217 ;;; .taz 01;33
218 ;;; .lzh 01;33
219 ;;; .zip 01;33
220 ;;; .z 01;33
221 ;;; .Z 01;33
222 ;;; .gz 01;33
223 ;;; .jpg 01;35 # image formats
224 ;;; .gif 01;35
225 ;;; .bmp 01;35
226 ;;; .xbm 01;35
227 ;;; .xpm 01;35
230 ;;; ----------------------------------------
232 ;;; Notice: for directory/host/user tracking you need to have something
233 ;;; like this in your shell startup script ( this is for tcsh but should
234 ;;; be quite easy to port to other shells )
236 ;;; ----------------------------------------
239 ;;; set os = `uname`
240 ;;; set host = `hostname`
241 ;;; set date = `date`
243 ;;; # su does not change this but I'd like it to
245 ;;; set user = `whoami`
247 ;;; # ...
249 ;;; if ( eterm =~ $TERM ) then
251 ;;; echo --------------------------------------------------------------
252 ;;; echo Hello $user
253 ;;; echo Today is $date
254 ;;; echo We are on $host running $os under Emacs term mode
255 ;;; echo --------------------------------------------------------------
257 ;;; setenv EDITOR emacsclient
259 ;;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
260 ;;; # this is necessary because, f.e., certain versions of 'su' do not change
261 ;;; # $user, YMMV: if you don't want to fiddle with them define a couple
262 ;;; # of new variables and use these instead.
263 ;;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
265 ;;; # These are because we want the real cwd in the messages, not the login
266 ;;; # time one !
268 ;;; set cwd_hack='$cwd'
269 ;;; set host_hack='$host'
270 ;;; set user_hack='$user'
272 ;;; # Notice that the ^[ character is an ESC, not two chars. You can
273 ;;; # get it in various ways, for example by typing
274 ;;; # echo -e '\033' > escape.file
275 ;;; # or by using your favourite editor
277 ;;; foreach temp (cd pushd)
278 ;;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
279 ;;; end
280 ;;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
282 ;;; # Every command that can modify the user/host/directory should be aliased
283 ;;; # as follows for the tracking mechanism to work.
285 ;;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
286 ;;; alias $temp "$temp \!* ; echo '\eAnSiTh' $host_hack ; \
287 ;;; echo '\eAnSiTu' $user_hack ;echo '\eAnSiTc' $cwd_hack"
288 ;;; end
290 ;;; # Start up & use color ls
292 ;;; echo "\eAnSiTh" $host
293 ;;; echo "\eAnSiTu" $user
294 ;;; echo "\eAnSiTc" $cwd
296 ;;; # some housekeeping
298 ;;; unset cwd_hack
299 ;;; unset host_hack
300 ;;; unset user_hack
301 ;;; unset temp
303 ;;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
304 ;;; endif
306 ;;; # ...
308 ;;; # Let's not clutter user space
310 ;;; unset os
311 ;;; unset date
315 ;;; Original Commentary:
316 ;;; --------------------
318 ;; The changelog is at the end of this file.
320 ;; Please send me bug reports, bug fixes, and extensions, so that I can
321 ;; merge them into the master source.
322 ;; - Per Bothner (bothner@cygnus.com)
324 ;; This file defines a general command-interpreter-in-a-buffer package
325 ;; (term mode). The idea is that you can build specific process-in-a-buffer
326 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
327 ;; This way, all these specific packages share a common base functionality,
328 ;; and a common set of bindings, which makes them easier to use (and
329 ;; saves code, implementation time, etc., etc.).
331 ;; For hints on converting existing process modes (e.g., tex-mode,
332 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
333 ;; instead of shell-mode, see the notes at the end of this file.
336 ;; Brief Command Documentation:
337 ;;============================================================================
338 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
339 ;; mode)
341 ;; m-p term-previous-input Cycle backwards in input history
342 ;; m-n term-next-input Cycle forwards
343 ;; m-r term-previous-matching-input Previous input matching a regexp
344 ;; m-s comint-next-matching-input Next input that matches
345 ;; return term-send-input
346 ;; c-c c-a term-bol Beginning of line; skip prompt.
347 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
348 ;; c-c c-u term-kill-input ^u
349 ;; c-c c-w backward-kill-word ^w
350 ;; c-c c-c term-interrupt-subjob ^c
351 ;; c-c c-z term-stop-subjob ^z
352 ;; c-c c-\ term-quit-subjob ^\
353 ;; c-c c-o term-kill-output Delete last batch of process output
354 ;; c-c c-r term-show-output Show last batch of process output
355 ;; c-c c-h term-dynamic-list-input-ring List input history
357 ;; Not bound by default in term-mode
358 ;; term-send-invisible Read a line w/o echo, and send to proc
359 ;; (These are bound in shell-mode)
360 ;; term-dynamic-complete Complete filename at point.
361 ;; term-dynamic-list-completions List completions in help buffer.
362 ;; term-replace-by-expanded-filename Expand and complete filename at point;
363 ;; replace with expanded/completed name.
364 ;; term-kill-subjob No mercy.
365 ;; term-show-maximum-output Show as much output as possible.
366 ;; term-continue-subjob Send CONT signal to buffer's process
367 ;; group. Useful if you accidentally
368 ;; suspend your process (with C-c C-z).
370 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
371 ;; term-load-hook is run after loading in this package.
373 ;; Code:
375 ;; This is passed to the inferior in the EMACS environment variable,
376 ;; so it is important to increase it if there are protocol-relevant changes.
377 (defconst term-protocol-version "0.95")
379 (require 'ring)
380 (require 'ehelp)
382 ;;; Buffer Local Variables:
383 ;;;============================================================================
384 ;;; Term mode buffer local variables:
385 ;;; term-prompt-regexp - string term-bol uses to match prompt.
386 ;;; term-delimiter-argument-list - list For delimiters and arguments
387 ;;; term-last-input-start - marker Handy if inferior always echoes
388 ;;; term-last-input-end - marker For term-kill-output command
389 ;; For the input history mechanism:
390 (defvar term-input-ring-size 32 "Size of input history ring.")
391 ;;; term-input-ring-size - integer
392 ;;; term-input-ring - ring
393 ;;; term-input-ring-index - number ...
394 ;;; term-input-autoexpand - symbol ...
395 ;;; term-input-ignoredups - boolean ...
396 ;;; term-last-input-match - string ...
397 ;;; term-dynamic-complete-functions - hook For the completion mechanism
398 ;;; term-completion-fignore - list ...
399 ;;; term-get-old-input - function Hooks for specific
400 ;;; term-input-filter-functions - hook process-in-a-buffer
401 ;;; term-input-filter - function modes.
402 ;;; term-input-send - function
403 ;;; term-scroll-to-bottom-on-output - symbol ...
404 ;;; term-scroll-show-maximum-output - boolean...
405 (defvar term-height) ;; Number of lines in window.
406 (defvar term-width) ;; Number of columns in window.
407 (defvar term-home-marker) ;; Marks the "home" position for cursor addressing.
408 (defvar term-saved-home-marker nil) ;; When using alternate sub-buffer,
409 ;; contains saved term-home-marker from original sub-buffer .
410 (defvar term-start-line-column 0) ;; (current-column) at start of screen line,
411 ;; or nil if unknown.
412 (defvar term-current-column 0) ;; If non-nil, is cache for (current-column).
413 (defvar term-current-row 0) ;; Current vertical row (relative to home-marker)
414 ;; or nil if unknown.
415 (defvar term-insert-mode nil)
416 (defvar term-vertical-motion)
417 (defvar term-terminal-state 0) ;; State of the terminal emulator:
418 ;; state 0: Normal state
419 ;; state 1: Last character was a graphic in the last column.
420 ;; If next char is graphic, first move one column right
421 ;; (and line warp) before displaying it.
422 ;; This emulates (more or less) the behavior of xterm.
423 ;; state 2: seen ESC
424 ;; state 3: seen ESC [ (or ESC [ ?)
425 ;; state 4: term-terminal-parameter contains pending output.
426 (defvar term-kill-echo-list nil) ;; A queue of strings whose echo
427 ;; we want suppressed.
428 (defvar term-terminal-parameter)
429 (defvar term-terminal-previous-parameter)
430 (defvar term-current-face 'term-default)
431 (defvar term-scroll-start 0) ;; Top-most line (inclusive) of scrolling region.
432 (defvar term-scroll-end) ;; Number of line (zero-based) after scrolling region.
433 (defvar term-pager-count nil) ;; If nil, paging is disabled.
434 ;; Otherwise, number of lines before we need to page.
435 (defvar term-saved-cursor nil)
436 (defvar term-command-hook)
437 (defvar term-log-buffer nil)
438 (defvar term-scroll-with-delete nil) ;; term-scroll-with-delete is t if
439 ;; forward scrolling should be implemented by delete to
440 ;; top-most line(s); and nil if scrolling should be implemented
441 ;; by moving term-home-marker. It is set to t iff there is a
442 ;; (non-default) scroll-region OR the alternate buffer is used.
443 (defvar term-pending-delete-marker) ;; New user input in line mode needs to
444 ;; be deleted, because it gets echoed by the inferior.
445 ;; To reduce flicker, we defer the delete until the next output.
446 (defvar term-old-mode-map nil) ;; Saves the old keymap when in char mode.
447 (defvar term-old-mode-line-format) ;; Saves old mode-line-format while paging.
448 (defvar term-pager-old-local-map nil) ;; Saves old keymap while paging.
449 (defvar term-pager-old-filter) ;; Saved process-filter while paging.
451 (defvar explicit-shell-file-name nil
452 "*If non-nil, is file name to use for explicitly requested inferior shell.")
454 (defvar term-prompt-regexp "^"
455 "Regexp to recognise prompts in the inferior process.
456 Defaults to \"^\", the null string at BOL.
458 Good choices:
459 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
460 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
461 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
462 kcl: \"^>+ *\"
463 shell: \"^[^#$%>\\n]*[#$%>] *\"
464 T: \"^>+ *\"
466 This is a good thing to set in mode hooks.")
468 (defvar term-delimiter-argument-list ()
469 "List of characters to recognise as separate arguments in input.
470 Strings comprising a character in this list will separate the arguments
471 surrounding them, and also be regarded as arguments in their own right (unlike
472 whitespace). See `term-arguments'.
473 Defaults to the empty list.
475 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
477 This is a good thing to set in mode hooks.")
479 (defvar term-input-autoexpand nil
480 "*If non-nil, expand input command history references on completion.
481 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
483 If the value is `input', then the expansion is seen on input.
484 If the value is `history', then the expansion is only when inserting
485 into the buffer's input ring. See also `term-magic-space' and
486 `term-dynamic-complete'.
488 This variable is buffer-local.")
490 (defvar term-input-ignoredups nil
491 "*If non-nil, don't add input matching the last on the input ring.
492 This mirrors the optional behavior of bash.
494 This variable is buffer-local.")
496 (defvar term-input-ring-file-name nil
497 "*If non-nil, name of the file to read/write input history.
498 See also `term-read-input-ring' and `term-write-input-ring'.
500 This variable is buffer-local, and is a good thing to set in mode hooks.")
502 (defvar term-scroll-to-bottom-on-output nil
503 "*Controls whether interpreter output causes window to scroll.
504 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
505 If `this', scroll only the selected window.
506 If `others', scroll only those that are not the selected window.
508 The default is nil.
510 See variable `term-scroll-show-maximum-output'.
511 This variable is buffer-local.")
513 (defvar term-scroll-show-maximum-output nil
514 "*Controls how interpreter output causes window to scroll.
515 If non-nil, then show the maximum output when the window is scrolled.
517 See variable `term-scroll-to-bottom-on-output'.
518 This variable is buffer-local.")
520 ;; Where gud-display-frame should put the debugging arrow. This is
521 ;; set by the marker-filter, which scans the debugger's output for
522 ;; indications of the current pc.
523 (defvar term-pending-frame nil)
525 ;;; Here are the per-interpreter hooks.
526 (defvar term-get-old-input (function term-get-old-input-default)
527 "Function that submits old text in term mode.
528 This function is called when return is typed while the point is in old text.
529 It returns the text to be submitted as process input. The default is
530 term-get-old-input-default, which grabs the current line, and strips off
531 leading text matching term-prompt-regexp")
533 (defvar term-dynamic-complete-functions
534 '(term-replace-by-expanded-history term-dynamic-complete-filename)
535 "List of functions called to perform completion.
536 Functions should return non-nil if completion was performed.
537 See also `term-dynamic-complete'.
539 This is a good thing to set in mode hooks.")
541 (defvar term-input-filter
542 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
543 "Predicate for filtering additions to input history.
544 Only inputs answering true to this function are saved on the input
545 history list. Default is to save anything that isn't all whitespace")
547 (defvar term-input-filter-functions '()
548 "Functions to call before input is sent to the process.
549 These functions get one argument, a string containing the text to send.
551 This variable is buffer-local.")
553 (defvar term-input-sender (function term-simple-send)
554 "Function to actually send to PROCESS the STRING submitted by user.
555 Usually this is just 'term-simple-send, but if your mode needs to
556 massage the input string, this is your hook. This is called from
557 the user command term-send-input. term-simple-send just sends
558 the string plus a newline.")
560 (defvar term-eol-on-send t
561 "*Non-nil means go to the end of the line before sending input.
562 See `term-send-input'.")
564 (defvar term-mode-hook '()
565 "Called upon entry into term-mode
566 This is run before the process is cranked up.")
568 (defvar term-exec-hook '()
569 "Called each time a process is exec'd by term-exec.
570 This is called after the process is cranked up. It is useful for things that
571 must be done each time a process is executed in a term-mode buffer (e.g.,
572 \(process-kill-without-query)). In contrast, the term-mode-hook is only
573 executed once when the buffer is created.")
575 (defvar term-mode-map nil)
576 (defvar term-raw-map nil
577 "Keyboard map for sending characters directly to the inferior process.")
578 (defvar term-escape-char nil
579 "Escape character for char-sub-mode of term mode.
580 Do not change it directly; use term-set-escape-char instead.")
581 (defvar term-raw-escape-map nil)
583 (defvar term-pager-break-map nil)
585 (defvar term-ptyp t
586 "True if communications via pty; false if by pipe. Buffer local.
587 This is to work around a bug in Emacs process signaling.")
589 (defvar term-last-input-match ""
590 "Last string searched for by term input history search, for defaulting.
591 Buffer local variable.")
593 (defvar term-input-ring nil)
594 (defvar term-last-input-start)
595 (defvar term-last-input-end)
596 (defvar term-input-ring-index nil
597 "Index of last matched history element.")
598 (defvar term-matching-input-from-input-string ""
599 "Input previously used to match input history.")
600 ; This argument to set-process-filter disables reading from the process,
601 ; assuming this is Emacs 19.20 or newer.
602 (defvar term-pager-filter t)
604 (put 'term-replace-by-expanded-history 'menu-enable 'term-input-autoexpand)
605 (put 'term-input-ring 'permanent-local t)
606 (put 'term-input-ring-index 'permanent-local t)
607 (put 'term-input-autoexpand 'permanent-local t)
608 (put 'term-input-filter-functions 'permanent-local t)
609 (put 'term-scroll-to-bottom-on-output 'permanent-local t)
610 (put 'term-scroll-show-maximum-output 'permanent-local t)
611 (put 'term-ptyp 'permanent-local t)
613 ;; Do FORMS if running under Emacs-19.
614 (defmacro term-if-emacs19 (&rest forms)
615 (if (string-match "^19" emacs-version) (cons 'progn forms)))
616 ;; True if running under XEmacs (previously Lucid Emacs).
617 (defmacro term-is-xemacs () '(string-match "Lucid" emacs-version))
618 ;; Do FORM if running under XEmacs (previously Lucid Emacs).
619 (defmacro term-if-xemacs (&rest forms)
620 (if (term-is-xemacs) (cons 'progn forms)))
621 ;; Do FORM if NOT running under XEmacs (previously Lucid Emacs).
622 (defmacro term-ifnot-xemacs (&rest forms)
623 (if (not (term-is-xemacs)) (cons 'progn forms)))
625 (defmacro term-in-char-mode () '(eq (current-local-map) term-raw-map))
626 (defmacro term-in-line-mode () '(not (term-in-char-mode)))
627 ;; True if currently doing PAGER handling.
628 (defmacro term-pager-enabled () 'term-pager-count)
629 (defmacro term-handling-pager () 'term-pager-old-local-map)
630 (defmacro term-using-alternate-sub-buffer () 'term-saved-home-marker)
632 (defvar term-signals-menu)
633 (defvar term-terminal-menu)
635 ;;; Let's silence the byte-compiler -mm
636 (defvar term-ansi-at-eval-string nil)
637 (defvar term-ansi-at-host nil)
638 (defvar term-ansi-at-dir nil)
639 (defvar term-ansi-at-user nil)
640 (defvar term-ansi-at-message nil)
641 (defvar term-ansi-at-save-user nil)
642 (defvar term-ansi-at-save-pwd nil)
643 (defvar term-ansi-at-save-anon nil)
644 (defvar term-ansi-current-bold 0)
645 (defvar term-ansi-current-color 0)
646 (defvar term-ansi-face-alredy-done 0)
647 (defvar term-ansi-current-bg-color 0)
648 (defvar term-ansi-current-underline 0)
649 (defvar term-ansi-current-highlight 0)
650 (defvar term-ansi-current-reverse 0)
651 (defvar term-ansi-current-invisible 0)
652 (defvar term-ansi-default-fg 0)
653 (defvar term-ansi-default-bg 0)
654 (defvar term-ansi-current-temp 0)
655 (defvar term-ansi-fg-faces-vector nil)
656 (defvar term-ansi-bg-faces-vector nil)
657 (defvar term-ansi-inv-fg-faces-vector nil)
658 (defvar term-ansi-inv-bg-faces-vector nil)
659 (defvar term-ansi-reverse-faces-vector nil)
661 ;;; Four should be enough, if you want more, just add. -mm
662 (defvar term-terminal-more-parameters 0)
663 (defvar term-terminal-previous-parameter-2 -1)
664 (defvar term-terminal-previous-parameter-3 -1)
665 (defvar term-terminal-previous-parameter-4 -1)
668 ;;; faces -mm
671 (defvar term-default-fg-color "azure3")
672 (defvar term-default-bg-color "SkyBlue4")
674 ;;; --- Simple faces ---
675 (make-face 'term-default-fg)
676 (make-face 'term-default-bg)
677 (make-face 'term-default-fg-inv)
678 (make-face 'term-default-bg-inv)
679 (make-face 'term-bold)
680 (make-face 'term-underline)
681 (make-face 'term-invisible)
682 (make-face 'term-invisible-inv)
684 (copy-face 'default 'term-default-fg)
685 (copy-face 'default 'term-default-bg)
686 (set-face-foreground 'term-default-fg term-default-fg-color)
687 (set-face-background 'term-default-bg term-default-bg-color)
689 (copy-face 'default 'term-default-fg-inv)
690 (copy-face 'default 'term-default-bg-inv)
691 (set-face-foreground 'term-default-fg-inv term-default-bg-color)
692 (set-face-background 'term-default-bg-inv term-default-fg-color)
694 (copy-face 'default 'term-invisible)
695 (set-face-background 'term-invisible term-default-bg-color)
696 (set-face-background 'term-invisible term-default-bg-color)
698 (copy-face 'default 'term-invisible-inv)
699 (set-face-background 'term-invisible-inv term-default-fg-color)
700 (set-face-background 'term-invisible-inv term-default-fg-color)
702 (copy-face 'default 'term-bold)
703 (make-face-bold 'term-bold)
705 (copy-face 'default 'term-underline)
706 (set-face-underline-p 'term-underline t)
708 ;;; --- Fg faces ---
709 (make-face 'term-black)
710 (make-face 'term-red)
711 (make-face 'term-green)
712 (make-face 'term-yellow)
713 (make-face 'term-blue)
714 (make-face 'term-magenta)
715 (make-face 'term-cyan)
716 (make-face 'term-white)
718 (copy-face 'default 'term-black)
719 (set-face-foreground 'term-black "black")
720 (copy-face 'default 'term-red)
721 (set-face-foreground 'term-red "red")
722 (copy-face 'default 'term-green)
723 (set-face-foreground 'term-green "green")
724 (copy-face 'default 'term-yellow)
725 (set-face-foreground 'term-yellow "yellow")
726 (copy-face 'default 'term-blue)
727 (set-face-foreground 'term-blue "blue")
728 (copy-face 'default 'term-magenta)
729 (set-face-foreground 'term-magenta "magenta")
730 (copy-face 'default 'term-cyan)
731 (set-face-foreground 'term-cyan "cyan")
732 (copy-face 'default 'term-white)
733 (set-face-foreground 'term-white "white")
735 ;;; --- Bg faces ---
736 (make-face 'term-blackbg)
737 (make-face 'term-redbg)
738 (make-face 'term-greenbg)
739 (make-face 'term-yellowbg)
740 (make-face 'term-bluebg)
741 (make-face 'term-magentabg)
742 (make-face 'term-cyanbg)
743 (make-face 'term-whitebg)
745 (copy-face 'default 'term-blackbg)
746 (set-face-background 'term-blackbg "black")
747 (copy-face 'default 'term-redbg)
748 (set-face-background 'term-redbg "red")
749 (copy-face 'default 'term-greenbg)
750 (set-face-background 'term-greenbg "green")
751 (copy-face 'default 'term-yellowbg)
752 (set-face-background 'term-yellowbg "yellow")
753 (copy-face 'default 'term-bluebg)
754 (set-face-background 'term-bluebg "blue")
755 (copy-face 'default 'term-magentabg)
756 (set-face-background 'term-magentabg "magenta")
757 (copy-face 'default 'term-cyanbg)
758 (set-face-background 'term-cyanbg "cyan")
759 (copy-face 'default 'term-whitebg)
760 (set-face-background 'term-whitebg "white")
762 (setq ansi-term-fg-faces-vector
763 [term-default-fg term-black term-red term-green term-yellow term-blue
764 term-magenta term-cyan term-white])
766 (setq ansi-term-bg-faces-vector
767 [term-default-bg term-blackbg term-redbg term-greenbg term-yellowbg
768 term-bluebg term-magentabg term-cyanbg term-whitebg])
770 (setq ansi-term-inv-bg-faces-vector
771 [term-default-fg-inv term-black term-red term-green term-yellow term-blue
772 term-magenta term-cyan term-white])
774 (setq ansi-term-inv-fg-faces-vector
775 [term-default-bg-inv term-blackbg term-redbg term-greenbg term-yellowbg
776 term-bluebg term-magentabg term-cyanbg term-whitebg])
778 ;;; Inspiration came from comint.el -mm
779 (defvar term-buffer-maximum-size 2048
780 "*The maximum size in lines for term buffers.
781 Term buffers are truncated from the top to be no greater than this number.
782 Notice that a setting of 0 means 'don't truncate anything'. This variable
783 is buffer-local.")
786 (term-if-xemacs
787 (defvar term-terminal-menu
788 '("Terminal"
789 [ "Character mode" term-char-mode (term-in-line-mode)]
790 [ "Line mode" term-line-mode (term-in-char-mode)]
791 [ "Enable paging" term-pager-toggle (not term-pager-count)]
792 [ "Disable paging" term-pager-toggle term-pager-count])))
794 (defun term-mode ()
795 "Major mode for interacting with an inferior interpreter.
796 Interpreter name is same as buffer name, sans the asterisks.
797 In line sub-mode, return at end of buffer sends line as input,
798 while return not at end copies rest of line to end and sends it.
799 In char sub-mode, each character (except `term-escape-char`) is
800 set immediately.
802 This mode is typically customised to create inferior-lisp-mode,
803 shell-mode, etc.. This can be done by setting the hooks
804 term-input-filter-functions, term-input-filter, term-input-sender and
805 term-get-old-input to appropriate functions, and the variable
806 term-prompt-regexp to the appropriate regular expression.
808 An input history is maintained of size `term-input-ring-size', and
809 can be accessed with the commands \\[term-next-input],
810 \\[term-previous-input], and \\[term-dynamic-list-input-ring].
811 Input ring history expansion can be achieved with the commands
812 \\[term-replace-by-expanded-history] or \\[term-magic-space].
813 Input ring expansion is controlled by the variable `term-input-autoexpand',
814 and addition is controlled by the variable `term-input-ignoredups'.
816 Input to, and output from, the subprocess can cause the window to scroll to
817 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
818 and `term-scroll-to-bottom-on-output'.
820 If you accidentally suspend your process, use \\[term-continue-subjob]
821 to continue it.
823 \\{term-mode-map}
825 Entry to this mode runs the hooks on term-mode-hook"
826 (interactive)
827 ;; Do not remove this. All major modes must do this.
828 (kill-all-local-variables)
829 (setq major-mode 'term-mode)
830 (setq mode-name "Term")
831 (use-local-map term-mode-map)
832 (make-local-variable 'term-home-marker)
833 (setq term-home-marker (copy-marker 0))
834 (make-local-variable 'term-saved-home-marker)
835 (make-local-variable 'term-height)
836 (make-local-variable 'term-width)
837 (setq term-width (1- (window-width)))
838 (setq term-height (1- (window-height)))
839 (make-local-variable 'term-terminal-parameter)
840 (make-local-variable 'term-saved-cursor)
841 (make-local-variable 'term-last-input-start)
842 (setq term-last-input-start (make-marker))
843 (make-local-variable 'term-last-input-end)
844 (setq term-last-input-end (make-marker))
845 (make-local-variable 'term-last-input-match)
846 (setq term-last-input-match "")
847 (make-local-variable 'term-prompt-regexp) ; Don't set; default
848 (make-local-variable 'term-input-ring-size) ; ...to global val.
849 (make-local-variable 'term-input-ring)
850 (make-local-variable 'term-input-ring-file-name)
851 (or (and (boundp 'term-input-ring) term-input-ring)
852 (setq term-input-ring (make-ring term-input-ring-size)))
853 (make-local-variable 'term-input-ring-index)
854 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
855 (setq term-input-ring-index nil))
857 (make-local-variable 'term-command-hook)
858 (setq term-command-hook (symbol-function 'term-command-hook))
860 ;;; I'm not sure these saves are necessary but, since I
861 ;;; haven't tested the whole thing on a net connected machine with
862 ;;; a properly configured ange-ftp, I've decided to be conservative
863 ;;; and put them in. -mm
865 (make-local-variable 'term-ansi-at-host)
866 (setq term-ansi-at-host (system-name))
868 (make-local-variable 'term-ansi-at-dir)
869 (setq term-ansi-at-dir default-directory)
871 (make-local-variable 'term-ansi-at-message)
872 (setq term-ansi-at-message nil)
874 ;;; For user tracking purposes -mm
875 (make-local-variable 'ange-ftp-default-user)
876 (make-local-variable 'ange-ftp-default-password)
877 (make-local-variable 'ange-ftp-generate-anonymous-password)
879 ;;; You may want to have different scroll-back sizes -mm
880 (make-local-variable 'term-buffer-maximum-size)
882 ;;; Of course these have to be buffer-local -mm
883 (make-local-variable 'term-ansi-current-bold)
884 (make-local-variable 'term-ansi-current-color)
885 (make-local-variable 'term-ansi-face-alredy-done)
886 (make-local-variable 'term-ansi-current-bg-color)
887 (make-local-variable 'term-ansi-current-underline)
888 (make-local-variable 'term-ansi-current-highlight)
889 (make-local-variable 'term-ansi-current-reverse)
890 (make-local-variable 'term-ansi-current-invisible)
892 (make-local-variable 'term-terminal-state)
893 (make-local-variable 'term-kill-echo-list)
894 (make-local-variable 'term-start-line-column)
895 (make-local-variable 'term-current-column)
896 (make-local-variable 'term-current-row)
897 (make-local-variable 'term-log-buffer)
898 (make-local-variable 'term-scroll-start)
899 (make-local-variable 'term-scroll-end)
900 (setq term-scroll-end term-height)
901 (make-local-variable 'term-scroll-with-delete)
902 (make-local-variable 'term-pager-count)
903 (make-local-variable 'term-pager-old-local-map)
904 (make-local-variable 'term-old-mode-map)
905 (make-local-variable 'term-insert-mode)
906 (make-local-variable 'term-dynamic-complete-functions)
907 (make-local-variable 'term-completion-fignore)
908 (make-local-variable 'term-get-old-input)
909 (make-local-variable 'term-matching-input-from-input-string)
910 (make-local-variable 'term-input-autoexpand)
911 (make-local-variable 'term-input-ignoredups)
912 (make-local-variable 'term-delimiter-argument-list)
913 (make-local-variable 'term-input-filter-functions)
914 (make-local-variable 'term-input-filter)
915 (make-local-variable 'term-input-sender)
916 (make-local-variable 'term-eol-on-send)
917 (make-local-variable 'term-scroll-to-bottom-on-output)
918 (make-local-variable 'term-scroll-show-maximum-output)
919 (make-local-variable 'term-ptyp)
920 (make-local-variable 'term-exec-hook)
921 (make-local-variable 'term-vertical-motion)
922 (make-local-variable 'term-pending-delete-marker)
923 (setq term-pending-delete-marker (make-marker))
924 (make-local-variable 'term-current-face)
925 (make-local-variable 'term-pending-frame)
926 (setq term-pending-frame nil)
927 (run-hooks 'term-mode-hook)
928 (term-if-xemacs
929 (set-buffer-menubar
930 (append current-menubar (list term-terminal-menu))))
931 (or term-input-ring
932 (setq term-input-ring (make-ring term-input-ring-size)))
933 (term-update-mode-line))
935 (if term-mode-map
937 (setq term-mode-map (make-sparse-keymap))
938 (define-key term-mode-map "\ep" 'term-previous-input)
939 (define-key term-mode-map "\en" 'term-next-input)
940 (define-key term-mode-map "\er" 'term-previous-matching-input)
941 (define-key term-mode-map "\es" 'term-next-matching-input)
942 (term-ifnot-xemacs
943 (define-key term-mode-map [?\A-\M-r]
944 'term-previous-matching-input-from-input)
945 (define-key term-mode-map [?\A-\M-s] 'term-next-matching-input-from-input))
946 (define-key term-mode-map "\e\C-l" 'term-show-output)
947 (define-key term-mode-map "\C-m" 'term-send-input)
948 (define-key term-mode-map "\C-d" 'term-delchar-or-maybe-eof)
949 (define-key term-mode-map "\C-c\C-a" 'term-bol)
950 (define-key term-mode-map "\C-c\C-u" 'term-kill-input)
951 (define-key term-mode-map "\C-c\C-w" 'backward-kill-word)
952 (define-key term-mode-map "\C-c\C-c" 'term-interrupt-subjob)
953 (define-key term-mode-map "\C-c\C-z" 'term-stop-subjob)
954 (define-key term-mode-map "\C-c\C-\\" 'term-quit-subjob)
955 (define-key term-mode-map "\C-c\C-m" 'term-copy-old-input)
956 (define-key term-mode-map "\C-c\C-o" 'term-kill-output)
957 (define-key term-mode-map "\C-c\C-r" 'term-show-output)
958 (define-key term-mode-map "\C-c\C-e" 'term-show-maximum-output)
959 (define-key term-mode-map "\C-c\C-l" 'term-dynamic-list-input-ring)
960 (define-key term-mode-map "\C-c\C-n" 'term-next-prompt)
961 (define-key term-mode-map "\C-c\C-p" 'term-previous-prompt)
962 (define-key term-mode-map "\C-c\C-d" 'term-send-eof)
963 (define-key term-mode-map "\C-c\C-k" 'term-char-mode)
964 (define-key term-mode-map "\C-c\C-j" 'term-line-mode)
965 (define-key term-mode-map "\C-c\C-q" 'term-pager-toggle)
968 ; ;; completion:
969 ; (define-key term-mode-map [menu-bar completion]
970 ; (cons "Complete" (make-sparse-keymap "Complete")))
971 ; (define-key term-mode-map [menu-bar completion complete-expand]
972 ; '("Expand File Name" . term-replace-by-expanded-filename))
973 ; (define-key term-mode-map [menu-bar completion complete-listing]
974 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
975 ; (define-key term-mode-map [menu-bar completion complete-file]
976 ; '("Complete File Name" . term-dynamic-complete-filename))
977 ; (define-key term-mode-map [menu-bar completion complete]
978 ; '("Complete Before Point" . term-dynamic-complete))
979 ; ;; Put them in the menu bar:
980 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
981 ; menu-bar-final-items))
984 ;; Menu bars:
985 (term-ifnot-xemacs
986 (term-if-emacs19
988 ;; terminal:
989 (let (newmap)
990 (setq newmap (make-sparse-keymap "Terminal"))
991 (define-key newmap [terminal-pager-enable]
992 '("Enable paging" . term-fake-pager-enable))
993 (define-key newmap [terminal-pager-disable]
994 '("Disable paging" . term-fake-pager-disable))
995 (define-key newmap [terminal-char-mode]
996 '("Character mode" . term-char-mode))
997 (define-key newmap [terminal-line-mode]
998 '("Line mode" . term-line-mode))
999 (setq term-terminal-menu (cons "Terminal" newmap))
1001 ;; completion: (line mode only)
1002 (defvar term-completion-menu (make-sparse-keymap "Complete"))
1003 (define-key term-mode-map [menu-bar completion]
1004 (cons "Complete" term-completion-menu))
1005 (define-key term-completion-menu [complete-expand]
1006 '("Expand File Name" . term-replace-by-expanded-filename))
1007 (define-key term-completion-menu [complete-listing]
1008 '("File Completion Listing" . term-dynamic-list-filename-completions))
1009 (define-key term-completion-menu [menu-bar completion complete-file]
1010 '("Complete File Name" . term-dynamic-complete-filename))
1011 (define-key term-completion-menu [menu-bar completion complete]
1012 '("Complete Before Point" . term-dynamic-complete))
1014 ;; Input history: (line mode only)
1015 (defvar term-inout-menu (make-sparse-keymap "In/Out"))
1016 (define-key term-mode-map [menu-bar inout]
1017 (cons "In/Out" term-inout-menu))
1018 (define-key term-inout-menu [kill-output]
1019 '("Kill Current Output Group" . term-kill-output))
1020 (define-key term-inout-menu [next-prompt]
1021 '("Forward Output Group" . term-next-prompt))
1022 (define-key term-inout-menu [previous-prompt]
1023 '("Backward Output Group" . term-previous-prompt))
1024 (define-key term-inout-menu [show-maximum-output]
1025 '("Show Maximum Output" . term-show-maximum-output))
1026 (define-key term-inout-menu [show-output]
1027 '("Show Current Output Group" . term-show-output))
1028 (define-key term-inout-menu [kill-input]
1029 '("Kill Current Input" . term-kill-input))
1030 (define-key term-inout-menu [copy-input]
1031 '("Copy Old Input" . term-copy-old-input))
1032 (define-key term-inout-menu [forward-matching-history]
1033 '("Forward Matching Input..." . term-forward-matching-input))
1034 (define-key term-inout-menu [backward-matching-history]
1035 '("Backward Matching Input..." . term-backward-matching-input))
1036 (define-key term-inout-menu [next-matching-history]
1037 '("Next Matching Input..." . term-next-matching-input))
1038 (define-key term-inout-menu [previous-matching-history]
1039 '("Previous Matching Input..." . term-previous-matching-input))
1040 (define-key term-inout-menu [next-matching-history-from-input]
1041 '("Next Matching Current Input" . term-next-matching-input-from-input))
1042 (define-key term-inout-menu [previous-matching-history-from-input]
1043 '("Previous Matching Current Input" .
1044 term-previous-matching-input-from-input))
1045 (define-key term-inout-menu [next-history]
1046 '("Next Input" . term-next-input))
1047 (define-key term-inout-menu [previous-history]
1048 '("Previous Input" . term-previous-input))
1049 (define-key term-inout-menu [list-history]
1050 '("List Input History" . term-dynamic-list-input-ring))
1051 (define-key term-inout-menu [expand-history]
1052 '("Expand History Before Point" . term-replace-by-expanded-history))
1054 ;; Signals
1055 (setq newmap (make-sparse-keymap "Signals"))
1056 (define-key newmap [eof] '("EOF" . term-send-eof))
1057 (define-key newmap [kill] '("KILL" . term-kill-subjob))
1058 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
1059 (define-key newmap [cont] '("CONT" . term-continue-subjob))
1060 (define-key newmap [stop] '("STOP" . term-stop-subjob))
1061 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
1062 (define-key term-mode-map [menu-bar signals]
1063 (setq term-signals-menu (cons "Signals" newmap)))
1066 (defun term-reset-size (height width)
1067 (setq term-height height)
1068 (setq term-width width)
1069 (setq term-start-line-column nil)
1070 (setq term-current-row nil)
1071 (setq term-current-column nil)
1072 (term-scroll-region 0 height))
1074 ;; Recursive routine used to check if any string in term-kill-echo-list
1075 ;; matches part of the buffer before point.
1076 ;; If so, delete that matched part of the buffer - this suppresses echo.
1077 ;; Also, remove that string from the term-kill-echo-list.
1078 ;; We *also* remove any older string on the list, as a sanity measure,
1079 ;; in case something gets out of sync. (Except for type-ahead, there
1080 ;; should only be one element in the list.)
1082 (defun term-check-kill-echo-list ()
1083 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1084 (unwind-protect
1085 (progn
1086 (end-of-line)
1087 (while cur
1088 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1089 (if (and (>= start (point-min))
1090 (string= str (buffer-substring start (point))))
1091 (progn (delete-backward-char len)
1092 (setq term-kill-echo-list (cdr cur))
1093 (setq term-current-column nil)
1094 (setq term-current-row nil)
1095 (setq term-start-line-column nil)
1096 (setq cur nil found t))
1097 (setq cur (cdr cur))))))
1098 (if (not found)
1099 (goto-char save-point)))
1100 found))
1102 (defun term-check-size (process)
1103 (if (or (/= term-height (1- (window-height)))
1104 (/= term-width (1- (window-width))))
1105 (progn
1106 (term-reset-size (1- (window-height)) (1- (window-width)))
1107 (set-process-window-size process term-height term-width))))
1109 (defun term-send-raw-string (chars)
1110 (let ((proc (get-buffer-process (current-buffer))))
1111 (if (not proc)
1112 (error "Current buffer has no process")
1113 ;; Note that (term-current-row) must be called *after*
1114 ;; (point) has been updated to (process-mark proc).
1115 (goto-char (process-mark proc))
1116 (if (term-pager-enabled)
1117 (setq term-pager-count (term-current-row)))
1118 (process-send-string proc chars))))
1120 (defun term-send-raw ()
1121 "Send the last character typed through the terminal-emulator
1122 without any interpretation."
1123 (interactive)
1124 ;; Convert `return' to C-m, etc.
1125 (if (and (symbolp last-input-char)
1126 (get last-input-char 'ascii-character))
1127 (setq last-input-char (get last-input-char 'ascii-character)))
1128 (term-send-raw-string (make-string 1 last-input-char)))
1130 (defun term-send-raw-meta ()
1131 (interactive)
1132 (if (symbolp last-input-char)
1133 ;; Convert `return' to C-m, etc.
1134 (let ((tmp (get last-input-char 'event-symbol-elements)))
1135 (if tmp
1136 (setq last-input-char (car tmp)))
1137 (if (symbolp last-input-char)
1138 (progn
1139 (setq tmp (get last-input-char 'ascii-character))
1140 (if tmp (setq last-input-char tmp))))))
1141 (term-send-raw-string (if (and (numberp last-input-char)
1142 (> last-input-char 127)
1143 (< last-input-char 256))
1144 (make-string 1 last-input-char)
1145 (format "\e%c" last-input-char))))
1147 (defun term-mouse-paste (click arg)
1148 "Insert the last stretch of killed text at the position clicked on."
1149 (interactive "e\nP")
1150 (term-if-xemacs
1151 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
1152 (x-get-cutbuffer)
1153 (error "No selection or cut buffer available"))))
1154 (term-ifnot-xemacs
1155 ;; Give temporary modes such as isearch a chance to turn off.
1156 (run-hooks 'mouse-leave-buffer-hook)
1157 (setq this-command 'yank)
1158 (term-send-raw-string (current-kill (cond
1159 ((listp arg) 0)
1160 ((eq arg '-) -1)
1161 (t (1- arg)))))))
1163 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1164 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1165 ;; For example: vi works with \eOA while elm wants \e[A ...
1166 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1167 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1168 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1169 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1170 (defun term-send-home () (interactive) (term-send-raw-string "\e[H"))
1171 (defun term-send-end () (interactive) (term-send-raw-string "\eOw"))
1172 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1173 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1174 (defun term-send-del () (interactive) (term-send-raw-string "\C-?"))
1175 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-H"))
1177 (defun term-set-escape-char (c)
1178 "Change term-escape-char and keymaps that depend on it."
1179 (if term-escape-char
1180 (define-key term-raw-map term-escape-char 'term-send-raw))
1181 (setq c (make-string 1 c))
1182 (define-key term-raw-map c term-raw-escape-map)
1183 ;; Define standard bindings in term-raw-escape-map
1184 (define-key term-raw-escape-map "\C-x"
1185 (lookup-key (current-global-map) "\C-x"))
1186 (define-key term-raw-escape-map "\C-v"
1187 (lookup-key (current-global-map) "\C-v"))
1188 (define-key term-raw-escape-map "\C-u"
1189 (lookup-key (current-global-map) "\C-u"))
1190 (define-key term-raw-escape-map c 'term-send-raw)
1191 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
1192 ;; The keybinding for term-char-mode is needed by the menubar code.
1193 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
1194 (define-key term-raw-escape-map "\C-j" 'term-line-mode))
1196 (defun term-char-mode ()
1197 "Switch to char (\"raw\") sub-mode of term mode.
1198 Each character you type is sent directly to the inferior without
1199 intervention from Emacs, except for the escape character (usually C-c)."
1200 (interactive)
1201 (if (not term-raw-map)
1202 (let* ((map (make-keymap))
1203 (esc-map (make-keymap))
1204 (i 0))
1205 (while (< i 128)
1206 (define-key map (make-string 1 i) 'term-send-raw)
1207 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
1208 (setq i (1+ i)))
1209 (define-key map "\e" esc-map)
1210 (setq term-raw-map map)
1211 (setq term-raw-escape-map
1212 (copy-keymap (lookup-key (current-global-map) "\C-x")))
1214 ;;; Added nearly all the 'grey keys' -mm
1216 (term-if-emacs19
1217 (term-if-xemacs
1218 (define-key term-raw-map [button2] 'term-mouse-paste))
1219 (term-ifnot-xemacs
1220 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
1221 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
1222 (define-key term-raw-map [menu-bar signals] term-signals-menu))
1223 (define-key term-raw-map [up] 'term-send-up)
1224 (define-key term-raw-map [down] 'term-send-down)
1225 (define-key term-raw-map [right] 'term-send-right)
1226 (define-key term-raw-map [left] 'term-send-left)
1227 (define-key term-raw-map [delete] 'term-send-del)
1228 (define-key term-raw-map [backspace] 'term-send-backspace)
1229 (define-key term-raw-map [home] 'term-send-home)
1230 (define-key term-raw-map [end] 'term-send-end)
1231 (define-key term-raw-map [prior] 'term-send-prior)
1232 (define-key term-raw-map [next] 'term-send-next))
1235 (term-set-escape-char ?\C-c)))
1236 ;; FIXME: Emit message? Cfr ilisp-raw-message
1237 (if (term-in-line-mode)
1238 (progn
1239 (setq term-old-mode-map (current-local-map))
1240 (use-local-map term-raw-map)
1242 ;; Send existing partial line to inferior (without newline).
1243 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1244 (save-input-sender term-input-sender))
1245 (if (> (point) pmark)
1246 (unwind-protect
1247 (progn
1248 (setq term-input-sender
1249 (symbol-function 'term-send-string))
1250 (end-of-line)
1251 (term-send-input))
1252 (setq term-input-sender save-input-sender))))
1253 (term-update-mode-line))))
1255 (defun term-line-mode ()
1256 "Switch to line (\"cooked\") sub-mode of term mode.
1257 This means that Emacs editing commands work as normally, until
1258 you type \\[term-send-input] which sends the current line to the inferior."
1259 (interactive)
1260 (if (term-in-char-mode)
1261 (progn
1262 (use-local-map term-old-mode-map)
1263 (term-update-mode-line))))
1265 (defun term-update-mode-line ()
1266 (setq mode-line-process
1267 (if (term-in-char-mode)
1268 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
1269 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
1270 (force-mode-line-update))
1272 (defun term-check-proc (buffer)
1273 "True if there is a process associated w/buffer BUFFER, and
1274 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
1275 name of one"
1276 (let ((proc (get-buffer-process buffer)))
1277 (and proc (memq (process-status proc) '(run stop)))))
1279 ;;;###autoload
1280 (defun make-term (name program &optional startfile &rest switches)
1281 "Make a term process NAME in a buffer, running PROGRAM.
1282 The name of the buffer is made by surrounding NAME with `*'s.
1283 If there is already a running process in that buffer, it is not restarted.
1284 Optional third arg STARTFILE is the name of a file to send the contents of to
1285 the process. Any more args are arguments to PROGRAM."
1286 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1287 ;; If no process, or nuked process, crank up a new one and put buffer in
1288 ;; term mode. Otherwise, leave buffer and existing process alone.
1289 (cond ((not (term-check-proc buffer))
1290 (save-excursion
1291 (set-buffer buffer)
1292 (term-mode)) ; Install local vars, mode, keymap, ...
1293 (term-exec buffer name program startfile switches)))
1294 buffer))
1296 ;;;###autoload
1297 (defun term (program)
1298 "Start a terminal-emulator in a new buffer."
1299 (interactive (list (read-from-minibuffer "Run program: "
1300 (or explicit-shell-file-name
1301 (getenv "ESHELL")
1302 (getenv "SHELL")
1303 "/bin/sh"))))
1304 (set-buffer (make-term "terminal" program))
1305 (term-mode)
1306 (term-char-mode)
1307 (switch-to-buffer "*terminal*"))
1309 (defun term-exec (buffer name command startfile switches)
1310 "Start up a process in buffer for term modes.
1311 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1312 You can use this to cheaply run a series of processes in the same term
1313 buffer. The hook term-exec-hook is run after each exec."
1314 (save-excursion
1315 (set-buffer buffer)
1316 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1317 (if proc (delete-process proc)))
1318 ;; Crank up a new process
1319 (let ((proc (term-exec-1 name buffer command switches)))
1320 (make-local-variable 'term-ptyp)
1321 (setq term-ptyp process-connection-type) ; T if pty, NIL if pipe.
1322 ;; Jump to the end, and set the process mark.
1323 (goto-char (point-max))
1324 (set-marker (process-mark proc) (point))
1325 (set-process-filter proc 'term-emulate-terminal)
1326 ;; Feed it the startfile.
1327 (cond (startfile
1328 ;;This is guaranteed to wait long enough
1329 ;;but has bad results if the term does not prompt at all
1330 ;; (while (= size (buffer-size))
1331 ;; (sleep-for 1))
1332 ;;I hope 1 second is enough!
1333 (sleep-for 1)
1334 (goto-char (point-max))
1335 (insert-file-contents startfile)
1336 (setq startfile (buffer-substring (point) (point-max)))
1337 (delete-region (point) (point-max))
1338 (term-send-string proc startfile)))
1339 (run-hooks 'term-exec-hook)
1340 buffer)))
1342 ;;; Name to use for TERM.
1343 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1344 (defvar term-term-name "eterm")
1345 ; Format string, usage:
1346 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1347 (defvar term-termcap-format
1348 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1349 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1350 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=\\n\
1351 :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1352 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1353 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1354 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC"
1355 ;;; : -undefine ic
1356 "termcap capabilities supported")
1358 ;;; This auxiliary function cranks up the process for term-exec in
1359 ;;; the appropriate environment.
1361 (defun term-exec-1 (name buffer command switches)
1362 ;; We need to do an extra (fork-less) exec to run stty.
1363 ;; (This would not be needed if we had suitable Emacs primitives.)
1364 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1365 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1366 ;; Thus we add an extra dummy argument "..", and then remove it.
1367 (let ((process-environment
1368 (nconc
1369 (list
1370 (format "TERM=%s" term-term-name)
1371 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
1372 (format "TERMINFO=%s" data-directory)
1373 (format term-termcap-format "TERMCAP="
1374 term-term-name term-height term-width))
1375 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1376 (format "LINES=%d" term-height)
1377 (format "COLUMNS=%d" term-width))
1378 process-environment))
1379 (process-connection-type t))
1380 (apply 'start-process name buffer
1381 "/bin/sh" "-c"
1382 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1383 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1384 term-height term-width)
1385 ".."
1386 command switches)))
1388 ;;; This should be in Emacs, but it isn't.
1389 (defun term-mem (item list &optional elt=)
1390 "Test to see if ITEM is equal to an item in LIST.
1391 Option comparison function ELT= defaults to equal."
1392 (let ((elt= (or elt= (function equal)))
1393 (done nil))
1394 (while (and list (not done))
1395 (if (funcall elt= item (car list))
1396 (setq done list)
1397 (setq list (cdr list))))
1398 done))
1401 ;;; Input history processing in a buffer
1402 ;;; ===========================================================================
1403 ;;; Useful input history functions, courtesy of the Ergo group.
1405 ;;; Eleven commands:
1406 ;;; term-dynamic-list-input-ring List history in help buffer.
1407 ;;; term-previous-input Previous input...
1408 ;;; term-previous-matching-input ...matching a string.
1409 ;;; term-previous-matching-input-from-input ... matching the current input.
1410 ;;; term-next-input Next input...
1411 ;;; term-next-matching-input ...matching a string.
1412 ;;; term-next-matching-input-from-input ... matching the current input.
1413 ;;; term-backward-matching-input Backwards input...
1414 ;;; term-forward-matching-input ...matching a string.
1415 ;;; term-replace-by-expanded-history Expand history at point;
1416 ;;; replace with expanded history.
1417 ;;; term-magic-space Expand history and insert space.
1419 ;;; Three functions:
1420 ;;; term-read-input-ring Read into term-input-ring...
1421 ;;; term-write-input-ring Write to term-input-ring-file-name.
1422 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1424 (defun term-read-input-ring (&optional silent)
1425 "Sets the buffer's `term-input-ring' from a history file.
1426 The name of the file is given by the variable `term-input-ring-file-name'.
1427 The history ring is of size `term-input-ring-size', regardless of file size.
1428 If `term-input-ring-file-name' is nil this function does nothing.
1430 If the optional argument SILENT is non-nil, we say nothing about a
1431 failure to read the history file.
1433 This function is useful for major mode commands and mode hooks.
1435 The structure of the history file should be one input command per line,
1436 with the most recent command last.
1437 See also `term-input-ignoredups' and `term-write-input-ring'."
1438 (cond ((or (null term-input-ring-file-name)
1439 (equal term-input-ring-file-name ""))
1440 nil)
1441 ((not (file-readable-p term-input-ring-file-name))
1442 (or silent
1443 (message "Cannot read history file %s"
1444 term-input-ring-file-name)))
1446 (let ((history-buf (get-buffer-create " *temp*"))
1447 (file term-input-ring-file-name)
1448 (count 0)
1449 (ring (make-ring term-input-ring-size)))
1450 (unwind-protect
1451 (save-excursion
1452 (set-buffer history-buf)
1453 (widen)
1454 (erase-buffer)
1455 (insert-file-contents file)
1456 ;; Save restriction in case file is already visited...
1457 ;; Watch for those date stamps in history files!
1458 (goto-char (point-max))
1459 (while (and (< count term-input-ring-size)
1460 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1461 nil t))
1462 (let ((history (buffer-substring (match-beginning 1)
1463 (match-end 1))))
1464 (if (or (null term-input-ignoredups)
1465 (ring-empty-p ring)
1466 (not (string-equal (ring-ref ring 0) history)))
1467 (ring-insert-at-beginning ring history)))
1468 (setq count (1+ count))))
1469 (kill-buffer history-buf))
1470 (setq term-input-ring ring
1471 term-input-ring-index nil)))))
1473 (defun term-write-input-ring ()
1474 "Writes the buffer's `term-input-ring' to a history file.
1475 The name of the file is given by the variable `term-input-ring-file-name'.
1476 The original contents of the file are lost if `term-input-ring' is not empty.
1477 If `term-input-ring-file-name' is nil this function does nothing.
1479 Useful within process sentinels.
1481 See also `term-read-input-ring'."
1482 (cond ((or (null term-input-ring-file-name)
1483 (equal term-input-ring-file-name "")
1484 (null term-input-ring) (ring-empty-p term-input-ring))
1485 nil)
1486 ((not (file-writable-p term-input-ring-file-name))
1487 (message "Cannot write history file %s" term-input-ring-file-name))
1489 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1490 (ring term-input-ring)
1491 (file term-input-ring-file-name)
1492 (index (ring-length ring)))
1493 ;; Write it all out into a buffer first. Much faster, but messier,
1494 ;; than writing it one line at a time.
1495 (save-excursion
1496 (set-buffer history-buf)
1497 (erase-buffer)
1498 (while (> index 0)
1499 (setq index (1- index))
1500 (insert (ring-ref ring index) ?\n))
1501 (write-region (buffer-string) nil file nil 'no-message)
1502 (kill-buffer nil))))))
1505 (defun term-dynamic-list-input-ring ()
1506 "List in help buffer the buffer's input history."
1507 (interactive)
1508 (if (or (not (ring-p term-input-ring))
1509 (ring-empty-p term-input-ring))
1510 (message "No history")
1511 (let ((history nil)
1512 (history-buffer " *Input History*")
1513 (index (1- (ring-length term-input-ring)))
1514 (conf (current-window-configuration)))
1515 ;; We have to build up a list ourselves from the ring vector.
1516 (while (>= index 0)
1517 (setq history (cons (ring-ref term-input-ring index) history)
1518 index (1- index)))
1519 ;; Change "completion" to "history reference"
1520 ;; to make the display accurate.
1521 (with-output-to-temp-buffer history-buffer
1522 (display-completion-list history)
1523 (set-buffer history-buffer)
1524 (forward-line 3)
1525 (while (search-backward "completion" nil 'move)
1526 (replace-match "history reference")))
1527 (sit-for 0)
1528 (message "Hit space to flush")
1529 (let ((ch (read-event)))
1530 (if (eq ch ?\ )
1531 (set-window-configuration conf)
1532 (setq unread-command-events (list ch)))))))
1535 (defun term-regexp-arg (prompt)
1536 ;; Return list of regexp and prefix arg using PROMPT.
1537 (let* ((minibuffer-history-sexp-flag nil)
1538 ;; Don't clobber this.
1539 (last-command last-command)
1540 (regexp (read-from-minibuffer prompt nil nil nil
1541 'minibuffer-history-search-history)))
1542 (list (if (string-equal regexp "")
1543 (setcar minibuffer-history-search-history
1544 (nth 1 minibuffer-history-search-history))
1545 regexp)
1546 (prefix-numeric-value current-prefix-arg))))
1548 (defun term-search-arg (arg)
1549 ;; First make sure there is a ring and that we are after the process mark
1550 (cond ((not (term-after-pmark-p))
1551 (error "Not at command line"))
1552 ((or (null term-input-ring)
1553 (ring-empty-p term-input-ring))
1554 (error "Empty input ring"))
1555 ((zerop arg)
1556 ;; arg of zero resets search from beginning, and uses arg of 1
1557 (setq term-input-ring-index nil)
1560 arg)))
1562 (defun term-search-start (arg)
1563 ;; Index to start a directional search, starting at term-input-ring-index
1564 (if term-input-ring-index
1565 ;; If a search is running, offset by 1 in direction of arg
1566 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1567 (ring-length term-input-ring))
1568 ;; For a new search, start from beginning or end, as appropriate
1569 (if (>= arg 0)
1570 0 ; First elt for forward search
1571 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1573 (defun term-previous-input-string (arg)
1574 "Return the string ARG places along the input ring.
1575 Moves relative to `term-input-ring-index'."
1576 (ring-ref term-input-ring (if term-input-ring-index
1577 (mod (+ arg term-input-ring-index)
1578 (ring-length term-input-ring))
1579 arg)))
1581 (defun term-previous-input (arg)
1582 "Cycle backwards through input history."
1583 (interactive "*p")
1584 (term-previous-matching-input "." arg))
1586 (defun term-next-input (arg)
1587 "Cycle forwards through input history."
1588 (interactive "*p")
1589 (term-previous-input (- arg)))
1591 (defun term-previous-matching-input-string (regexp arg)
1592 "Return the string matching REGEXP ARG places along the input ring.
1593 Moves relative to `term-input-ring-index'."
1594 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1595 (if pos (ring-ref term-input-ring pos))))
1597 (defun term-previous-matching-input-string-position
1598 (regexp arg &optional start)
1599 "Return the index matching REGEXP ARG places along the input ring.
1600 Moves relative to START, or `term-input-ring-index'."
1601 (if (or (not (ring-p term-input-ring))
1602 (ring-empty-p term-input-ring))
1603 (error "No history"))
1604 (let* ((len (ring-length term-input-ring))
1605 (motion (if (> arg 0) 1 -1))
1606 (n (mod (- (or start (term-search-start arg)) motion) len))
1607 (tried-each-ring-item nil)
1608 (prev nil))
1609 ;; Do the whole search as many times as the argument says.
1610 (while (and (/= arg 0) (not tried-each-ring-item))
1611 ;; Step once.
1612 (setq prev n
1613 n (mod (+ n motion) len))
1614 ;; If we haven't reached a match, step some more.
1615 (while (and (< n len) (not tried-each-ring-item)
1616 (not (string-match regexp (ring-ref term-input-ring n))))
1617 (setq n (mod (+ n motion) len)
1618 ;; If we have gone all the way around in this search.
1619 tried-each-ring-item (= n prev)))
1620 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1621 ;; Now that we know which ring element to use, if we found it, return that.
1622 (if (string-match regexp (ring-ref term-input-ring n))
1623 n)))
1625 (defun term-previous-matching-input (regexp arg)
1626 "Search backwards through input history for match for REGEXP.
1627 \(Previous history elements are earlier commands.)
1628 With prefix argument N, search for Nth previous match.
1629 If N is negative, find the next or Nth next match."
1630 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1631 (setq arg (term-search-arg arg))
1632 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1633 ;; Has a match been found?
1634 (if (null pos)
1635 (error "Not found")
1636 (setq term-input-ring-index pos)
1637 (message "History item: %d" (1+ pos))
1638 (delete-region
1639 ;; Can't use kill-region as it sets this-command
1640 (process-mark (get-buffer-process (current-buffer))) (point))
1641 (insert (ring-ref term-input-ring pos)))))
1643 (defun term-next-matching-input (regexp arg)
1644 "Search forwards through input history for match for REGEXP.
1645 \(Later history elements are more recent commands.)
1646 With prefix argument N, search for Nth following match.
1647 If N is negative, find the previous or Nth previous match."
1648 (interactive (term-regexp-arg "Next input matching (regexp): "))
1649 (term-previous-matching-input regexp (- arg)))
1651 (defun term-previous-matching-input-from-input (arg)
1652 "Search backwards through input history for match for current input.
1653 \(Previous history elements are earlier commands.)
1654 With prefix argument N, search for Nth previous match.
1655 If N is negative, search forwards for the -Nth following match."
1656 (interactive "p")
1657 (if (not (memq last-command '(term-previous-matching-input-from-input
1658 term-next-matching-input-from-input)))
1659 ;; Starting a new search
1660 (setq term-matching-input-from-input-string
1661 (buffer-substring
1662 (process-mark (get-buffer-process (current-buffer)))
1663 (point))
1664 term-input-ring-index nil))
1665 (term-previous-matching-input
1666 (concat "^" (regexp-quote term-matching-input-from-input-string))
1667 arg))
1669 (defun term-next-matching-input-from-input (arg)
1670 "Search forwards through input history for match for current input.
1671 \(Following history elements are more recent commands.)
1672 With prefix argument N, search for Nth following match.
1673 If N is negative, search backwards for the -Nth previous match."
1674 (interactive "p")
1675 (term-previous-matching-input-from-input (- arg)))
1678 (defun term-replace-by-expanded-history (&optional silent)
1679 "Expand input command history references before point.
1680 Expansion is dependent on the value of `term-input-autoexpand'.
1682 This function depends on the buffer's idea of the input history, which may not
1683 match the command interpreter's idea, assuming it has one.
1685 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1686 cannot know the interpreter's idea of input line numbers, assuming it has one,
1687 it cannot expand absolute input line number references.
1689 If the optional argument SILENT is non-nil, never complain
1690 even if history reference seems erroneous.
1692 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1694 Returns t if successful."
1695 (interactive)
1696 (if (and term-input-autoexpand
1697 (string-match "[!^]" (funcall term-get-old-input))
1698 (save-excursion (beginning-of-line)
1699 (looking-at term-prompt-regexp)))
1700 ;; Looks like there might be history references in the command.
1701 (let ((previous-modified-tick (buffer-modified-tick)))
1702 (message "Expanding history references...")
1703 (term-replace-by-expanded-history-before-point silent)
1704 (/= previous-modified-tick (buffer-modified-tick)))))
1707 (defun term-replace-by-expanded-history-before-point (silent)
1708 "Expand directory stack reference before point.
1709 See `term-replace-by-expanded-history'. Returns t if successful."
1710 (save-excursion
1711 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1712 (start (progn (term-bol nil) (point))))
1713 (while (progn
1714 (skip-chars-forward "^!^"
1715 (save-excursion
1716 (end-of-line nil) (- (point) toend)))
1717 (< (point)
1718 (save-excursion
1719 (end-of-line nil) (- (point) toend))))
1720 ;; This seems a bit complex. We look for references such as !!, !-num,
1721 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1722 ;; If that wasn't enough, the plings can be suffixed with argument
1723 ;; range specifiers.
1724 ;; Argument ranges are complex too, so we hive off the input line,
1725 ;; referenced with plings, with the range string to `term-args'.
1726 (setq term-input-ring-index nil)
1727 (cond ((or (= (preceding-char) ?\\)
1728 (term-within-quotes start (point)))
1729 ;; The history is quoted, or we're in quotes.
1730 (goto-char (1+ (point))))
1731 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1732 ;; We cannot know the interpreter's idea of input line numbers.
1733 (goto-char (match-end 0))
1734 (message "Absolute reference cannot be expanded"))
1735 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1736 ;; Just a number of args from `number' lines backward.
1737 (let ((number (1- (string-to-number
1738 (buffer-substring (match-beginning 1)
1739 (match-end 1))))))
1740 (if (<= number (ring-length term-input-ring))
1741 (progn
1742 (replace-match
1743 (term-args (term-previous-input-string number)
1744 (match-beginning 2) (match-end 2))
1745 t t)
1746 (setq term-input-ring-index number)
1747 (message "History item: %d" (1+ number)))
1748 (goto-char (match-end 0))
1749 (message "Relative reference exceeds input history size"))))
1750 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1751 ;; Just a number of args from the previous input line.
1752 (replace-match
1753 (term-args (term-previous-input-string 0)
1754 (match-beginning 1) (match-end 1))
1755 t t)
1756 (message "History item: previous"))
1757 ((looking-at
1758 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1759 ;; Most recent input starting with or containing (possibly
1760 ;; protected) string, maybe just a number of args. Phew.
1761 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1762 (mb2 (match-beginning 2)) (me2 (match-end 2))
1763 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1764 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1765 (pos (save-match-data
1766 (term-previous-matching-input-string-position
1767 (concat pref (regexp-quote exp)) 1))))
1768 (if (null pos)
1769 (progn
1770 (goto-char (match-end 0))
1771 (or silent
1772 (progn (message "Not found")
1773 (ding))))
1774 (setq term-input-ring-index pos)
1775 (replace-match
1776 (term-args (ring-ref term-input-ring pos)
1777 (match-beginning 4) (match-end 4))
1778 t t)
1779 (message "History item: %d" (1+ pos)))))
1780 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1781 ;; Quick substitution on the previous input line.
1782 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1783 (new (buffer-substring (match-beginning 2) (match-end 2)))
1784 (pos nil))
1785 (replace-match (term-previous-input-string 0) t t)
1786 (setq pos (point))
1787 (goto-char (match-beginning 0))
1788 (if (not (search-forward old pos t))
1789 (or silent
1790 (error "Not found"))
1791 (replace-match new t t)
1792 (message "History item: substituted"))))
1794 (goto-char (match-end 0))))))))
1797 (defun term-magic-space (arg)
1798 "Expand input history references before point and insert ARG spaces.
1799 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1800 (interactive "p")
1801 (term-replace-by-expanded-history)
1802 (self-insert-command arg))
1804 (defun term-within-quotes (beg end)
1805 "Return t if the number of quotes between BEG and END is odd.
1806 Quotes are single and double."
1807 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1808 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1809 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1811 (defun term-how-many-region (regexp beg end)
1812 "Return number of matches for REGEXP from BEG to END."
1813 (let ((count 0))
1814 (save-excursion
1815 (save-match-data
1816 (goto-char beg)
1817 (while (re-search-forward regexp end t)
1818 (setq count (1+ count)))))
1819 count))
1821 (defun term-args (string begin end)
1822 ;; From STRING, return the args depending on the range specified in the text
1823 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1824 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1825 (save-match-data
1826 (if (null begin)
1827 (term-arguments string 0 nil)
1828 (let* ((range (buffer-substring
1829 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1830 (nth (cond ((string-match "^[*^]" range) 1)
1831 ((string-match "^-" range) 0)
1832 ((string-equal range "$") nil)
1833 (t (string-to-number range))))
1834 (mth (cond ((string-match "[-*$]$" range) nil)
1835 ((string-match "-" range)
1836 (string-to-number (substring range (match-end 0))))
1837 (t nth))))
1838 (term-arguments string nth mth)))))
1840 ;; Return a list of arguments from ARG. Break it up at the
1841 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1842 (defun term-delim-arg (arg)
1843 (if (null term-delimiter-argument-list)
1844 (list arg)
1845 (let ((args nil)
1846 (pos 0)
1847 (len (length arg)))
1848 (while (< pos len)
1849 (let ((char (aref arg pos))
1850 (start pos))
1851 (if (memq char term-delimiter-argument-list)
1852 (while (and (< pos len) (eq (aref arg pos) char))
1853 (setq pos (1+ pos)))
1854 (while (and (< pos len)
1855 (not (memq (aref arg pos)
1856 term-delimiter-argument-list)))
1857 (setq pos (1+ pos))))
1858 (setq args (cons (substring arg start pos) args))))
1859 args)))
1861 (defun term-arguments (string nth mth)
1862 "Return from STRING the NTH to MTH arguments.
1863 NTH and/or MTH can be nil, which means the last argument.
1864 Returned arguments are separated by single spaces.
1865 We assume whitespace separates arguments, except within quotes.
1866 Also, a run of one or more of a single character
1867 in `term-delimiter-argument-list' is a separate argument.
1868 Argument 0 is the command name."
1869 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1870 (args ()) (pos 0)
1871 (count 0)
1872 beg str quotes)
1873 ;; Build a list of all the args until we have as many as we want.
1874 (while (and (or (null mth) (<= count mth))
1875 (string-match argpart string pos))
1876 (if (and beg (= pos (match-beginning 0)))
1877 ;; It's contiguous, part of the same arg.
1878 (setq pos (match-end 0)
1879 quotes (or quotes (match-beginning 1)))
1880 ;; It's a new separate arg.
1881 (if beg
1882 ;; Put the previous arg, if there was one, onto ARGS.
1883 (setq str (substring string beg pos)
1884 args (if quotes (cons str args)
1885 (nconc (term-delim-arg str) args))
1886 count (1+ count)))
1887 (setq quotes (match-beginning 1))
1888 (setq beg (match-beginning 0))
1889 (setq pos (match-end 0))))
1890 (if beg
1891 (setq str (substring string beg pos)
1892 args (if quotes (cons str args)
1893 (nconc (term-delim-arg str) args))
1894 count (1+ count)))
1895 (let ((n (or nth (1- count)))
1896 (m (if mth (1- (- count mth)) 0)))
1897 (mapconcat
1898 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1901 ;;; Input processing stuff [line mode]
1904 (defun term-send-input ()
1905 "Send input to process.
1906 After the process output mark, sends all text from the process mark to
1907 point as input to the process. Before the process output mark, calls value
1908 of variable term-get-old-input to retrieve old input, copies it to the
1909 process mark, and sends it. A terminal newline is also inserted into the
1910 buffer and sent to the process. The list of function names contained in the
1911 value of `term-input-filter-functions' is called on the input before sending
1912 it. The input is entered into the input history ring, if the value of variable
1913 term-input-filter returns non-nil when called on the input.
1915 Any history reference may be expanded depending on the value of the variable
1916 `term-input-autoexpand'. The list of function names contained in the value
1917 of `term-input-filter-functions' is called on the input before sending it.
1918 The input is entered into the input history ring, if the value of variable
1919 `term-input-filter' returns non-nil when called on the input.
1921 If variable `term-eol-on-send' is non-nil, then point is moved to the
1922 end of line before sending the input.
1924 The values of `term-get-old-input', `term-input-filter-functions', and
1925 `term-input-filter' are chosen according to the command interpreter running
1926 in the buffer. E.g.,
1928 If the interpreter is the csh,
1929 term-get-old-input is the default: take the current line, discard any
1930 initial string matching regexp term-prompt-regexp.
1931 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
1932 \"popd\" commands. When it sees one, it cd's the buffer.
1933 term-input-filter is the default: returns T if the input isn't all white
1934 space.
1936 If the term is Lucid Common Lisp,
1937 term-get-old-input snarfs the sexp ending at point.
1938 term-input-filter-functions does nothing.
1939 term-input-filter returns NIL if the input matches input-filter-regexp,
1940 which matches (1) all whitespace (2) :a, :c, etc.
1942 Similarly for Soar, Scheme, etc."
1943 (interactive)
1944 ;; Note that the input string does not include its terminal newline.
1945 (let ((proc (get-buffer-process (current-buffer))))
1946 (if (not proc) (error "Current buffer has no process")
1947 (let* ((pmark (process-mark proc))
1948 (pmark-val (marker-position pmark))
1949 (input-is-new (>= (point) pmark-val))
1950 (intxt (if input-is-new
1951 (progn (if term-eol-on-send (end-of-line))
1952 (buffer-substring pmark (point)))
1953 (funcall term-get-old-input)))
1954 (input (if (not (eq term-input-autoexpand 'input))
1955 ;; Just whatever's already there
1956 intxt
1957 ;; Expand and leave it visible in buffer
1958 (term-replace-by-expanded-history t)
1959 (buffer-substring pmark (point))))
1960 (history (if (not (eq term-input-autoexpand 'history))
1961 input
1962 ;; This is messy 'cos ultimately the original
1963 ;; functions used do insertion, rather than return
1964 ;; strings. We have to expand, then insert back.
1965 (term-replace-by-expanded-history t)
1966 (let ((copy (buffer-substring pmark (point))))
1967 (delete-region pmark (point))
1968 (insert input)
1969 copy))))
1970 (if (term-pager-enabled)
1971 (save-excursion
1972 (goto-char (process-mark proc))
1973 (setq term-pager-count (term-current-row))))
1974 (if (and (funcall term-input-filter history)
1975 (or (null term-input-ignoredups)
1976 (not (ring-p term-input-ring))
1977 (ring-empty-p term-input-ring)
1978 (not (string-equal (ring-ref term-input-ring 0)
1979 history))))
1980 (ring-insert term-input-ring history))
1981 (let ((functions term-input-filter-functions))
1982 (while functions
1983 (funcall (car functions) (concat input "\n"))
1984 (setq functions (cdr functions))))
1985 (setq term-input-ring-index nil)
1987 ;; Update the markers before we send the input
1988 ;; in case we get output amidst sending the input.
1989 (set-marker term-last-input-start pmark)
1990 (set-marker term-last-input-end (point))
1991 (if input-is-new
1992 (progn
1993 ;; Set up to delete, because inferior should echo.
1994 (if (marker-buffer term-pending-delete-marker)
1995 (delete-region term-pending-delete-marker pmark))
1996 (set-marker term-pending-delete-marker pmark-val)
1997 (set-marker (process-mark proc) (point))))
1998 (goto-char pmark)
1999 (funcall term-input-sender proc input)))))
2001 (defun term-get-old-input-default ()
2002 "Default for term-get-old-input.
2003 Take the current line, and discard any initial text matching
2004 term-prompt-regexp."
2005 (save-excursion
2006 (beginning-of-line)
2007 (term-skip-prompt)
2008 (let ((beg (point)))
2009 (end-of-line)
2010 (buffer-substring beg (point)))))
2012 (defun term-copy-old-input ()
2013 "Insert after prompt old input at point as new input to be edited.
2014 Calls `term-get-old-input' to get old input."
2015 (interactive)
2016 (let ((input (funcall term-get-old-input))
2017 (process (get-buffer-process (current-buffer))))
2018 (if (not process)
2019 (error "Current buffer has no process")
2020 (goto-char (process-mark process))
2021 (insert input))))
2023 (defun term-skip-prompt ()
2024 "Skip past the text matching regexp term-prompt-regexp.
2025 If this takes us past the end of the current line, don't skip at all."
2026 (let ((eol (save-excursion (end-of-line) (point))))
2027 (if (and (looking-at term-prompt-regexp)
2028 (<= (match-end 0) eol))
2029 (goto-char (match-end 0)))))
2032 (defun term-after-pmark-p ()
2033 "Is point after the process output marker?"
2034 ;; Since output could come into the buffer after we looked at the point
2035 ;; but before we looked at the process marker's value, we explicitly
2036 ;; serialise. This is just because I don't know whether or not Emacs
2037 ;; services input during execution of lisp commands.
2038 (let ((proc-pos (marker-position
2039 (process-mark (get-buffer-process (current-buffer))))))
2040 (<= proc-pos (point))))
2042 (defun term-simple-send (proc string)
2043 "Default function for sending to PROC input STRING.
2044 This just sends STRING plus a newline. To override this,
2045 set the hook TERM-INPUT-SENDER."
2046 (term-send-string proc string)
2047 (term-send-string proc "\n"))
2049 (defun term-bol (arg)
2050 "Goes to the beginning of line, then skips past the prompt, if any.
2051 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2052 -- go straight to column 0.
2054 The prompt skip is done by skipping text matching the regular expression
2055 term-prompt-regexp, a buffer local variable."
2056 (interactive "P")
2057 (beginning-of-line)
2058 (if (null arg) (term-skip-prompt)))
2060 ;;; These two functions are for entering text you don't want echoed or
2061 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2062 ;;; Just enter m-x term-send-invisible and type in your line.
2064 (defun term-read-noecho (prompt &optional stars)
2065 "Read a single line of text from user without echoing, and return it.
2066 Prompt with argument PROMPT, a string. Optional argument STARS causes
2067 input to be echoed with '*' characters on the prompt line. Input ends with
2068 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2069 `inhibit-quit' is set because e.g. this function was called from a process
2070 filter and C-g is pressed, this function returns nil rather than a string).
2072 Note that the keystrokes comprising the text can still be recovered
2073 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2074 applications."
2075 (let ((ans "")
2076 (c 0)
2077 (echo-keystrokes 0)
2078 (cursor-in-echo-area t)
2079 (done nil))
2080 (while (not done)
2081 (if stars
2082 (message "%s%s" prompt (make-string (length ans) ?*))
2083 (message "%s" prompt))
2084 (setq c (read-char))
2085 (cond ((= c ?\C-g)
2086 ;; This function may get called from a process filter, where
2087 ;; inhibit-quit is set. In later versions of Emacs read-char
2088 ;; may clear quit-flag itself and return C-g. That would make
2089 ;; it impossible to quit this loop in a simple way, so
2090 ;; re-enable it here (for backward-compatibility the check for
2091 ;; quit-flag below would still be necessary, so this seems
2092 ;; like the simplest way to do things).
2093 (setq quit-flag t
2094 done t))
2095 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2096 (setq done t))
2097 ((= c ?\C-u)
2098 (setq ans ""))
2099 ((and (/= c ?\b) (/= c ?\177))
2100 (setq ans (concat ans (char-to-string c))))
2101 ((> (length ans) 0)
2102 (setq ans (substring ans 0 -1)))))
2103 (if quit-flag
2104 ;; Emulate a true quit, except that we have to return a value.
2105 (prog1
2106 (setq quit-flag nil)
2107 (message "Quit")
2108 (beep t))
2109 (message "")
2110 ans)))
2112 (defun term-send-invisible (str &optional proc)
2113 "Read a string without echoing.
2114 Then send it to the process running in the current buffer. A new-line
2115 is additionally sent. String is not saved on term input history list.
2116 Security bug: your string can still be temporarily recovered with
2117 \\[view-lossage]."
2118 (interactive "P") ; Defeat snooping via C-x esc
2119 (if (not (stringp str))
2120 (setq str (term-read-noecho "Non-echoed text: " t)))
2121 (if (not proc)
2122 (setq proc (get-buffer-process (current-buffer))))
2123 (if (not proc) (error "Current buffer has no process")
2124 (setq term-kill-echo-list (nconc term-kill-echo-list
2125 (cons str nil)))
2126 (term-send-string proc str)
2127 (term-send-string proc "\n")))
2130 ;;; Low-level process communication
2132 (defvar term-input-chunk-size 512
2133 "*Long inputs send to term processes are broken up into chunks of this size.
2134 If your process is choking on big inputs, try lowering the value.")
2136 (defun term-send-string (proc str)
2137 "Send PROCESS the contents of STRING as input.
2138 This is equivalent to process-send-string, except that long input strings
2139 are broken up into chunks of size term-input-chunk-size. Processes
2140 are given a chance to output between chunks. This can help prevent processes
2141 from hanging when you send them long inputs on some OS's."
2142 (let* ((len (length str))
2143 (i (min len term-input-chunk-size)))
2144 (process-send-string proc (substring str 0 i))
2145 (while (< i len)
2146 (let ((next-i (+ i term-input-chunk-size)))
2147 (accept-process-output)
2148 (process-send-string proc (substring str i (min len next-i)))
2149 (setq i next-i)))))
2151 (defun term-send-region (proc start end)
2152 "Sends to PROC the region delimited by START and END.
2153 This is a replacement for process-send-region that tries to keep
2154 your process from hanging on long inputs. See term-send-string."
2155 (term-send-string proc (buffer-substring start end)))
2158 ;;; Random input hackage
2160 (defun term-kill-output ()
2161 "Kill all output from interpreter since last input."
2162 (interactive)
2163 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2164 (kill-region term-last-input-end pmark)
2165 (goto-char pmark)
2166 (insert "*** output flushed ***\n")
2167 (set-marker pmark (point))))
2169 (defun term-show-output ()
2170 "Display start of this batch of interpreter output at top of window.
2171 Sets mark to the value of point when this command is run."
2172 (interactive)
2173 (goto-char term-last-input-end)
2174 (backward-char)
2175 (beginning-of-line)
2176 (set-window-start (selected-window) (point))
2177 (end-of-line))
2179 (defun term-interrupt-subjob ()
2180 "Interrupt the current subjob."
2181 (interactive)
2182 (interrupt-process nil term-ptyp))
2184 (defun term-kill-subjob ()
2185 "Send kill signal to the current subjob."
2186 (interactive)
2187 (kill-process nil term-ptyp))
2189 (defun term-quit-subjob ()
2190 "Send quit signal to the current subjob."
2191 (interactive)
2192 (quit-process nil term-ptyp))
2194 (defun term-stop-subjob ()
2195 "Stop the current subjob.
2196 WARNING: if there is no current subjob, you can end up suspending
2197 the top-level process running in the buffer. If you accidentally do
2198 this, use \\[term-continue-subjob] to resume the process. (This
2199 is not a problem with most shells, since they ignore this signal.)"
2200 (interactive)
2201 (stop-process nil term-ptyp))
2203 (defun term-continue-subjob ()
2204 "Send CONT signal to process buffer's process group.
2205 Useful if you accidentally suspend the top-level process."
2206 (interactive)
2207 (continue-process nil term-ptyp))
2209 (defun term-kill-input ()
2210 "Kill all text from last stuff output by interpreter to point."
2211 (interactive)
2212 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2213 (p-pos (marker-position pmark)))
2214 (if (> (point) p-pos)
2215 (kill-region pmark (point)))))
2217 (defun term-delchar-or-maybe-eof (arg)
2218 "Delete ARG characters forward, or send an EOF to process if at end of
2219 buffer."
2220 (interactive "p")
2221 (if (eobp)
2222 (process-send-eof)
2223 (delete-char arg)))
2225 (defun term-send-eof ()
2226 "Send an EOF to the current buffer's process."
2227 (interactive)
2228 (process-send-eof))
2230 (defun term-backward-matching-input (regexp arg)
2231 "Search backward through buffer for match for REGEXP.
2232 Matches are searched for on lines that match `term-prompt-regexp'.
2233 With prefix argument N, search for Nth previous match.
2234 If N is negative, find the next or Nth next match."
2235 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2236 (let* ((re (concat term-prompt-regexp ".*" regexp))
2237 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2238 (if (re-search-backward re nil t arg)
2239 (point)))))
2240 (if (null pos)
2241 (progn (message "Not found")
2242 (ding))
2243 (goto-char pos)
2244 (term-bol nil))))
2246 (defun term-forward-matching-input (regexp arg)
2247 "Search forward through buffer for match for REGEXP.
2248 Matches are searched for on lines that match `term-prompt-regexp'.
2249 With prefix argument N, search for Nth following match.
2250 If N is negative, find the previous or Nth previous match."
2251 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2252 (term-backward-matching-input regexp (- arg)))
2255 (defun term-next-prompt (n)
2256 "Move to end of Nth next prompt in the buffer.
2257 See `term-prompt-regexp'."
2258 (interactive "p")
2259 (let ((paragraph-start term-prompt-regexp))
2260 (end-of-line (if (> n 0) 1 0))
2261 (forward-paragraph n)
2262 (term-skip-prompt)))
2264 (defun term-previous-prompt (n)
2265 "Move to end of Nth previous prompt in the buffer.
2266 See `term-prompt-regexp'."
2267 (interactive "p")
2268 (term-next-prompt (- n)))
2270 ;;; Support for source-file processing commands.
2271 ;;;============================================================================
2272 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2273 ;;; commands that process files of source text (e.g. loading or compiling
2274 ;;; files). So the corresponding process-in-a-buffer modes have commands
2275 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2276 ;;; for defining these commands.
2278 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2279 ;;; and Soar, in that they don't know anything about file extensions.
2280 ;;; So the compile/load interface gets the wrong default occasionally.
2281 ;;; The load-file/compile-file default mechanism could be smarter -- it
2282 ;;; doesn't know about the relationship between filename extensions and
2283 ;;; whether the file is source or executable. If you compile foo.lisp
2284 ;;; with compile-file, then the next load-file should use foo.bin for
2285 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2286 ;;; because the extension for executable files varies so much (.o, .bin,
2287 ;;; .lbin, .mo, .vo, .ao, ...).
2290 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2291 ;;; commands.
2293 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2294 ;;; want to save the buffer before issuing any process requests to the command
2295 ;;; interpreter.
2297 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2298 ;;; for the file to process.
2300 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2301 ;;;============================================================================
2302 ;;; This function computes the defaults for the load-file and compile-file
2303 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2305 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2306 ;;; source-file processing command, or nil if there hasn't been one yet.
2307 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2308 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2309 ;;; Typically, (lisp-mode) or (scheme-mode).
2311 ;;; If the command is given while the cursor is inside a string, *and*
2312 ;;; the string is an existing filename, *and* the filename is not a directory,
2313 ;;; then the string is taken as default. This allows you to just position
2314 ;;; your cursor over a string that's a filename and have it taken as default.
2316 ;;; If the command is given in a file buffer whose major mode is in
2317 ;;; SOURCE-MODES, then the the filename is the default file, and the
2318 ;;; file's directory is the default directory.
2320 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2321 ;;; then the default directory & file are what was used in the last source-file
2322 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2323 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2324 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2326 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2327 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2328 ;;; for Soar programs, etc.
2330 ;;; The function returns a pair: (default-directory . default-file).
2332 (defun term-source-default (previous-dir/file source-modes)
2333 (cond ((and buffer-file-name (memq major-mode source-modes))
2334 (cons (file-name-directory buffer-file-name)
2335 (file-name-nondirectory buffer-file-name)))
2336 (previous-dir/file)
2338 (cons default-directory nil))))
2341 ;;; (TERM-CHECK-SOURCE fname)
2342 ;;;============================================================================
2343 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2344 ;;; process-in-a-buffer modes), this function can be called on the filename.
2345 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2346 ;;; is queried to see if he wants to save the buffer before proceeding with
2347 ;;; the load or compile.
2349 (defun term-check-source (fname)
2350 (let ((buff (get-file-buffer fname)))
2351 (if (and buff
2352 (buffer-modified-p buff)
2353 (y-or-n-p (format "Save buffer %s first? "
2354 (buffer-name buff))))
2355 ;; save BUFF.
2356 (let ((old-buffer (current-buffer)))
2357 (set-buffer buff)
2358 (save-buffer)
2359 (set-buffer old-buffer)))))
2362 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2363 ;;;============================================================================
2364 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2365 ;;; commands that process source files (like loading or compiling a file).
2366 ;;; It prompts for the filename, provides a default, if there is one,
2367 ;;; and returns the result filename.
2369 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2371 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2372 ;;; from the last source processing command. SOURCE-MODES is a list of major
2373 ;;; modes used to determine what file buffers contain source files. (These
2374 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2375 ;;; then the filename reader will only accept a file that exists.
2377 ;;; A typical use:
2378 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2379 ;;; '(lisp-mode) t))
2381 ;;; This is pretty stupid about strings. It decides we're in a string
2382 ;;; if there's a quote on both sides of point on the current line.
2383 (defun term-extract-string ()
2384 "Returns string around POINT that starts the current line or nil."
2385 (save-excursion
2386 (let* ((point (point))
2387 (bol (progn (beginning-of-line) (point)))
2388 (eol (progn (end-of-line) (point)))
2389 (start (progn (goto-char point)
2390 (and (search-backward "\"" bol t)
2391 (1+ (point)))))
2392 (end (progn (goto-char point)
2393 (and (search-forward "\"" eol t)
2394 (1- (point))))))
2395 (and start end
2396 (buffer-substring start end)))))
2398 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2399 (let* ((def (term-source-default prev-dir/file source-modes))
2400 (stringfile (term-extract-string))
2401 (sfile-p (and stringfile
2402 (condition-case ()
2403 (file-exists-p stringfile)
2404 (error nil))
2405 (not (file-directory-p stringfile))))
2406 (defdir (if sfile-p (file-name-directory stringfile)
2407 (car def)))
2408 (deffile (if sfile-p (file-name-nondirectory stringfile)
2409 (cdr def)))
2410 (ans (read-file-name (if deffile (format "%s(default %s) "
2411 prompt deffile)
2412 prompt)
2413 defdir
2414 (concat defdir deffile)
2415 mustmatch-p)))
2416 (list (expand-file-name (substitute-in-file-name ans)))))
2418 ;;; I am somewhat divided on this string-default feature. It seems
2419 ;;; to violate the principle-of-least-astonishment, in that it makes
2420 ;;; the default harder to predict, so you actually have to look and see
2421 ;;; what the default really is before choosing it. This can trip you up.
2422 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2423 ;;; on this.
2424 ;;; -Olin
2427 ;;; Simple process query facility.
2428 ;;; ===========================================================================
2429 ;;; This function is for commands that want to send a query to the process
2430 ;;; and show the response to the user. For example, a command to get the
2431 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2432 ;;; to an inferior Common Lisp process.
2434 ;;; This simple facility just sends strings to the inferior process and pops
2435 ;;; up a window for the process buffer so you can see what the process
2436 ;;; responds with. We don't do anything fancy like try to intercept what the
2437 ;;; process responds with and put it in a pop-up window or on the message
2438 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2440 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2441 ;;; a window for the inferior process so that its response can be seen.
2442 (defun term-proc-query (proc str)
2443 (let* ((proc-buf (process-buffer proc))
2444 (proc-mark (process-mark proc)))
2445 (display-buffer proc-buf)
2446 (set-buffer proc-buf) ; but it's not the selected *window*
2447 (let ((proc-win (get-buffer-window proc-buf))
2448 (proc-pt (marker-position proc-mark)))
2449 (term-send-string proc str) ; send the query
2450 (accept-process-output proc) ; wait for some output
2451 ;; Try to position the proc window so you can see the answer.
2452 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2453 ;; I don't know why. Wizards invited to improve it.
2454 (if (not (pos-visible-in-window-p proc-pt proc-win))
2455 (let ((opoint (window-point proc-win)))
2456 (set-window-point proc-win proc-mark) (sit-for 0)
2457 (if (not (pos-visible-in-window-p opoint proc-win))
2458 (push-mark opoint)
2459 (set-window-point proc-win opoint)))))))
2461 ;;; Returns the current column in the current screen line.
2462 ;;; Note: (current-column) yields column in buffer line.
2464 (defun term-horizontal-column ()
2465 (- (term-current-column) (term-start-line-column)))
2467 ;; Calls either vertical-motion or buffer-vertical-motion
2468 (defmacro term-vertical-motion (count)
2469 (list 'funcall 'term-vertical-motion count))
2471 ;; An emulation of vertical-motion that is independent of having a window.
2472 ;; Instead, it uses the term-width variable as the logical window width.
2474 (defun buffer-vertical-motion (count)
2475 (cond ((= count 0)
2476 (move-to-column (* term-width (/ (current-column) term-width)))
2478 ((> count 0)
2479 (let ((H)
2480 (todo (+ count (/ (current-column) term-width))))
2481 (end-of-line)
2482 ;; The loop iterates over buffer lines;
2483 ;; H is the number of screen lines in the current line, i.e.
2484 ;; the ceiling of dividing the buffer line width by term-width.
2485 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2486 term-width)
2488 todo)
2489 (not (eobp)))
2490 (setq todo (- todo H))
2491 (forward-char) ;; Move past the ?\n
2492 (end-of-line)) ;; and on to the end of the next line.
2493 (if (and (>= todo H) (> todo 0))
2494 (+ (- count todo) H -1) ;; Hit end of buffer.
2495 (move-to-column (* todo term-width))
2496 count)))
2497 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2498 (let ((H)
2499 (todo (- count)))
2500 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2501 term-width)
2503 todo)
2504 (progn (beginning-of-line)
2505 (not (bobp))))
2506 (setq todo (- todo H))
2507 (backward-char)) ;; Move to end of previous line.
2508 (if (and (>= todo H) (> todo 0))
2509 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2510 (move-to-column (* (- H todo 1) term-width))
2511 count)))))
2513 ;;; The term-start-line-column variable is used as a cache.
2514 (defun term-start-line-column ()
2515 (cond (term-start-line-column)
2516 ((let ((save-pos (point)))
2517 (term-vertical-motion 0)
2518 (setq term-start-line-column (current-column))
2519 (goto-char save-pos)
2520 term-start-line-column))))
2522 ;;; Same as (current-column), but uses term-current-column as a cache.
2523 (defun term-current-column ()
2524 (cond (term-current-column)
2525 ((setq term-current-column (current-column)))))
2527 ;;; Move DELTA column right (or left if delta < 0).
2529 (defun term-move-columns (delta)
2530 (setq term-current-column (+ (term-current-column) delta))
2531 (move-to-column term-current-column t))
2533 ;; Insert COUNT copies of CHAR in the default face.
2534 (defun term-insert-char (char count)
2535 (let ((old-point (point)))
2536 (insert-char char count)
2537 (put-text-property old-point (point) 'face 'default)))
2539 (defun term-current-row ()
2540 (cond (term-current-row)
2541 ((setq term-current-row
2542 (save-restriction
2543 (save-excursion
2544 (narrow-to-region term-home-marker (point-max))
2545 (- (term-vertical-motion -9999))))))))
2547 (defun term-adjust-current-row-cache (delta)
2548 (if term-current-row
2549 (setq term-current-row (+ term-current-row delta))))
2551 (defun term-terminal-pos ()
2552 (save-excursion ; save-restriction
2553 (let ((save-col (term-current-column))
2554 x y)
2555 (term-vertical-motion 0)
2556 (setq x (- save-col (current-column)))
2557 (setq y (term-vertical-motion term-height))
2558 (cons x y))))
2560 ;;;Function that handles term messages: code by rms ( and you can see the
2561 ;;;difference ;-) -mm
2563 (defun term-handle-ansi-terminal-messages (message)
2564 ;; Is there a command here?
2565 (while (string-match "\eAnSiT.+\n" message)
2566 ;; Extract the command code and the argument.
2567 (let* ((start (match-beginning 0))
2568 (end (match-end 0))
2569 (command-code (aref message (+ start 6)))
2570 (argument
2571 (save-match-data
2572 (substring message
2573 (+ start 8)
2574 (string-match "\r?\n" message
2575 (+ start 8)))))
2576 ignore)
2577 ;; Delete this command from MESSAGE.
2578 (setq message (replace-match "" t t message))
2580 ;; If we recognize the type of command, set the appropriate variable.
2581 (cond ((= command-code ?c)
2582 (setq term-ansi-at-dir argument))
2583 ((= command-code ?h)
2584 (setq term-ansi-at-host argument))
2585 ((= command-code ?u)
2586 (setq term-ansi-at-user argument))
2587 ;; Otherwise ignore this one.
2589 (setq ignore t)))
2591 ;; Update default-directory based on the changes this command made.
2592 (if ignore
2594 (setq default-directory
2595 (file-name-as-directory
2596 (if (and (string= term-ansi-at-host (system-name))
2597 (string= term-ansi-at-user (user-real-login-name)))
2598 (expand-file-name term-ansi-at-dir)
2599 (if (string= term-ansi-at-user (user-real-login-name))
2600 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2601 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2602 term-ansi-at-dir)))))
2604 ;; I'm not sure this is necessary,
2605 ;; but it's best to be on the safe side.
2606 (if (string= term-ansi-at-host (system-name))
2607 (progn
2608 (setq ange-ftp-default-user term-ansi-at-save-user)
2609 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2610 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2611 (setq term-ansi-at-save-user ange-ftp-default-user)
2612 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2613 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2614 (setq ange-ftp-default-user nil)
2615 (setq ange-ftp-default-password nil)
2616 (setq ange-ftp-generate-anonymous-password nil)))))
2617 message)
2620 ;;; Terminal emulation
2621 ;;; This is the standard process filter for term buffers.
2622 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2624 (defun term-emulate-terminal (proc str)
2625 (let* ((previous-buffer (current-buffer))
2626 (i 0) char funny count save-point save-marker old-point temp win
2627 (selected (selected-window))
2628 (str-length (length str)))
2629 (unwind-protect
2630 (progn
2631 (set-buffer (process-buffer proc))
2633 ;;; Let's handle the messages. -mm
2635 (setq str (term-handle-ansi-terminal-messages str))
2636 (setq str-length (length str))
2638 (if (marker-buffer term-pending-delete-marker)
2639 (progn
2640 ;; Delete text following term-pending-delete-marker.
2641 (delete-region term-pending-delete-marker (process-mark proc))
2642 (set-marker term-pending-delete-marker nil)))
2644 (if (eq (window-buffer) (current-buffer))
2645 (progn
2646 (setq term-vertical-motion (symbol-function 'vertical-motion))
2647 (term-check-size proc))
2648 (setq term-vertical-motion
2649 (symbol-function 'buffer-vertical-motion)))
2651 (setq save-marker (copy-marker (process-mark proc)))
2653 (if (/= (point) (process-mark proc))
2654 (progn (setq save-point (point-marker))
2655 (goto-char (process-mark proc))))
2657 (save-restriction
2658 ;; If the buffer is in line mode, and there is a partial
2659 ;; input line, save the line (by narrowing to leave it
2660 ;; outside the restriction ) until we're done with output.
2661 (if (and (> (point-max) (process-mark proc))
2662 (term-in-line-mode))
2663 (narrow-to-region (point-min) (process-mark proc)))
2665 (if term-log-buffer
2666 (princ str term-log-buffer))
2667 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2668 (setq str (concat term-terminal-parameter str))
2669 (setq term-terminal-parameter nil)
2670 (setq str-length (length str))
2671 (setq term-terminal-state 0)))
2673 (while (< i str-length)
2674 (setq char (aref str i))
2675 (cond ((< term-terminal-state 2)
2676 ;; Look for prefix of regular chars
2677 (setq funny
2678 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2679 str i))
2680 (if (not funny) (setq funny str-length))
2681 (cond ((> funny i)
2682 (cond ((eq term-terminal-state 1)
2683 (term-move-columns 1)
2684 (setq term-terminal-state 0)))
2685 (setq count (- funny i))
2686 (setq temp (- (+ (term-horizontal-column) count)
2687 term-width))
2688 (cond ((<= temp 0)) ;; All count chars fit in line.
2689 ((> count temp) ;; Some chars fit.
2690 ;; This iteration, handle only what fits.
2691 (setq count (- count temp))
2692 (setq funny (+ count i)))
2693 ((or (not (or term-pager-count
2694 term-scroll-with-delete))
2695 (> (term-handle-scroll 1) 0))
2696 (term-adjust-current-row-cache 1)
2697 (setq count (min count term-width))
2698 (setq funny (+ count i))
2699 (setq term-start-line-column
2700 term-current-column))
2701 (t ;; Doing PAGER processing.
2702 (setq count 0 funny i)
2703 (setq term-current-column nil)
2704 (setq term-start-line-column nil)))
2705 (setq old-point (point))
2706 ;; In the common case that we're at the end of
2707 ;; the buffer, we can save a little work.
2708 (cond ((/= (point) (point-max))
2709 (if term-insert-mode
2710 ;; Inserting spaces, then deleting them,
2711 ;; then inserting the actual text is
2712 ;; inefficient, but it is simple, and
2713 ;; the actual overhead is miniscule.
2714 (term-insert-spaces count))
2715 (term-move-columns count)
2716 (delete-region old-point (point)))
2717 (t (setq term-current-column (+ (term-current-column) count))))
2718 (insert (substring str i funny))
2719 (put-text-property old-point (point)
2720 'face term-current-face)
2721 ;; If the last char was written in last column,
2722 ;; back up one column, but remember we did so.
2723 ;; Thus we emulate xterm/vt100-style line-wrapping.
2724 (cond ((eq temp 0)
2725 (term-move-columns -1)
2726 (setq term-terminal-state 1)))
2727 (setq i (1- funny)))
2728 ((and (setq term-terminal-state 0)
2729 (eq char ?\^I)) ; TAB
2730 ;; FIXME: Does not handle line wrap!
2731 (setq count (term-current-column))
2732 (setq count (+ count 8 (- (mod count 8))))
2733 (if (< (move-to-column count nil) count)
2734 (term-insert-char char 1))
2735 (setq term-current-column count))
2736 ((eq char ?\r)
2737 ;; Optimize CRLF at end of buffer:
2738 (cond ((and (< (setq temp (1+ i)) str-length)
2739 (eq (aref str temp) ?\n)
2740 (= (point) (point-max))
2741 (not (or term-pager-count
2742 term-kill-echo-list
2743 term-scroll-with-delete)))
2744 (insert ?\n)
2745 (term-adjust-current-row-cache 1)
2746 (setq term-start-line-column 0)
2747 (setq term-current-column 0)
2748 (setq i temp))
2749 (t ;; Not followed by LF or can't optimize:
2750 (term-vertical-motion 0)
2751 (setq term-current-column term-start-line-column))))
2752 ((eq char ?\n)
2753 (if (not (and term-kill-echo-list
2754 (term-check-kill-echo-list)))
2755 (term-down 1 t)))
2756 ((eq char ?\b)
2757 (term-move-columns -1))
2758 ((eq char ?\033) ; Escape
2759 (setq term-terminal-state 2))
2760 ((eq char 0)) ; NUL: Do nothing
2761 ((eq char ?\016)) ; Shift Out - ignored
2762 ((eq char ?\017)) ; Shift In - ignored
2763 ((eq char ?\^G)
2764 (beep t)) ; Bell
2765 ((eq char ?\032)
2766 (let ((end (string-match "\n" str i)))
2767 (if end
2768 (progn (funcall term-command-hook
2769 (substring str (1+ i) (1- end)))
2770 (setq i end))
2771 (setq term-terminal-parameter
2772 (substring str i))
2773 (setq term-terminal-state 4)
2774 (setq i str-length))))
2775 (t ; insert char FIXME: Should never happen
2776 (term-move-columns 1)
2777 (backward-delete-char 1)
2778 (insert char))))
2779 ((eq term-terminal-state 2) ; Seen Esc
2780 (cond ((eq char ?\133) ;; ?\133 = ?[
2782 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2783 ;;; Note that now the init value of term-terminal-previous-parameter has
2784 ;;; been changed to -1
2786 (make-local-variable 'term-terminal-parameter)
2787 (make-local-variable 'term-terminal-previous-parameter)
2788 (make-local-variable 'term-terminal-previous-parameter-2)
2789 (make-local-variable 'term-terminal-previous-parameter-3)
2790 (make-local-variable 'term-terminal-previous-parameter-4)
2791 (make-local-variable 'term-terminal-more-parameters)
2792 (setq term-terminal-parameter 0)
2793 (setq term-terminal-previous-parameter -1)
2794 (setq term-terminal-previous-parameter-2 -1)
2795 (setq term-terminal-previous-parameter-3 -1)
2796 (setq term-terminal-previous-parameter-4 -1)
2797 (setq term-terminal-more-parameters 0)
2798 (setq term-terminal-state 3))
2799 ((eq char ?D) ;; scroll forward
2800 (term-handle-deferred-scroll)
2801 (term-down 1 t)
2802 (setq term-terminal-state 0))
2803 ((eq char ?M) ;; scroll reversed
2804 (term-insert-lines 1)
2805 (setq term-terminal-state 0))
2806 ((eq char ?7) ;; Save cursor
2807 (term-handle-deferred-scroll)
2808 (setq term-saved-cursor
2809 (cons (term-current-row)
2810 (term-horizontal-column)))
2811 (setq term-terminal-state 0))
2812 ((eq char ?8) ;; Restore cursor
2813 (if term-saved-cursor
2814 (term-goto (car term-saved-cursor)
2815 (cdr term-saved-cursor)))
2816 (setq term-terminal-state 0))
2817 ((setq term-terminal-state 0))))
2818 ((eq term-terminal-state 3) ; Seen Esc [
2819 (cond ((and (>= char ?0) (<= char ?9))
2820 (setq term-terminal-parameter
2821 (+ (* 10 term-terminal-parameter) (- char ?0))))
2822 ((eq char ?\073 ) ; ?;
2823 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2824 (setq term-terminal-more-parameters 1)
2825 (setq term-terminal-previous-parameter-4
2826 term-terminal-previous-parameter-3)
2827 (setq term-terminal-previous-parameter-3
2828 term-terminal-previous-parameter-2)
2829 (setq term-terminal-previous-parameter-2
2830 term-terminal-previous-parameter)
2831 (setq term-terminal-previous-parameter
2832 term-terminal-parameter)
2833 (setq term-terminal-parameter 0))
2834 ((eq char ??)) ; Ignore ?
2836 (term-handle-ansi-escape proc char)
2837 (setq term-terminal-more-parameters 0)
2838 (setq term-terminal-previous-parameter-4 -1)
2839 (setq term-terminal-previous-parameter-3 -1)
2840 (setq term-terminal-previous-parameter-2 -1)
2841 (setq term-terminal-previous-parameter -1)
2842 (setq term-terminal-state 0)))))
2843 (if (term-handling-pager)
2844 ;; Finish stuff to get ready to handle PAGER.
2845 (progn
2846 (if (> (% (current-column) term-width) 0)
2847 (setq term-terminal-parameter
2848 (substring str i))
2849 ;; We're at column 0. Goto end of buffer; to compensate,
2850 ;; prepend a ?\r for later. This looks more consistent.
2851 (if (zerop i)
2852 (setq term-terminal-parameter
2853 (concat "\r" (substring str i)))
2854 (setq term-terminal-parameter (substring str (1- i)))
2855 (aset term-terminal-parameter 0 ?\r))
2856 (goto-char (point-max)))
2857 (setq term-terminal-state 4)
2858 (make-local-variable 'term-pager-old-filter)
2859 (setq term-pager-old-filter (process-filter proc))
2860 (set-process-filter proc term-pager-filter)
2861 (setq i str-length)))
2862 (setq i (1+ i))))
2864 (if (>= (term-current-row) term-height)
2865 (term-handle-deferred-scroll))
2867 (set-marker (process-mark proc) (point))
2868 (if save-point
2869 (progn (goto-char save-point)
2870 (set-marker save-point nil)))
2872 ;; Check for a pending filename-and-line number to display.
2873 ;; We do this before scrolling, because we might create a new window.
2874 (if (and term-pending-frame
2875 (eq (window-buffer selected) (current-buffer)))
2876 (progn (term-display-line (car term-pending-frame)
2877 (cdr term-pending-frame))
2878 (setq term-pending-frame nil)
2879 ;; We have created a new window, so check the window size.
2880 (term-check-size proc)))
2882 ;; Scroll each window displaying the buffer but (by default)
2883 ;; only if the point matches the process-mark we started with.
2884 (setq win selected)
2885 (while (progn
2886 (setq win (next-window win nil t))
2887 (if (eq (window-buffer win) (process-buffer proc))
2888 (let ((scroll term-scroll-to-bottom-on-output))
2889 (select-window win)
2890 (if (or (= (point) save-marker)
2891 (eq scroll t) (eq scroll 'all)
2892 ;; Maybe user wants point to jump to the end.
2893 (and (eq selected win)
2894 (or (eq scroll 'this) (not save-point)))
2895 (and (eq scroll 'others)
2896 (not (eq selected win))))
2897 (progn
2898 (goto-char term-home-marker)
2899 (recenter 0)
2900 (goto-char (process-mark proc))
2901 (if (not (pos-visible-in-window-p (point) win))
2902 (recenter -1))))
2903 ;; Optionally scroll so that the text
2904 ;; ends at the bottom of the window.
2905 (if (and term-scroll-show-maximum-output
2906 (>= (point) (process-mark proc)))
2907 (save-excursion
2908 (goto-char (point-max))
2909 (recenter -1)))))
2910 (not (eq win selected))))
2912 ;;; Stolen from comint.el and adapted -mm
2913 (if (> term-buffer-maximum-size 0)
2914 (save-excursion
2915 (goto-char (process-mark (get-buffer-process (current-buffer))))
2916 (forward-line (- term-buffer-maximum-size))
2917 (beginning-of-line)
2918 (delete-region (point-min) (point))))
2921 (set-marker save-marker nil))
2922 ;; unwind-protect cleanup-forms follow:
2923 (set-buffer previous-buffer)
2924 (select-window selected))))
2926 (defun term-handle-deferred-scroll ()
2927 (let ((count (- (term-current-row) term-height)))
2928 (if (>= count 0)
2929 (save-excursion
2930 (goto-char term-home-marker)
2931 (term-vertical-motion (1+ count))
2932 (set-marker term-home-marker (point))
2933 (setq term-current-row (1- term-height))))))
2935 ;;; New function to deal with ansi colorized output, as you can see you can
2936 ;;; have any bold/underline/fg/bg/reverse combination. -mm
2938 (defun term-handle-colors-array (parameter)
2939 (cond
2941 ;;; Bold
2942 ((eq parameter 1)
2943 (setq term-ansi-current-bold 1))
2945 ;;; Underline
2946 ((eq parameter 4)
2947 (setq term-ansi-current-underline 1))
2949 ;;; Blink (unsupported by Emacs), will be translated to bold.
2950 ;;; This may change in the future though.
2951 ((eq parameter 5)
2952 (setq term-ansi-current-bold 1))
2954 ;;; Reverse
2955 ((eq parameter 7)
2956 (setq term-ansi-current-reverse 1))
2958 ;;; Invisible
2959 ((eq parameter 8)
2960 (setq term-ansi-current-invisible 1))
2962 ((and (>= parameter 30) (<= parameter 37))
2963 (setq term-ansi-current-color (- parameter 29)))
2965 ((and (>= parameter 40) (<= parameter 47))
2966 (setq term-ansi-current-bg-color (- parameter 39)))
2968 ;;; 0 (Reset) or unknown (reset anyway)
2970 (setq term-current-face
2971 (list 'term-default-fg 'term-default-bg))
2972 (setq term-ansi-current-underline 0)
2973 (setq term-ansi-current-bold 0)
2974 (setq term-ansi-current-reverse 0)
2975 (setq term-ansi-current-color 0)
2976 (setq term-ansi-current-invisible 0)
2977 (setq term-ansi-face-alredy-done 1)
2978 (setq term-ansi-current-bg-color 0)))
2980 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
2981 ; term-ansi-current-underline
2982 ; term-ansi-current-reverse
2983 ; term-ansi-current-bold
2984 ; term-ansi-current-invisible
2985 ; term-ansi-face-alredy-done
2986 ; term-ansi-current-color
2987 ; term-ansi-current-bg-color)
2990 (if (= term-ansi-face-alredy-done 0)
2991 (if (= term-ansi-current-reverse 1)
2992 (progn
2993 (if (= term-ansi-current-invisible 1)
2994 (if (= term-ansi-current-color 0)
2995 (setq term-current-face
2996 '(term-default-bg-inv term-default-fg))
2997 (setq term-current-face
2998 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
2999 (elt ansi-term-inv-bg-faces-vector term-ansi-current-color))))
3000 ;; No need to bother with anything else if it's invisible
3001 (progn
3002 (setq term-current-face
3003 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
3004 (elt ansi-term-inv-bg-faces-vector term-ansi-current-bg-color)))
3005 (if (= term-ansi-current-bold 1)
3006 (setq term-current-face
3007 (append '(term-bold) term-current-face)))
3008 (if (= term-ansi-current-underline 1)
3009 (setq term-current-face
3010 (append '(term-underline) term-current-face))))))
3011 (progn
3012 (if (= term-ansi-current-invisible 1)
3013 (if (= term-ansi-current-bg-color 0)
3014 (setq term-current-face
3015 '(term-default-fg-inv term-default-bg))
3016 (setq term-current-face
3017 (list (elt ansi-term-fg-faces-vector term-ansi-current-bg-color)
3018 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color))))
3019 ;; No need to bother with anything else if it's invisible
3020 (progn
3021 (setq term-current-face
3022 (list (elt ansi-term-fg-faces-vector term-ansi-current-color)
3023 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color)))
3024 (if (= term-ansi-current-bold 1)
3025 (setq term-current-face
3026 (append '(term-bold) term-current-face)))
3027 (if (= term-ansi-current-underline 1)
3028 (setq term-current-face
3029 (append '(term-underline) term-current-face))))))))
3031 ; (message "Debug %S" term-current-face)
3033 (setq term-ansi-face-alredy-done 0))
3036 ;;; Handle a character assuming (eq terminal-state 2) -
3037 ;;; i.e. we have previously seen Escape followed by ?[.
3039 (defun term-handle-ansi-escape (proc char)
3040 (cond
3041 ((eq char ?H) ; cursor motion
3042 (if (<= term-terminal-parameter 0)
3043 (setq term-terminal-parameter 1))
3044 (if (<= term-terminal-previous-parameter 0)
3045 (setq term-terminal-previous-parameter 1))
3046 (if (> term-terminal-previous-parameter term-height)
3047 (setq term-terminal-previous-parameter term-height))
3048 (if (> term-terminal-parameter term-width)
3049 (setq term-terminal-parameter term-width))
3050 (term-goto
3051 (1- term-terminal-previous-parameter)
3052 (1- term-terminal-parameter)))
3053 ;; \E[A - cursor up
3054 ((eq char ?A)
3055 (term-handle-deferred-scroll)
3056 (term-down (- (max 1 term-terminal-parameter)) t))
3057 ;; \E[B - cursor down
3058 ((eq char ?B)
3059 (term-down (max 1 term-terminal-parameter) t))
3060 ;; \E[C - cursor right
3061 ((eq char ?C)
3062 (term-move-columns (max 1 term-terminal-parameter)))
3063 ;; \E[D - cursor left
3064 ((eq char ?D)
3065 (term-move-columns (- (max 1 term-terminal-parameter))))
3066 ;; \E[J - clear to end of screen
3067 ((eq char ?J)
3068 (term-erase-in-display term-terminal-parameter))
3069 ;; \E[K - clear to end of line
3070 ((eq char ?K)
3071 (term-erase-in-line term-terminal-parameter))
3072 ;; \E[L - insert lines
3073 ((eq char ?L)
3074 (term-insert-lines (max 1 term-terminal-parameter)))
3075 ;; \E[M - delete lines
3076 ((eq char ?M)
3077 (term-delete-lines (max 1 term-terminal-parameter)))
3078 ;; \E[P - delete chars
3079 ((eq char ?P)
3080 (term-delete-chars (max 1 term-terminal-parameter)))
3081 ;; \E[@ - insert spaces
3082 ((eq char ?@)
3083 (term-insert-spaces (max 1 term-terminal-parameter)))
3084 ;; \E[?h - DEC Private Mode Set
3085 ((eq char ?h)
3086 (cond ((eq term-terminal-parameter 4)
3087 (setq term-insert-mode t))
3088 ((eq term-terminal-parameter 47)
3089 (term-switch-to-alternate-sub-buffer t))))
3090 ;; \E[?l - DEC Private Mode Reset
3091 ((eq char ?l)
3092 (cond ((eq term-terminal-parameter 4)
3093 (setq term-insert-mode nil))
3094 ((eq term-terminal-parameter 47)
3095 (term-switch-to-alternate-sub-buffer nil))))
3097 ;;; Modified to allow ansi coloring -mm
3098 ;; \E[m - Set/reset standard mode
3099 ((eq char ?m)
3100 (progn
3101 ; (message "Debug: Current param stack 4)%d 3)%d 2)%d 1)%d 0)%d"
3102 ; term-terminal-previous-parameter-4
3103 ; term-terminal-previous-parameter-3
3104 ; term-terminal-previous-parameter-2
3105 ; term-terminal-previous-parameter
3106 ; term-terminal-parameter)
3108 (if (= term-terminal-more-parameters 1)
3109 (progn (if (>= term-terminal-previous-parameter-4 0)
3110 (term-handle-colors-array term-terminal-previous-parameter-4))
3111 (if (>= term-terminal-previous-parameter-3 0)
3112 (term-handle-colors-array term-terminal-previous-parameter-3))
3113 (if (>= term-terminal-previous-parameter-2 0)
3114 (term-handle-colors-array term-terminal-previous-parameter-2))
3115 (term-handle-colors-array term-terminal-previous-parameter)))
3116 (term-handle-colors-array term-terminal-parameter)))
3120 ;; \E[6n - Report cursor position
3121 ((eq char ?n)
3122 (term-handle-deferred-scroll)
3123 (process-send-string proc
3124 (format "\e[%s;%sR"
3125 (1+ (term-current-row))
3126 (1+ (term-horizontal-column)))))
3127 ;; \E[r - Set scrolling region
3128 ((eq char ?r)
3129 (term-scroll-region
3130 (1- term-terminal-previous-parameter)
3131 term-terminal-parameter))
3132 (t)))
3134 (defun term-scroll-region (top bottom)
3135 "Set scrolling region.
3136 TOP is the top-most line (inclusive) of the new scrolling region,
3137 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3138 The top-most line is line 0."
3139 (setq term-scroll-start
3140 (if (or (< top 0) (>= top term-height))
3142 top))
3143 (setq term-scroll-end
3144 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3145 term-height
3146 bottom))
3147 (setq term-scroll-with-delete
3148 (or (term-using-alternate-sub-buffer)
3149 (not (and (= term-scroll-start 0)
3150 (= term-scroll-end term-height))))))
3152 (defun term-switch-to-alternate-sub-buffer (set)
3153 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3154 ;; using it, do nothing. This test is needed for some programs (including
3155 ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3156 (term-handle-deferred-scroll)
3157 (if (eq set (not (term-using-alternate-sub-buffer)))
3158 (let ((row (term-current-row))
3159 (col (term-horizontal-column)))
3160 (cond (set
3161 (goto-char (point-max))
3162 (if (not (eq (preceding-char) ?\n))
3163 (term-insert-char ?\n 1))
3164 (setq term-scroll-with-delete t)
3165 (setq term-saved-home-marker (copy-marker term-home-marker))
3166 (set-marker term-home-marker (point)))
3168 (setq term-scroll-with-delete
3169 (not (and (= term-scroll-start 0)
3170 (= term-scroll-end term-height))))
3171 (set-marker term-home-marker term-saved-home-marker)
3172 (set-marker term-saved-home-marker nil)
3173 (setq term-saved-home-marker nil)
3174 (goto-char term-home-marker)))
3175 (setq term-current-column nil)
3176 (setq term-current-row 0)
3177 (term-goto row col))))
3179 ;; Default value for the symbol term-command-hook.
3181 (defun term-command-hook (string)
3182 (cond ((= (aref string 0) ?\032)
3183 ;; gdb (when invoked with -fullname) prints:
3184 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3185 (let* ((first-colon (string-match ":" string 1))
3186 (second-colon
3187 (string-match ":" string (1+ first-colon)))
3188 (filename (substring string 1 first-colon))
3189 (fileline (string-to-int
3190 (substring string (1+ first-colon) second-colon))))
3191 (setq term-pending-frame (cons filename fileline))))
3192 ((= (aref string 0) ?/)
3193 (cd (substring string 1)))
3194 ;; Allowing the inferior to call functions in Emacs is
3195 ;; probably too big a security hole.
3196 ;; ((= (aref string 0) ?!)
3197 ;; (eval (car (read-from-string string 1))))
3198 (t)));; Otherwise ignore it
3200 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3201 ;; and that its line LINE is visible.
3202 ;; Put the overlay-arrow on the line LINE in that buffer.
3203 ;; This is mainly used by gdb.
3205 (defun term-display-line (true-file line)
3206 (term-display-buffer-line (find-file-noselect true-file) line))
3208 (defun term-display-buffer-line (buffer line)
3209 (let* ((window (display-buffer buffer t))
3210 (pos))
3211 (save-excursion
3212 (set-buffer buffer)
3213 (save-restriction
3214 (widen)
3215 (goto-line line)
3216 (setq pos (point))
3217 (setq overlay-arrow-string "=>")
3218 (or overlay-arrow-position
3219 (setq overlay-arrow-position (make-marker)))
3220 (set-marker overlay-arrow-position (point) (current-buffer)))
3221 (cond ((or (< pos (point-min)) (> pos (point-max)))
3222 (widen)
3223 (goto-char pos))))
3224 (set-window-point window overlay-arrow-position)))
3226 ;;; The buffer-local marker term-home-marker defines the "home position"
3227 ;;; (in terms of cursor motion). However, we move the term-home-marker
3228 ;;; "down" as needed so that is no more that a window-full above (point-max).
3230 (defun term-goto-home ()
3231 (term-handle-deferred-scroll)
3232 (goto-char term-home-marker)
3233 (setq term-current-row 0)
3234 (setq term-current-column (current-column))
3235 (setq term-start-line-column term-current-column))
3237 (defun term-goto (row col)
3238 (term-handle-deferred-scroll)
3239 (cond ((and term-current-row (>= row term-current-row))
3240 ;; I assume this is a worthwhile optimization.
3241 (term-vertical-motion 0)
3242 (setq term-current-column term-start-line-column)
3243 (setq row (- row term-current-row)))
3245 (term-goto-home)))
3246 (term-down row)
3247 (term-move-columns col))
3249 ; The page is full, so enter "pager" mode, and wait for input.
3251 (defun term-process-pager ()
3252 (if (not term-pager-break-map)
3253 (let* ((map (make-keymap))
3254 (i 0) tmp)
3255 ; (while (< i 128)
3256 ; (define-key map (make-string 1 i) 'term-send-raw)
3257 ; (setq i (1+ i)))
3258 (define-key map "\e"
3259 (lookup-key (current-global-map) "\e"))
3260 (define-key map "\C-x"
3261 (lookup-key (current-global-map) "\C-x"))
3262 (define-key map "\C-u"
3263 (lookup-key (current-global-map) "\C-u"))
3264 (define-key map " " 'term-pager-page)
3265 (define-key map "\r" 'term-pager-line)
3266 (define-key map "?" 'term-pager-help)
3267 (define-key map "h" 'term-pager-help)
3268 (define-key map "b" 'term-pager-back-page)
3269 (define-key map "\177" 'term-pager-back-line)
3270 (define-key map "q" 'term-pager-discard)
3271 (define-key map "D" 'term-pager-disable)
3272 (define-key map "<" 'term-pager-bob)
3273 (define-key map ">" 'term-pager-eob)
3275 ;; Add menu bar.
3276 (term-if-emacs19
3277 (term-ifnot-xemacs
3278 (define-key map [menu-bar terminal] term-terminal-menu)
3279 (define-key map [menu-bar signals] term-signals-menu)
3280 (setq tmp (make-sparse-keymap "More pages?"))
3281 (define-key tmp [help] '("Help" . term-pager-help))
3282 (define-key tmp [disable]
3283 '("Disable paging" . term-fake-pager-disable))
3284 (define-key tmp [discard]
3285 '("Discard remaining output" . term-pager-discard))
3286 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3287 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3288 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3289 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3290 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3291 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3292 (define-key map [menu-bar page] (cons "More pages?" tmp))
3295 (setq term-pager-break-map map)))
3296 ; (let ((process (get-buffer-process (current-buffer))))
3297 ; (stop-process process))
3298 (setq term-pager-old-local-map (current-local-map))
3299 (use-local-map term-pager-break-map)
3300 (make-local-variable 'term-old-mode-line-format)
3301 (setq term-old-mode-line-format mode-line-format)
3302 (setq mode-line-format
3303 (list "-- **MORE** "
3304 mode-line-buffer-identification
3305 " [Type ? for help] "
3306 "%-"))
3307 (force-mode-line-update))
3309 (defun term-pager-line (lines)
3310 (interactive "p")
3311 (let* ((moved (vertical-motion (1+ lines)))
3312 (deficit (- lines moved)))
3313 (if (> moved lines)
3314 (backward-char))
3315 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3316 (recenter (1- term-height)))
3317 ((term-pager-continue deficit)))))
3319 (defun term-pager-page (arg)
3320 "Proceed past the **MORE** break, allowing the next page of output to appear"
3321 (interactive "p")
3322 (term-pager-line (* arg term-height)))
3324 ; Pager mode command to go to beginning of buffer
3325 (defun term-pager-bob ()
3326 (interactive)
3327 (goto-char (point-min))
3328 (if (= (vertical-motion term-height) term-height)
3329 (backward-char))
3330 (recenter (1- term-height)))
3332 ; pager mode command to go to end of buffer
3333 (defun term-pager-eob ()
3334 (interactive)
3335 (goto-char term-home-marker)
3336 (recenter 0)
3337 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3339 (defun term-pager-back-line (lines)
3340 (interactive "p")
3341 (vertical-motion (- 1 lines))
3342 (if (not (bobp))
3343 (backward-char)
3344 (beep)
3345 ;; Move cursor to end of window.
3346 (vertical-motion term-height)
3347 (backward-char))
3348 (recenter (1- term-height)))
3350 (defun term-pager-back-page (arg)
3351 (interactive "p")
3352 (term-pager-back-line (* arg term-height)))
3354 (defun term-pager-discard ()
3355 (interactive)
3356 (setq term-terminal-parameter "")
3357 (interrupt-process nil t)
3358 (term-pager-continue term-height))
3360 ; Disable pager processing.
3361 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3362 (defun term-pager-disable ()
3363 (interactive)
3364 (if (term-handling-pager)
3365 (term-pager-continue nil)
3366 (setq term-pager-count nil))
3367 (term-update-mode-line))
3369 ; Enable pager processing.
3370 (defun term-pager-enable ()
3371 (interactive)
3372 (or (term-pager-enabled)
3373 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3374 (term-update-mode-line))
3376 (defun term-pager-toggle ()
3377 (interactive)
3378 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3380 (term-ifnot-xemacs
3381 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3382 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3383 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3384 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3385 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3386 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3388 (defun term-pager-help ()
3389 "Provide help on commands available in a terminal-emulator **MORE** break"
3390 (interactive)
3391 (message "Terminal-emulator pager break help...")
3392 (sit-for 0)
3393 (with-electric-help
3394 (function (lambda ()
3395 (princ (substitute-command-keys
3396 "\\<term-pager-break-map>\
3397 Terminal-emulator MORE break.\n\
3398 Type one of the following keys:\n\n\
3399 \\[term-pager-page]\t\tMove forward one page.\n\
3400 \\[term-pager-line]\t\tMove forward one line.\n\
3401 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3402 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3403 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3404 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3405 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3406 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3407 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3408 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3409 \\{term-pager-break-map}\n\
3410 Any other key is passed through to the program
3411 running under the terminal emulator and disables pager processing until
3412 all pending output has been dealt with."))
3413 nil))))
3415 (defun term-pager-continue (new-count)
3416 (let ((process (get-buffer-process (current-buffer))))
3417 (use-local-map term-pager-old-local-map)
3418 (setq term-pager-old-local-map nil)
3419 (setq mode-line-format term-old-mode-line-format)
3420 (force-mode-line-update)
3421 (setq term-pager-count new-count)
3422 (set-process-filter process term-pager-old-filter)
3423 (funcall term-pager-old-filter process "")
3424 (continue-process process)))
3426 ;; Make sure there are DOWN blank lines below the current one.
3427 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3429 (defun term-handle-scroll (down)
3430 (let ((scroll-needed
3431 (- (+ (term-current-row) down 1) term-scroll-end)))
3432 (if (> scroll-needed 0)
3433 (let ((save-point (copy-marker (point))) (save-top))
3434 (goto-char term-home-marker)
3435 (cond (term-scroll-with-delete
3436 ;; delete scroll-needed lines at term-scroll-start
3437 (term-vertical-motion term-scroll-start)
3438 (setq save-top (point))
3439 (term-vertical-motion scroll-needed)
3440 (delete-region save-top (point))
3441 (goto-char save-point)
3442 (term-vertical-motion down)
3443 (term-adjust-current-row-cache (- scroll-needed))
3444 (setq term-current-column nil)
3445 (term-insert-char ?\n scroll-needed))
3446 ((and (numberp term-pager-count)
3447 (< (setq term-pager-count (- term-pager-count down))
3449 (setq down 0)
3450 (term-process-pager))
3452 (term-adjust-current-row-cache (- scroll-needed))
3453 (term-vertical-motion scroll-needed)
3454 (set-marker term-home-marker (point))))
3455 (goto-char save-point)
3456 (set-marker save-point nil))))
3457 down)
3459 (defun term-down (down &optional check-for-scroll)
3460 "Move down DOWN screen lines vertically."
3461 (let ((start-column (term-horizontal-column)))
3462 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3463 (setq down (term-handle-scroll down)))
3464 (term-adjust-current-row-cache down)
3465 (if (/= (point) (point-max))
3466 (setq down (- down (term-vertical-motion down))))
3467 ;; Extend buffer with extra blank lines if needed.
3468 (cond ((> down 0)
3469 (term-insert-char ?\n down)
3470 (setq term-current-column 0)
3471 (setq term-start-line-column 0))
3473 (setq term-current-column nil)
3474 (setq term-start-line-column (current-column))))
3475 (if start-column
3476 (term-move-columns start-column))))
3478 ;; Assuming point is at the beginning of a screen line,
3479 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3480 ;; FIXME: Probably should be called more than it is.
3481 (defun term-unwrap-line ()
3482 (if (not (bolp)) (insert-before-markers ?\n)))
3484 (defun term-erase-in-line (kind)
3485 (if (> kind 1) ;; erase left of point
3486 (let ((cols (term-horizontal-column)) (saved-point (point)))
3487 (term-vertical-motion 0)
3488 (delete-region (point) saved-point)
3489 (term-insert-char ?\n cols)))
3490 (if (not (eq kind 1)) ;; erase right of point
3491 (let ((saved-point (point))
3492 (wrapped (and (zerop (term-horizontal-column))
3493 (not (zerop (term-current-column))))))
3494 (term-vertical-motion 1)
3495 (delete-region saved-point (point))
3496 ;; wrapped is true if we're at the beginning of screen line,
3497 ;; but not a buffer line. If we delete the current screen line
3498 ;; that will make the previous line no longer wrap, and (because
3499 ;; of the way Emacs display works) point will be at the end of
3500 ;; the previous screen line rather then the beginning of the
3501 ;; current one. To avoid that, we make sure that current line
3502 ;; contain a space, to force the previous line to continue to wrap.
3503 ;; We could do this always, but it seems preferable to not add the
3504 ;; extra space when wrapped is false.
3505 (if wrapped
3506 (insert ? ))
3507 (insert ?\n)
3508 (put-text-property saved-point (point) 'face 'default)
3509 (goto-char saved-point))))
3511 (defun term-erase-in-display (kind)
3512 "Erases (that is blanks out) part of the window.
3513 If KIND is 0, erase from (point) to (point-max);
3514 if KIND is 1, erase from home to point; else erase from home to point-max.
3515 Should only be called when point is at the start of a screen line."
3516 (term-handle-deferred-scroll)
3517 (cond ((eq term-terminal-parameter 0)
3518 (delete-region (point) (point-max))
3519 (term-unwrap-line))
3520 ((let ((row (term-current-row))
3521 (col (term-horizontal-column))
3522 (start-region term-home-marker)
3523 (end-region (if (eq kind 1) (point) (point-max))))
3524 (delete-region start-region end-region)
3525 (term-unwrap-line)
3526 (if (eq kind 1)
3527 (term-insert-char ?\n row))
3528 (setq term-current-column nil)
3529 (setq term-current-row nil)
3530 (term-goto row col)))))
3532 (defun term-delete-chars (count)
3533 (let ((save-point (point)))
3534 (term-vertical-motion 1)
3535 (term-unwrap-line)
3536 (goto-char save-point)
3537 (move-to-column (+ (term-current-column) count) t)
3538 (delete-region save-point (point))))
3540 ;;; Insert COUNT spaces after point, but do not change any of
3541 ;;; following screen lines. Hence we may have to delete characters
3542 ;;; at teh end of this screen line to make room.
3544 (defun term-insert-spaces (count)
3545 (let ((save-point (point)) (save-eol))
3546 (term-vertical-motion 1)
3547 (if (bolp)
3548 (backward-char))
3549 (setq save-eol (point))
3550 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3551 (if (> save-eol (point))
3552 (delete-region (point) save-eol))
3553 (goto-char save-point)
3554 (term-insert-char ? count)
3555 (goto-char save-point)))
3557 (defun term-delete-lines (lines)
3558 (let ((start (point))
3559 (save-current-column term-current-column)
3560 (save-start-line-column term-start-line-column)
3561 (save-current-row (term-current-row)))
3562 (term-down lines)
3563 (delete-region start (point))
3564 (term-down (- term-scroll-end save-current-row lines))
3565 (term-insert-char ?\n lines)
3566 (setq term-current-column save-current-column)
3567 (setq term-start-line-column save-start-line-column)
3568 (setq term-current-row save-current-row)
3569 (goto-char start)))
3571 (defun term-insert-lines (lines)
3572 (let ((start (point))
3573 (start-deleted)
3574 (save-current-column term-current-column)
3575 (save-start-line-column term-start-line-column)
3576 (save-current-row (term-current-row)))
3577 (term-down (- term-scroll-end save-current-row lines))
3578 (setq start-deleted (point))
3579 (term-down lines)
3580 (delete-region start-deleted (point))
3581 (goto-char start)
3582 (setq term-current-column save-current-column)
3583 (setq term-start-line-column save-start-line-column)
3584 (setq term-current-row save-current-row)
3585 (term-insert-char ?\n lines)
3586 (goto-char start)))
3588 (defun term-set-output-log (name)
3589 "Record raw inferior process output in a buffer."
3590 (interactive (list (if term-log-buffer
3592 (read-buffer "Record output in buffer: "
3593 (format "%s output-log"
3594 (buffer-name (current-buffer)))
3595 nil))))
3596 (if (or (null name) (equal name ""))
3597 (progn (setq term-log-buffer nil)
3598 (message "Output logging off."))
3599 (if (get-buffer name)
3601 (save-excursion
3602 (set-buffer (get-buffer-create name))
3603 (fundamental-mode)
3604 (buffer-disable-undo (current-buffer))
3605 (erase-buffer)))
3606 (setq term-log-buffer (get-buffer name))
3607 (message "Recording terminal emulator output into buffer \"%s\""
3608 (buffer-name term-log-buffer))))
3610 (defun term-stop-photo ()
3611 "Discontinue raw inferior process logging."
3612 (interactive)
3613 (term-set-output-log nil))
3615 (defun term-show-maximum-output ()
3616 "Put the end of the buffer at the bottom of the window."
3617 (interactive)
3618 (goto-char (point-max))
3619 (recenter -1))
3621 ;;; Do the user's customisation...
3623 (defvar term-load-hook nil
3624 "This hook is run when term is loaded in.
3625 This is a good place to put keybindings.")
3627 (run-hooks 'term-load-hook)
3630 ;;; Filename/command/history completion in a buffer
3631 ;;; ===========================================================================
3632 ;;; Useful completion functions, courtesy of the Ergo group.
3634 ;;; Six commands:
3635 ;;; term-dynamic-complete Complete or expand command, filename,
3636 ;;; history at point.
3637 ;;; term-dynamic-complete-filename Complete filename at point.
3638 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3639 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3640 ;;; replace with expanded/completed name.
3641 ;;; term-dynamic-simple-complete Complete stub given candidates.
3643 ;;; These are not installed in the term-mode keymap. But they are
3644 ;;; available for people who want them. Shell-mode installs them:
3645 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3646 ;;; (define-key shell-mode-map "\M-?"
3647 ;;; 'term-dynamic-list-filename-completions)))
3649 ;;; Commands like this are fine things to put in load hooks if you
3650 ;;; want them present in specific modes.
3652 (defvar term-completion-autolist nil
3653 "*If non-nil, automatically list possibilities on partial completion.
3654 This mirrors the optional behavior of tcsh.")
3656 (defvar term-completion-addsuffix t
3657 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3658 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3659 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3660 completion. This mirrors the optional behavior of tcsh.")
3662 (defvar term-completion-recexact nil
3663 "*If non-nil, use shortest completion if characters cannot be added.
3664 This mirrors the optional behavior of tcsh.
3666 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3668 (defvar term-completion-fignore nil
3669 "*List of suffixes to be disregarded during file completion.
3670 This mirrors the optional behavior of bash and tcsh.
3672 Note that this applies to `term-dynamic-complete-filename' only.")
3674 (defvar term-file-name-prefix ""
3675 "Prefix prepended to absolute file names taken from process input.
3676 This is used by term's and shell's completion functions, and by shell's
3677 directory tracking functions.")
3680 (defun term-directory (directory)
3681 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3682 (expand-file-name (if (file-name-absolute-p directory)
3683 (concat term-file-name-prefix directory)
3684 directory)))
3687 (defun term-word (word-chars)
3688 "Return the word of WORD-CHARS at point, or nil if non is found.
3689 Word constituents are considered to be those in WORD-CHARS, which is like the
3690 inside of a \"[...]\" (see `skip-chars-forward')."
3691 (save-excursion
3692 (let ((limit (point))
3693 (word (concat "[" word-chars "]"))
3694 (non-word (concat "[^" word-chars "]")))
3695 (if (re-search-backward non-word nil 'move)
3696 (forward-char 1))
3697 ;; Anchor the search forwards.
3698 (if (or (eolp) (looking-at non-word))
3700 (re-search-forward (concat word "+") limit)
3701 (buffer-substring (match-beginning 0) (match-end 0))))))
3704 (defun term-match-partial-filename ()
3705 "Return the filename at point, or nil if non is found.
3706 Environment variables are substituted. See `term-word'."
3707 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3708 (and filename (substitute-in-file-name filename))))
3711 (defun term-dynamic-complete ()
3712 "Dynamically perform completion at point.
3713 Calls the functions in `term-dynamic-complete-functions' to perform
3714 completion until a function returns non-nil, at which point completion is
3715 assumed to have occurred."
3716 (interactive)
3717 (let ((functions term-dynamic-complete-functions))
3718 (while (and functions (null (funcall (car functions))))
3719 (setq functions (cdr functions)))))
3722 (defun term-dynamic-complete-filename ()
3723 "Dynamically complete the filename at point.
3724 Completes if after a filename. See `term-match-partial-filename' and
3725 `term-dynamic-complete-as-filename'.
3726 This function is similar to `term-replace-by-expanded-filename', except that
3727 it won't change parts of the filename already entered in the buffer; it just
3728 adds completion characters to the end of the filename. A completions listing
3729 may be shown in a help buffer if completion is ambiguous.
3731 Completion is dependent on the value of `term-completion-addsuffix',
3732 `term-completion-recexact' and `term-completion-fignore', and the timing of
3733 completions listing is dependent on the value of `term-completion-autolist'.
3735 Returns t if successful."
3736 (interactive)
3737 (if (term-match-partial-filename)
3738 (prog2 (or (eq (selected-window) (minibuffer-window))
3739 (message "Completing file name..."))
3740 (term-dynamic-complete-as-filename))))
3742 (defun term-dynamic-complete-as-filename ()
3743 "Dynamically complete at point as a filename.
3744 See `term-dynamic-complete-filename'. Returns t if successful."
3745 (let* ((completion-ignore-case nil)
3746 (completion-ignored-extensions term-completion-fignore)
3747 (success t)
3748 (dirsuffix (cond ((not term-completion-addsuffix) "")
3749 ((not (consp term-completion-addsuffix)) "/")
3750 (t (car term-completion-addsuffix))))
3751 (filesuffix (cond ((not term-completion-addsuffix) "")
3752 ((not (consp term-completion-addsuffix)) " ")
3753 (t (cdr term-completion-addsuffix))))
3754 (filename (or (term-match-partial-filename) ""))
3755 (pathdir (file-name-directory filename))
3756 (pathnondir (file-name-nondirectory filename))
3757 (directory (if pathdir (term-directory pathdir) default-directory))
3758 (completion (file-name-completion pathnondir directory))
3759 (mini-flag (eq (selected-window) (minibuffer-window))))
3760 (cond ((null completion)
3761 (message "No completions of %s" filename)
3762 (setq success nil))
3763 ((eq completion t) ; Means already completed "file".
3764 (if term-completion-addsuffix (insert " "))
3765 (or mini-flag (message "Sole completion")))
3766 ((string-equal completion "") ; Means completion on "directory/".
3767 (term-dynamic-list-filename-completions))
3768 (t ; Completion string returned.
3769 (let ((file (concat (file-name-as-directory directory) completion)))
3770 (insert (substring (directory-file-name completion)
3771 (length pathnondir)))
3772 (cond ((symbolp (file-name-completion completion directory))
3773 ;; We inserted a unique completion.
3774 (insert (if (file-directory-p file) dirsuffix filesuffix))
3775 (or mini-flag (message "Completed")))
3776 ((and term-completion-recexact term-completion-addsuffix
3777 (string-equal pathnondir completion)
3778 (file-exists-p file))
3779 ;; It's not unique, but user wants shortest match.
3780 (insert (if (file-directory-p file) dirsuffix filesuffix))
3781 (or mini-flag (message "Completed shortest")))
3782 ((or term-completion-autolist
3783 (string-equal pathnondir completion))
3784 ;; It's not unique, list possible completions.
3785 (term-dynamic-list-filename-completions))
3787 (or mini-flag (message "Partially completed")))))))
3788 success))
3791 (defun term-replace-by-expanded-filename ()
3792 "Dynamically expand and complete the filename at point.
3793 Replace the filename with an expanded, canonicalised and completed replacement.
3794 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
3795 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
3796 removed, and the filename is made absolute instead of relative. For expansion
3797 see `expand-file-name' and `substitute-in-file-name'. For completion see
3798 `term-dynamic-complete-filename'."
3799 (interactive)
3800 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3801 (term-dynamic-complete-filename))
3804 (defun term-dynamic-simple-complete (stub candidates)
3805 "Dynamically complete STUB from CANDIDATES list.
3806 This function inserts completion characters at point by completing STUB from
3807 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3808 if completion is ambiguous.
3810 Returns nil if no completion was inserted.
3811 Returns `sole' if completed with the only completion match.
3812 Returns `shortest' if completed with the shortest of the completion matches.
3813 Returns `partial' if completed as far as possible with the completion matches.
3814 Returns `listed' if a completion listing was shown.
3816 See also `term-dynamic-complete-filename'."
3817 (let* ((completion-ignore-case nil)
3818 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3819 (completions (all-completions stub candidates)))
3820 (cond ((null completions)
3821 (message "No completions of %s" stub)
3822 nil)
3823 ((= 1 (length completions)) ; Gotcha!
3824 (let ((completion (car completions)))
3825 (if (string-equal completion stub)
3826 (message "Sole completion")
3827 (insert (substring completion (length stub)))
3828 (message "Completed"))
3829 (if term-completion-addsuffix (insert " "))
3830 'sole))
3831 (t ; There's no unique completion.
3832 (let ((completion (try-completion stub candidates)))
3833 ;; Insert the longest substring.
3834 (insert (substring completion (length stub)))
3835 (cond ((and term-completion-recexact term-completion-addsuffix
3836 (string-equal stub completion)
3837 (member completion completions))
3838 ;; It's not unique, but user wants shortest match.
3839 (insert " ")
3840 (message "Completed shortest")
3841 'shortest)
3842 ((or term-completion-autolist
3843 (string-equal stub completion))
3844 ;; It's not unique, list possible completions.
3845 (term-dynamic-list-completions completions)
3846 'listed)
3848 (message "Partially completed")
3849 'partial)))))))
3852 (defun term-dynamic-list-filename-completions ()
3853 "List in help buffer possible completions of the filename at point."
3854 (interactive)
3855 (let* ((completion-ignore-case nil)
3856 (filename (or (term-match-partial-filename) ""))
3857 (pathdir (file-name-directory filename))
3858 (pathnondir (file-name-nondirectory filename))
3859 (directory (if pathdir (term-directory pathdir) default-directory))
3860 (completions (file-name-all-completions pathnondir directory)))
3861 (if completions
3862 (term-dynamic-list-completions completions)
3863 (message "No completions of %s" filename))))
3866 (defun term-dynamic-list-completions (completions)
3867 "List in help buffer sorted COMPLETIONS.
3868 Typing SPC flushes the help buffer."
3869 (let ((conf (current-window-configuration)))
3870 (with-output-to-temp-buffer "*Completions*"
3871 (display-completion-list (sort completions 'string-lessp)))
3872 (message "Hit space to flush")
3873 (let (key first)
3874 (if (save-excursion
3875 (set-buffer (get-buffer "*Completions*"))
3876 (setq key (read-key-sequence nil)
3877 first (aref key 0))
3878 (and (consp first)
3879 (eq (window-buffer (posn-window (event-start first)))
3880 (get-buffer "*Completions*"))
3881 (eq (key-binding key) 'mouse-choose-completion)))
3882 ;; If the user does mouse-choose-completion with the mouse,
3883 ;; execute the command, then delete the completion window.
3884 (progn
3885 (mouse-choose-completion first)
3886 (set-window-configuration conf))
3887 (if (eq first ?\ )
3888 (set-window-configuration conf)
3889 (setq unread-command-events (listify-key-sequence key)))))))
3891 ;;; I need a make-term that doesn't surround with *s -mm
3892 (defun term-ansi-make-term (name program &optional startfile &rest switches)
3893 "Make a term process NAME in a buffer, running PROGRAM.
3894 The name of the buffer is NAME.
3895 If there is already a running process in that buffer, it is not restarted.
3896 Optional third arg STARTFILE is the name of a file to send the contents of to
3897 the process. Any more args are arguments to PROGRAM."
3898 (let ((buffer (get-buffer-create name )))
3899 ;; If no process, or nuked process, crank up a new one and put buffer in
3900 ;; term mode. Otherwise, leave buffer and existing process alone.
3901 (cond ((not (term-check-proc buffer))
3902 (save-excursion
3903 (set-buffer buffer)
3904 (term-mode)) ; Install local vars, mode, keymap, ...
3905 (term-exec buffer name program startfile switches)))
3906 buffer))
3908 (defvar term-ansi-buffer-name nil)
3909 (defvar term-ansi-default-program nil)
3910 (defvar term-ansi-buffer-base-name nil)
3912 ;;;###autoload
3913 (defun ansi-term (program &optional new-buffer-name)
3914 "Start a terminal-emulator in a new buffer."
3915 (interactive (list (read-from-minibuffer "Run program: "
3916 (or explicit-shell-file-name
3917 (getenv "ESHELL")
3918 (getenv "SHELL")
3919 "/bin/sh"))))
3921 ;; Pick the name of the new buffer.
3922 (setq term-ansi-buffer-name
3923 (if new-buffer-name
3924 new-buffer-name
3925 (if term-ansi-buffer-base-name
3926 (if (eq term-ansi-buffer-base-name t)
3927 (file-name-nondirectory program)
3928 term-ansi-buffer-base-name)
3929 "ansi-term")))
3931 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
3933 ;; In order to have more than one term active at a time
3934 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
3935 ;; for now they have the *term-ansi-term*<?> form but we'll see...
3937 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
3938 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
3940 (set-buffer term-ansi-buffer-name)
3941 (term-mode)
3942 (term-char-mode)
3944 ;; I wanna have find-file on C-x C-f -mm
3945 ;; your mileage may definitely vary, maybe it's better to put this in your
3946 ;; .emacs ...
3948 (term-set-escape-char ?\C-x)
3950 (switch-to-buffer term-ansi-buffer-name))
3953 ;;; Converting process modes to use term mode
3954 ;;; ===========================================================================
3955 ;;; Renaming variables
3956 ;;; Most of the work is renaming variables and functions. These are the common
3957 ;;; ones:
3958 ;;; Local variables:
3959 ;;; last-input-start term-last-input-start
3960 ;;; last-input-end term-last-input-end
3961 ;;; shell-prompt-pattern term-prompt-regexp
3962 ;;; shell-set-directory-error-hook <no equivalent>
3963 ;;; Miscellaneous:
3964 ;;; shell-set-directory <unnecessary>
3965 ;;; shell-mode-map term-mode-map
3966 ;;; Commands:
3967 ;;; shell-send-input term-send-input
3968 ;;; shell-send-eof term-delchar-or-maybe-eof
3969 ;;; kill-shell-input term-kill-input
3970 ;;; interrupt-shell-subjob term-interrupt-subjob
3971 ;;; stop-shell-subjob term-stop-subjob
3972 ;;; quit-shell-subjob term-quit-subjob
3973 ;;; kill-shell-subjob term-kill-subjob
3974 ;;; kill-output-from-shell term-kill-output
3975 ;;; show-output-from-shell term-show-output
3976 ;;; copy-last-shell-input Use term-previous-input/term-next-input
3978 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3979 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
3980 ;;; Term mode does not provide functionality equivalent to
3981 ;;; shell-set-directory-error-hook; it is gone.
3983 ;;; term-last-input-start is provided for modes which want to munge
3984 ;;; the buffer after input is sent, perhaps because the inferior
3985 ;;; insists on echoing the input. The LAST-INPUT-START variable in
3986 ;;; the old shell package was used to implement a history mechanism,
3987 ;;; but you should think twice before using term-last-input-start
3988 ;;; for this; the input history ring often does the job better.
3990 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3991 ;;; *not* create the term-mode local variables in your foo-mode function.
3992 ;;; This is not modular. Instead, call term-mode, and let *it* create the
3993 ;;; necessary term-specific local variables. Then create the
3994 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3995 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
3996 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
3997 ;;; get-old-input) that need to be different from the defaults. Call
3998 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
3999 ;;; term-mode will take care of it. The following example, from shell.el,
4000 ;;; is typical:
4002 ;;; (defvar shell-mode-map '())
4003 ;;; (cond ((not shell-mode-map)
4004 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4005 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4006 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4007 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4008 ;;; (define-key shell-mode-map "\M-?"
4009 ;;; 'term-dynamic-list-filename-completions)))
4011 ;;; (defun shell-mode ()
4012 ;;; (interactive)
4013 ;;; (term-mode)
4014 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4015 ;;; (setq major-mode 'shell-mode)
4016 ;;; (setq mode-name "Shell")
4017 ;;; (use-local-map shell-mode-map)
4018 ;;; (make-local-variable 'shell-directory-stack)
4019 ;;; (setq shell-directory-stack nil)
4020 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4021 ;;; (run-hooks 'shell-mode-hook))
4024 ;;; Completion for term-mode users
4026 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4027 ;;; hook to add completion functions to. Functions on this list should return
4028 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4029 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4030 ;;; completion job.
4032 (provide 'term)
4034 ;;; term.el ends here