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