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