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