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