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