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