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