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