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