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