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