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