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