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