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