| blob | 4ea880de1eeff6096c494d0c4f68872f3f41a12c |
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 ;; Keyword: 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 ;;; Commentary:
28 ;; The changelog is at the end of this file.
30 ;; Please send me bug reports, bug fixes, and extensions, so that I can
31 ;; merge them into the master source.
32 ;; - Per Bothner (bothner@cygnus.com)
34 ;; This file defines a general command-interpreter-in-a-buffer package
35 ;; (term mode). The idea is that you can build specific process-in-a-buffer
36 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
37 ;; This way, all these specific packages share a common base functionality,
38 ;; and a common set of bindings, which makes them easier to use (and
39 ;; saves code, implementation time, etc., etc.).
41 ;; For hints on converting existing process modes (e.g., tex-mode,
42 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
43 ;; instead of shell-mode, see the notes at the end of this file.
45 \f
46 ;; Brief Command Documentation:
47 ;;============================================================================
48 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
49 ;; mode)
50 ;;
51 ;; m-p term-previous-input Cycle backwards in input history
52 ;; m-n term-next-input Cycle forwards
53 ;; m-r term-previous-matching-input Previous input matching a regexp
54 ;; m-s comint-next-matching-input Next input that matches
55 ;; return term-send-input
56 ;; c-c c-a term-bol Beginning of line; skip prompt.
57 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
58 ;; c-c c-u term-kill-input ^u
59 ;; c-c c-w backward-kill-word ^w
60 ;; c-c c-c term-interrupt-subjob ^c
61 ;; c-c c-z term-stop-subjob ^z
62 ;; c-c c-\ term-quit-subjob ^\
63 ;; c-c c-o term-kill-output Delete last batch of process output
64 ;; c-c c-r term-show-output Show last batch of process output
65 ;; c-c c-h term-dynamic-list-input-ring List input history
66 ;;
67 ;; Not bound by default in term-mode
68 ;; term-send-invisible Read a line w/o echo, and send to proc
69 ;; (These are bound in shell-mode)
70 ;; term-dynamic-complete Complete filename at point.
71 ;; term-dynamic-list-completions List completions in help buffer.
72 ;; term-replace-by-expanded-filename Expand and complete filename at point;
73 ;; replace with expanded/completed name.
74 ;; term-kill-subjob No mercy.
75 ;; term-show-maximum-output Show as much output as possible.
76 ;; term-continue-subjob Send CONT signal to buffer's process
77 ;; group. Useful if you accidentally
78 ;; suspend your process (with C-c C-z).
80 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
81 ;; term-load-hook is run after loading in this package.
83 ;; Code:
85 ;; This is passed to the inferior in the EMACS environment variable,
86 ;; so it is important to increase it if there are protocol-relevant changes.
91 \f
92 ;;; Buffer Local Variables:
93 ;;;============================================================================
94 ;;; Term mode buffer local variables:
95 ;;; term-prompt-regexp - string term-bol uses to match prompt.
96 ;;; term-delimiter-argument-list - list For delimiters and arguments
97 ;;; term-last-input-start - marker Handy if inferior always echoes
98 ;;; term-last-input-end - marker For term-kill-output command
99 ;; For the input history mechanism:
101 ;;; term-input-ring-size - integer
102 ;;; term-input-ring - ring
103 ;;; term-input-ring-index - number ...
104 ;;; term-input-autoexpand - symbol ...
105 ;;; term-input-ignoredups - boolean ...
106 ;;; term-last-input-match - string ...
107 ;;; term-dynamic-complete-functions - hook For the completion mechanism
108 ;;; term-completion-fignore - list ...
109 ;;; term-get-old-input - function Hooks for specific
110 ;;; term-input-filter-functions - hook process-in-a-buffer
111 ;;; term-input-filter - function modes.
112 ;;; term-input-send - function
113 ;;; term-scroll-to-bottom-on-output - symbol ...
114 ;;; term-scroll-show-maximum-output - boolean...
119 ;; contains saved term-home-marker from original sub-buffer .
121 ;; or nil if unknown.
124 ;; or nil if unknown.
128 ;; state 0: Normal state
129 ;; state 1: Last character was a graphic in the last column.
130 ;; If next char is graphic, first move one column right
131 ;; (and line warp) before displaying it.
132 ;; This emulates (more or less) the behavior of xterm.
133 ;; state 2: seen ESC
134 ;; state 3: seen ESC [ (or ESC [ ?)
135 ;; state 4: term-terminal-parameter contains pending output.
137 ;; we want suppressed.
144 ;; Otherwise, number of lines before we need to page.
149 ;; forward scrolling should be implemented by delete to
150 ;; top-most line(s); and nil if scrolling should be implemented
151 ;; by moving term-home-marker. It is set to t iff there is a
152 ;; (non-default) scroll-region OR the alternate buffer is used.
154 ;; be deleted, because it gets echoed by the inferior.
155 ;; To reduce flicker, we defer the delete until the next output.
165 "Regexp to recognise prompts in the inferior process.
168 Good choices:
179 "List of characters to recognise as separate arguments in input.
180 Strings comprising a character in this list will separate the arguments
181 surrounding them, and also be regarded as arguments in their own right (unlike
182 whitespace). See `term-arguments'.
183 Defaults to the empty list.
190 "*If non-nil, expand input command history references on completion.
191 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
193 If the value is `input', then the expansion is seen on input.
194 If the value is `history', then the expansion is only when inserting
195 into the buffer's input ring. See also `term-magic-space' and
196 `term-dynamic-complete'.
201 "*If non-nil, don't add input matching the last on the input ring.
202 This mirrors the optional behavior of bash.
207 "*If non-nil, name of the file to read/write input history.
208 See also `term-read-input-ring' and `term-write-input-ring'.
213 "*Controls whether interpreter output causes window to scroll.
214 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
215 If `this', scroll only the selected window.
216 If `others', scroll only those that are not the selected window.
218 The default is nil.
220 See variable `term-scroll-show-maximum-output'.
224 "*Controls how interpreter output causes window to scroll.
225 If non-nil, then show the maximum output when the window is scrolled.
227 See variable `term-scroll-to-bottom-on-output'.
230 ;; Where gud-display-frame should put the debugging arrow. This is
231 ;; set by the marker-filter, which scans the debugger's output for
232 ;; indications of the current pc.
235 ;;; Here are the per-interpreter hooks.
237 "Function that submits old text in term mode.
238 This function is called when return is typed while the point is in old text.
239 It returns the text to be submitted as process input. The default is
240 term-get-old-input-default, which grabs the current line, and strips off
245 "List of functions called to perform completion.
246 Functions should return non-nil if completion was performed.
247 See also `term-dynamic-complete'.
253 "Predicate for filtering additions to input history.
254 Only inputs answering true to this function are saved on the input
258 "Functions to call before input is sent to the process.
259 These functions get one argument, a string containing the text to send.
264 "Function to actually send to PROCESS the STRING submitted by user.
265 Usually this is just 'term-simple-send, but if your mode needs to
266 massage the input string, this is your hook. This is called from
267 the user command term-send-input. term-simple-send just sends
271 "*Non-nil means go to the end of the line before sending input.
275 "Called upon entry into term-mode
279 "Called each time a process is exec'd by term-exec.
280 This is called after the process is cranked up. It is useful for things that
281 must be done each time a process is executed in a term-mode buffer (e.g.,
282 \(process-kill-without-query)). In contrast, the term-mode-hook is only
289 "Escape character for char-sub-mode of term mode.
296 "True if communications via pty; false if by pipe. Buffer local.
300 "Last string searched for by term input history search, for defaulting.
310 ; This argument to set-process-filter disables reading from the process,
311 ; assuming this is emacs-19.20 or newer.
323 ;; Do FORMS if running under Emacs-19.
326 ;; True if running under XEmacs (previously Lucid emacs).
328 ;; Do FORM if running under XEmacs (previously Lucid emacs).
331 ;; Do FORM if NOT running under XEmacs (previously Lucid emacs).
337 ;; True if currently doing PAGER handling.
354 "Major mode for interacting with an inferior interpreter.
355 Interpreter name is same as buffer name, sans the asterisks.
356 In line sub-mode, return at end of buffer sends line as input,
357 while return not at end copies rest of line to end and sends it.
358 In char sub-mode, each character (except `term-escape-char`) is
359 set immediately.
361 This mode is typically customised to create inferior-lisp-mode,
362 shell-mode, etc.. This can be done by setting the hooks
363 term-input-filter-functions, term-input-filter, term-input-sender and
364 term-get-old-input to appropriate functions, and the variable
365 term-prompt-regexp to the appropriate regular expression.
367 An input history is maintained of size `term-input-ring-size', and
368 can be accessed with the commands \\[term-next-input], \\[term-previous-input], and \\[term-dynamic-list-input-ring].
369 Input ring history expansion can be achieved with the commands
371 Input ring expansion is controlled by the variable `term-input-autoexpand',
372 and addition is controlled by the variable `term-input-ignoredups'.
374 Input to, and output from, the subprocess can cause the window to scroll to
375 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
376 and `term-scroll-to-bottom-on-output'.
379 to continue it.
383 Entry to this mode runs the hooks on term-mode-hook"
385 ;; Do not remove this. All major modes must do this.
462 nil
495 ; ;; completion:
496 ; (define-key term-mode-map [menu-bar completion]
497 ; (cons "Complete" (make-sparse-keymap "Complete")))
498 ; (define-key term-mode-map [menu-bar completion complete-expand]
499 ; '("Expand File Name" . term-replace-by-expanded-filename))
500 ; (define-key term-mode-map [menu-bar completion complete-listing]
501 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
502 ; (define-key term-mode-map [menu-bar completion complete-file]
503 ; '("Complete File Name" . term-dynamic-complete-filename))
504 ; (define-key term-mode-map [menu-bar completion complete]
505 ; '("Complete Before Point" . term-dynamic-complete))
506 ; ;; Put them in the menu bar:
507 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
508 ; menu-bar-final-items))
509 )
511 ;; Menu bars:
515 ;; terminal:
529 ;; completion: (line mode only)
542 ;; Input history: (line mode only)
581 ;; Signals
584 (define-key newmap [kill] '("KILL" . term-kill-subjob))
585 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
586 (define-key newmap [cont] '("CONT" . term-continue-subjob))
587 (define-key newmap [stop] '("STOP" . term-stop-subjob))
588 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
589 (define-key term-mode-map [menu-bar signals]
590 (setq term-signals-menu (cons "Signals" newmap)))
591 )))
593 (defun term-reset-size (height width)
594 (setq term-height height)
595 (setq term-width width)
596 (setq term-start-line-column nil)
597 (setq term-current-row nil)
598 (setq term-current-column nil)
599 (term-scroll-region 0 height))
601 ;; Recursive routine used to check if any string in term-kill-echo-list
602 ;; matches part of the buffer before point.
603 ;; If so, delete that matched part of the buffer - this suppresses echo.
604 ;; Also, remove that string from the term-kill-echo-list.
605 ;; We *also* remove any older string on the list, as a sanity measure,
606 ;; in case something gets out of sync. (Except for type-ahead, there
607 ;; should only be one element in the list.)
609 (defun term-check-kill-echo-list ()
610 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
611 (unwind-protect
612 (progn
613 (end-of-line)
614 (while cur
615 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
616 (if (and (>= start (point-min))
617 (string= str (buffer-substring start (point))))
618 (progn (delete-backward-char len)
619 (setq term-kill-echo-list (cdr cur))
620 (setq term-current-column nil)
621 (setq term-current-row nil)
622 (setq term-start-line-column nil)
623 (setq cur nil found t))
624 (setq cur (cdr cur))))))
625 (if (not found)
626 (goto-char save-point)))
627 found))
629 (defun term-check-size (process)
630 (if (or (/= term-height (1- (window-height)))
631 (/= term-width (1- (window-width))))
632 (progn
633 (term-reset-size (1- (window-height)) (1- (window-width)))
634 (set-process-window-size process term-height term-width))))
636 (defun term-send-raw-string (chars)
637 (let ((proc (get-buffer-process (current-buffer))))
638 (if (not proc)
639 (error "Current buffer has no process")
640 ;; Note that (term-current-row) must be called *after*
641 ;; (point) has been updated to (process-mark proc).
642 (goto-char (process-mark proc))
643 (if (term-pager-enabled)
644 (setq term-pager-count (term-current-row)))
645 (send-string proc chars))))
647 (defun term-send-raw ()
648 "Send the last character typed through the terminal-emulator
649 without any interpretation."
650 (interactive)
651 ;; Convert `return' to C-m, etc.
652 (if (and (symbolp last-input-char)
653 (get last-input-char 'ascii-character))
654 (setq last-input-char (get last-input-char 'ascii-character)))
655 (term-send-raw-string (make-string 1 last-input-char)))
657 (defun term-send-raw-meta ()
658 (interactive)
659 (if (symbolp last-input-char)
660 ;; Convert `return' to C-m, etc.
661 (let ((tmp (get last-input-char 'event-symbol-elements)))
662 (if tmp
663 (setq last-input-char (car tmp)))
664 (if (symbolp last-input-char)
665 (progn
666 (setq tmp (get last-input-char 'ascii-character))
667 (if tmp (setq last-input-char tmp))))))
668 (term-send-raw-string (if (and (numberp last-input-char)
669 (> last-input-char 127)
670 (< last-input-char 256))
671 (make-string 1 last-input-char)
672 (format "\e%c" last-input-char))))
674 (defun term-mouse-paste (click arg)
675 "Insert the last stretch of killed text at the position clicked on."
677 (term-if-xemacs
678 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
679 (x-get-cutbuffer)
680 (error "No selection or cut buffer available"))))
681 (term-ifnot-xemacs
682 ;; Give temporary modes such as isearch a chance to turn off.
683 (run-hooks 'mouse-leave-buffer-hook)
684 (setq this-command 'yank)
685 (term-send-raw-string (current-kill (cond
686 ((listp arg) 0)
687 ((eq arg '-) -1)
688 (t (1- arg)))))))
690 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
691 (defun term-send-up () (interactive) (term-send-raw-string "\e[A"))
692 (defun term-send-down () (interactive) (term-send-raw-string "\e[B"))
693 (defun term-send-right () (interactive) (term-send-raw-string "\e[C"))
694 (defun term-send-left () (interactive) (term-send-raw-string "\e[D"))
696 (defun term-set-escape-char (c)
697 "Change term-escape-char and keymaps that depend on it."
698 (if term-escape-char
699 (define-key term-raw-map term-escape-char 'term-send-raw))
700 (setq c (make-string 1 c))
701 (define-key term-raw-map c term-raw-escape-map)
702 ;; Define standard bindings in term-raw-escape-map
703 (define-key term-raw-escape-map "\C-x"
704 (lookup-key (current-global-map) "\C-x"))
705 (define-key term-raw-escape-map "\C-v"
706 (lookup-key (current-global-map) "\C-v"))
707 (define-key term-raw-escape-map "\C-u"
708 (lookup-key (current-global-map) "\C-u"))
709 (define-key term-raw-escape-map c 'term-send-raw)
710 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
711 ;; The keybinding for term-char-mode is needed by the menubar code.
712 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
713 (define-key term-raw-escape-map "\C-j" 'term-line-mode))
715 (defun term-char-mode ()
717 Each character you type is sent directly to the inferior without
718 intervention from emacs, except for the escape character (usually C-c)."
719 (interactive)
720 (if (not term-raw-map)
721 (let* ((map (make-keymap))
722 (esc-map (make-keymap))
723 (i 0))
724 (while (< i 128)
725 (define-key map (make-string 1 i) 'term-send-raw)
726 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
727 (setq i (1+ i)))
728 (define-key map "\e" esc-map)
729 (setq term-raw-map map)
730 (setq term-raw-escape-map
731 (copy-keymap (lookup-key (current-global-map) "\C-x")))
732 (term-if-emacs19
733 (term-if-xemacs
734 (define-key term-raw-map [button2] 'term-mouse-paste))
735 (term-ifnot-xemacs
736 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
737 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
738 (define-key term-raw-map [menu-bar signals] term-signals-menu))
739 (define-key term-raw-map [up] 'term-send-up)
740 (define-key term-raw-map [down] 'term-send-down)
741 (define-key term-raw-map [right] 'term-send-right)
742 (define-key term-raw-map [left] 'term-send-left))
743 (term-set-escape-char ?\C-c)))
744 ;; FIXME: Emit message? Cfr ilisp-raw-message
745 (if (term-in-line-mode)
746 (progn
747 (setq term-old-mode-map (current-local-map))
748 (use-local-map term-raw-map)
750 ;; Send existing partial line to inferior (without newline).
751 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
752 (save-input-sender term-input-sender))
753 (if (> (point) pmark)
754 (unwind-protect
755 (progn
756 (setq term-input-sender
757 (symbol-function 'term-send-string))
758 (end-of-line)
759 (term-send-input))
760 (setq term-input-sender save-input-sender))))
761 (term-update-mode-line))))
763 (defun term-line-mode ()
765 This means that emacs editing commands work as normally, until
767 (interactive)
768 (if (term-in-char-mode)
769 (progn
770 (use-local-map term-old-mode-map)
771 (term-update-mode-line))))
773 (defun term-update-mode-line ()
774 (setq mode-line-process
775 (if (term-in-char-mode)
776 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
777 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
778 (force-mode-line-update))
780 (defun term-check-proc (buffer)
781 "True if there is a process associated w/buffer BUFFER, and
782 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
783 name of one"
784 (let ((proc (get-buffer-process buffer)))
785 (and proc (memq (process-status proc) '(run stop)))))
787 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
788 ;;; for the second argument (program).
789 ;;;###autoload
790 (defun make-term (name program &optional startfile &rest switches)
791 "Make a term process NAME in a buffer, running PROGRAM.
792 The name of the buffer is made by surrounding NAME with `*'s.
793 If there is already a running process in that buffer, it is not restarted.
794 Optional third arg STARTFILE is the name of a file to send the contents of to
795 the process. Any more args are arguments to PROGRAM."
796 (let ((buffer (get-buffer-create (concat "*" name "*"))))
797 ;; If no process, or nuked process, crank up a new one and put buffer in
798 ;; term mode. Otherwise, leave buffer and existing process alone.
799 (cond ((not (term-check-proc buffer))
800 (save-excursion
801 (set-buffer buffer)
802 (term-mode)) ; Install local vars, mode, keymap, ...
803 (term-exec buffer name program startfile switches)))
804 buffer))
806 ;;;###autoload
807 (defun term (program)
808 "Start a terminal-emulator in a new buffer."
809 (interactive (list (read-from-minibuffer "Run program: "
810 (or explicit-shell-file-name
811 (getenv "ESHELL")
812 (getenv "SHELL")
813 "/bin/sh"))))
814 (set-buffer (make-term "terminal" program))
815 (term-mode)
816 (term-char-mode)
817 (switch-to-buffer "*terminal*"))
819 (defun term-exec (buffer name command startfile switches)
820 "Start up a process in buffer for term modes.
821 Blasts any old process running in the buffer. Doesn't set the buffer mode.
822 You can use this to cheaply run a series of processes in the same term
823 buffer. The hook term-exec-hook is run after each exec."
824 (save-excursion
825 (set-buffer buffer)
826 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
827 (if proc (delete-process proc)))
828 ;; Crank up a new process
829 (let ((proc (term-exec-1 name buffer command switches)))
830 (make-local-variable 'term-ptyp)
831 (setq term-ptyp process-connection-type) ; T if pty, NIL if pipe.
832 ;; Jump to the end, and set the process mark.
833 (goto-char (point-max))
834 (set-marker (process-mark proc) (point))
835 (set-process-filter proc 'term-emulate-terminal)
836 ;; Feed it the startfile.
837 (cond (startfile
838 ;;This is guaranteed to wait long enough
839 ;;but has bad results if the term does not prompt at all
840 ;; (while (= size (buffer-size))
841 ;; (sleep-for 1))
842 ;;I hope 1 second is enough!
843 (sleep-for 1)
844 (goto-char (point-max))
845 (insert-file-contents startfile)
846 (setq startfile (buffer-substring (point) (point-max)))
847 (delete-region (point) (point-max))
848 (term-send-string proc startfile)))
849 (run-hooks 'term-exec-hook)
850 buffer)))
852 ;;; Name to use for TERM.
853 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
854 (defvar term-term-name "eterm")
855 ; Format string, usage: (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
856 (defvar term-termcap-format
864 ;;; : -undefine ic
865 "termcap capabilities supported")
867 ;;; This auxiliary function cranks up the process for term-exec in
868 ;;; the appropriate environment.
870 (defun term-exec-1 (name buffer command switches)
871 ;; We need to do an extra (fork-less) exec to run stty.
872 ;; (This would not be needed if we had suitable emacs primitives.)
873 ;; The 'if ...; then shift; fi' hack is because Bourne shell
874 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
875 ;; Thus we add an extra dummy argument "..", and then remove it.
876 (let ((process-environment
877 (nconc
878 (list
879 (format "TERM=%s" term-term-name)
880 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
881 (format "TERMINFO=%s" data-directory)
882 (format term-termcap-format "TERMCAP="
883 term-term-name term-height term-width))
884 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
885 (format "LINES=%d" term-height)
886 (format "COLUMNS=%d" term-width))
887 process-environment)))
888 (apply 'start-process name buffer
889 "/bin/sh" "-c"
890 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
892 term-height term-width)
893 ".."
894 command switches)))
896 ;;; This should be in emacs, but it isn't.
897 (defun term-mem (item list &optional elt=)
898 "Test to see if ITEM is equal to an item in LIST.
899 Option comparison function ELT= defaults to equal."
900 (let ((elt= (or elt= (function equal)))
901 (done nil))
902 (while (and list (not done))
903 (if (funcall elt= item (car list))
904 (setq done list)
905 (setq list (cdr list))))
906 done))
908 \f
909 ;;; Input history processing in a buffer
910 ;;; ===========================================================================
911 ;;; Useful input history functions, courtesy of the Ergo group.
913 ;;; Eleven commands:
914 ;;; term-dynamic-list-input-ring List history in help buffer.
915 ;;; term-previous-input Previous input...
916 ;;; term-previous-matching-input ...matching a string.
917 ;;; term-previous-matching-input-from-input ... matching the current input.
918 ;;; term-next-input Next input...
919 ;;; term-next-matching-input ...matching a string.
920 ;;; term-next-matching-input-from-input ... matching the current input.
921 ;;; term-backward-matching-input Backwards input...
922 ;;; term-forward-matching-input ...matching a string.
923 ;;; term-replace-by-expanded-history Expand history at point;
924 ;;; replace with expanded history.
925 ;;; term-magic-space Expand history and insert space.
926 ;;;
927 ;;; Three functions:
928 ;;; term-read-input-ring Read into term-input-ring...
929 ;;; term-write-input-ring Write to term-input-ring-file-name.
930 ;;; term-replace-by-expanded-history-before-point Workhorse function.
932 (defun term-read-input-ring (&optional silent)
933 "Sets the buffer's `term-input-ring' from a history file.
934 The name of the file is given by the variable `term-input-ring-file-name'.
935 The history ring is of size `term-input-ring-size', regardless of file size.
936 If `term-input-ring-file-name' is nil this function does nothing.
938 If the optional argument SILENT is non-nil, we say nothing about a
939 failure to read the history file.
941 This function is useful for major mode commands and mode hooks.
943 The structure of the history file should be one input command per line,
944 with the most recent command last.
945 See also `term-input-ignoredups' and `term-write-input-ring'."
946 (cond ((or (null term-input-ring-file-name)
947 (equal term-input-ring-file-name ""))
948 nil)
949 ((not (file-readable-p term-input-ring-file-name))
950 (or silent
951 (message "Cannot read history file %s"
952 term-input-ring-file-name)))
953 (t
954 (let ((history-buf (get-buffer-create " *temp*"))
955 (file term-input-ring-file-name)
956 (count 0)
957 (ring (make-ring term-input-ring-size)))
958 (unwind-protect
959 (save-excursion
960 (set-buffer history-buf)
961 (widen)
962 (erase-buffer)
963 (insert-file-contents file)
964 ;; Save restriction in case file is already visited...
965 ;; Watch for those date stamps in history files!
966 (goto-char (point-max))
967 (while (and (< count term-input-ring-size)
969 nil t))
970 (let ((history (buffer-substring (match-beginning 1)
971 (match-end 1))))
972 (if (or (null term-input-ignoredups)
973 (ring-empty-p ring)
974 (not (string-equal (ring-ref ring 0) history)))
975 (ring-insert-at-beginning ring history)))
976 (setq count (1+ count))))
977 (kill-buffer history-buf))
978 (setq term-input-ring ring
979 term-input-ring-index nil)))))
981 (defun term-write-input-ring ()
982 "Writes the buffer's `term-input-ring' to a history file.
983 The name of the file is given by the variable `term-input-ring-file-name'.
984 The original contents of the file are lost if `term-input-ring' is not empty.
985 If `term-input-ring-file-name' is nil this function does nothing.
987 Useful within process sentinels.
989 See also `term-read-input-ring'."
990 (cond ((or (null term-input-ring-file-name)
991 (equal term-input-ring-file-name "")
992 (null term-input-ring) (ring-empty-p term-input-ring))
993 nil)
994 ((not (file-writable-p term-input-ring-file-name))
995 (message "Cannot write history file %s" term-input-ring-file-name))
996 (t
997 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
998 (ring term-input-ring)
999 (file term-input-ring-file-name)
1000 (index (ring-length ring)))
1001 ;; Write it all out into a buffer first. Much faster, but messier,
1002 ;; than writing it one line at a time.
1003 (save-excursion
1004 (set-buffer history-buf)
1005 (erase-buffer)
1006 (while (> index 0)
1007 (setq index (1- index))
1009 (write-region (buffer-string) nil file nil 'no-message)
1010 (kill-buffer nil))))))
1013 (defun term-dynamic-list-input-ring ()
1014 "List in help buffer the buffer's input history."
1015 (interactive)
1016 (if (or (not (ring-p term-input-ring))
1017 (ring-empty-p term-input-ring))
1018 (message "No history")
1019 (let ((history nil)
1020 (history-buffer " *Input History*")
1021 (index (1- (ring-length term-input-ring)))
1022 (conf (current-window-configuration)))
1023 ;; We have to build up a list ourselves from the ring vector.
1024 (while (>= index 0)
1025 (setq history (cons (ring-ref term-input-ring index) history)
1026 index (1- index)))
1027 ;; Change "completion" to "history reference"
1028 ;; to make the display accurate.
1029 (with-output-to-temp-buffer history-buffer
1030 (display-completion-list history)
1031 (set-buffer history-buffer)
1032 (forward-line 3)
1033 (while (search-backward "completion" nil 'move)
1034 (replace-match "history reference")))
1035 (sit-for 0)
1036 (message "Hit space to flush")
1037 (let ((ch (read-event)))
1038 (if (eq ch ?\ )
1039 (set-window-configuration conf)
1040 (setq unread-command-events (list ch)))))))
1043 (defun term-regexp-arg (prompt)
1044 ;; Return list of regexp and prefix arg using PROMPT.
1045 (let* ((minibuffer-history-sexp-flag nil)
1046 ;; Don't clobber this.
1047 (last-command last-command)
1048 (regexp (read-from-minibuffer prompt nil nil nil
1049 'minibuffer-history-search-history)))
1050 (list (if (string-equal regexp "")
1051 (setcar minibuffer-history-search-history
1052 (nth 1 minibuffer-history-search-history))
1053 regexp)
1054 (prefix-numeric-value current-prefix-arg))))
1056 (defun term-search-arg (arg)
1057 ;; First make sure there is a ring and that we are after the process mark
1058 (cond ((not (term-after-pmark-p))
1059 (error "Not at command line"))
1060 ((or (null term-input-ring)
1061 (ring-empty-p term-input-ring))
1062 (error "Empty input ring"))
1063 ((zerop arg)
1064 ;; arg of zero resets search from beginning, and uses arg of 1
1065 (setq term-input-ring-index nil)
1066 1)
1067 (t
1068 arg)))
1070 (defun term-search-start (arg)
1071 ;; Index to start a directional search, starting at term-input-ring-index
1072 (if term-input-ring-index
1073 ;; If a search is running, offset by 1 in direction of arg
1074 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1075 (ring-length term-input-ring))
1076 ;; For a new search, start from beginning or end, as appropriate
1077 (if (>= arg 0)
1078 0 ; First elt for forward search
1079 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1081 (defun term-previous-input-string (arg)
1082 "Return the string ARG places along the input ring.
1083 Moves relative to `term-input-ring-index'."
1084 (ring-ref term-input-ring (if term-input-ring-index
1085 (mod (+ arg term-input-ring-index)
1086 (ring-length term-input-ring))
1087 arg)))
1089 (defun term-previous-input (arg)
1090 "Cycle backwards through input history."
1091 (interactive "*p")
1092 (term-previous-matching-input "." arg))
1094 (defun term-next-input (arg)
1095 "Cycle forwards through input history."
1096 (interactive "*p")
1097 (term-previous-input (- arg)))
1099 (defun term-previous-matching-input-string (regexp arg)
1100 "Return the string matching REGEXP ARG places along the input ring.
1101 Moves relative to `term-input-ring-index'."
1102 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1103 (if pos (ring-ref term-input-ring pos))))
1105 (defun term-previous-matching-input-string-position (regexp arg &optional start)
1106 "Return the index matching REGEXP ARG places along the input ring.
1107 Moves relative to START, or `term-input-ring-index'."
1108 (if (or (not (ring-p term-input-ring))
1109 (ring-empty-p term-input-ring))
1110 (error "No history"))
1111 (let* ((len (ring-length term-input-ring))
1112 (motion (if (> arg 0) 1 -1))
1113 (n (mod (- (or start (term-search-start arg)) motion) len))
1114 (tried-each-ring-item nil)
1115 (prev nil))
1116 ;; Do the whole search as many times as the argument says.
1117 (while (and (/= arg 0) (not tried-each-ring-item))
1118 ;; Step once.
1119 (setq prev n
1120 n (mod (+ n motion) len))
1121 ;; If we haven't reached a match, step some more.
1122 (while (and (< n len) (not tried-each-ring-item)
1123 (not (string-match regexp (ring-ref term-input-ring n))))
1124 (setq n (mod (+ n motion) len)
1125 ;; If we have gone all the way around in this search.
1126 tried-each-ring-item (= n prev)))
1127 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1128 ;; Now that we know which ring element to use, if we found it, return that.
1129 (if (string-match regexp (ring-ref term-input-ring n))
1130 n)))
1132 (defun term-previous-matching-input (regexp arg)
1133 "Search backwards through input history for match for REGEXP.
1134 \(Previous history elements are earlier commands.)
1135 With prefix argument N, search for Nth previous match.
1136 If N is negative, find the next or Nth next match."
1137 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1138 (setq arg (term-search-arg arg))
1139 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1140 ;; Has a match been found?
1141 (if (null pos)
1142 (error "Not found")
1143 (setq term-input-ring-index pos)
1144 (message "History item: %d" (1+ pos))
1145 (delete-region
1146 ;; Can't use kill-region as it sets this-command
1147 (process-mark (get-buffer-process (current-buffer))) (point))
1148 (insert (ring-ref term-input-ring pos)))))
1150 (defun term-next-matching-input (regexp arg)
1151 "Search forwards through input history for match for REGEXP.
1152 \(Later history elements are more recent commands.)
1153 With prefix argument N, search for Nth following match.
1154 If N is negative, find the previous or Nth previous match."
1155 (interactive (term-regexp-arg "Next input matching (regexp): "))
1156 (term-previous-matching-input regexp (- arg)))
1158 (defun term-previous-matching-input-from-input (arg)
1159 "Search backwards through input history for match for current input.
1160 \(Previous history elements are earlier commands.)
1161 With prefix argument N, search for Nth previous match.
1162 If N is negative, search forwards for the -Nth following match."
1163 (interactive "p")
1164 (if (not (memq last-command '(term-previous-matching-input-from-input
1165 term-next-matching-input-from-input)))
1166 ;; Starting a new search
1167 (setq term-matching-input-from-input-string
1168 (buffer-substring
1169 (process-mark (get-buffer-process (current-buffer)))
1170 (point))
1171 term-input-ring-index nil))
1172 (term-previous-matching-input
1173 (concat "^" (regexp-quote term-matching-input-from-input-string))
1174 arg))
1176 (defun term-next-matching-input-from-input (arg)
1177 "Search forwards through input history for match for current input.
1178 \(Following history elements are more recent commands.)
1179 With prefix argument N, search for Nth following match.
1180 If N is negative, search backwards for the -Nth previous match."
1181 (interactive "p")
1182 (term-previous-matching-input-from-input (- arg)))
1185 (defun term-replace-by-expanded-history (&optional silent)
1186 "Expand input command history references before point.
1187 Expansion is dependent on the value of `term-input-autoexpand'.
1189 This function depends on the buffer's idea of the input history, which may not
1190 match the command interpreter's idea, assuming it has one.
1192 Assumes history syntax is like typical Un*x shells'. However, since emacs
1193 cannot know the interpreter's idea of input line numbers, assuming it has one,
1194 it cannot expand absolute input line number references.
1196 If the optional argument SILENT is non-nil, never complain
1197 even if history reference seems erroneous.
1199 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1201 Returns t if successful."
1202 (interactive)
1203 (if (and term-input-autoexpand
1204 (string-match "[!^]" (funcall term-get-old-input))
1205 (save-excursion (beginning-of-line)
1206 (looking-at term-prompt-regexp)))
1207 ;; Looks like there might be history references in the command.
1208 (let ((previous-modified-tick (buffer-modified-tick)))
1209 (message "Expanding history references...")
1210 (term-replace-by-expanded-history-before-point silent)
1211 (/= previous-modified-tick (buffer-modified-tick)))))
1214 (defun term-replace-by-expanded-history-before-point (silent)
1215 "Expand directory stack reference before point.
1216 See `term-replace-by-expanded-history'. Returns t if successful."
1217 (save-excursion
1218 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1219 (start (progn (term-bol nil) (point))))
1220 (while (progn
1221 (skip-chars-forward "^!^"
1222 (save-excursion
1223 (end-of-line nil) (- (point) toend)))
1224 (< (point)
1225 (save-excursion
1226 (end-of-line nil) (- (point) toend))))
1227 ;; This seems a bit complex. We look for references such as !!, !-num,
1228 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1229 ;; If that wasn't enough, the plings can be suffixed with argument
1230 ;; range specifiers.
1231 ;; Argument ranges are complex too, so we hive off the input line,
1232 ;; referenced with plings, with the range string to `term-args'.
1233 (setq term-input-ring-index nil)
1235 (term-within-quotes start (point)))
1236 ;; The history is quoted, or we're in quotes.
1237 (goto-char (1+ (point))))
1239 ;; We cannot know the interpreter's idea of input line numbers.
1240 (goto-char (match-end 0))
1241 (message "Absolute reference cannot be expanded"))
1243 ;; Just a number of args from `number' lines backward.
1244 (let ((number (1- (string-to-number
1245 (buffer-substring (match-beginning 1)
1246 (match-end 1))))))
1247 (if (<= number (ring-length term-input-ring))
1248 (progn
1249 (replace-match
1250 (term-args (term-previous-input-string number)
1251 (match-beginning 2) (match-end 2))
1252 t t)
1253 (setq term-input-ring-index number)
1254 (message "History item: %d" (1+ number)))
1255 (goto-char (match-end 0))
1256 (message "Relative reference exceeds input history size"))))
1258 ;; Just a number of args from the previous input line.
1259 (replace-match
1260 (term-args (term-previous-input-string 0)
1261 (match-beginning 1) (match-end 1))
1262 t t)
1263 (message "History item: previous"))
1264 ((looking-at
1266 ;; Most recent input starting with or containing (possibly
1267 ;; protected) string, maybe just a number of args. Phew.
1268 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1269 (mb2 (match-beginning 2)) (me2 (match-end 2))
1270 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1272 (pos (save-match-data
1273 (term-previous-matching-input-string-position
1274 (concat pref (regexp-quote exp)) 1))))
1275 (if (null pos)
1276 (progn
1277 (goto-char (match-end 0))
1278 (or silent
1279 (progn (message "Not found")
1280 (ding))))
1281 (setq term-input-ring-index pos)
1282 (replace-match
1283 (term-args (ring-ref term-input-ring pos)
1284 (match-beginning 4) (match-end 4))
1285 t t)
1286 (message "History item: %d" (1+ pos)))))
1288 ;; Quick substitution on the previous input line.
1289 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1290 (new (buffer-substring (match-beginning 2) (match-end 2)))
1291 (pos nil))
1292 (replace-match (term-previous-input-string 0) t t)
1293 (setq pos (point))
1294 (goto-char (match-beginning 0))
1295 (if (not (search-forward old pos t))
1296 (or silent
1297 (error "Not found"))
1298 (replace-match new t t)
1299 (message "History item: substituted"))))
1300 (t
1301 (goto-char (match-end 0))))))))
1304 (defun term-magic-space (arg)
1305 "Expand input history references before point and insert ARG spaces.
1306 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1307 (interactive "p")
1308 (term-replace-by-expanded-history)
1309 (self-insert-command arg))
1310 \f
1311 (defun term-within-quotes (beg end)
1312 "Return t if the number of quotes between BEG and END is odd.
1313 Quotes are single and double."
1316 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1318 (defun term-how-many-region (regexp beg end)
1319 "Return number of matches for REGEXP from BEG to END."
1320 (let ((count 0))
1321 (save-excursion
1322 (save-match-data
1323 (goto-char beg)
1324 (while (re-search-forward regexp end t)
1325 (setq count (1+ count)))))
1326 count))
1328 (defun term-args (string begin end)
1329 ;; From STRING, return the args depending on the range specified in the text
1330 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1331 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1332 (save-match-data
1333 (if (null begin)
1334 (term-arguments string 0 nil)
1335 (let* ((range (buffer-substring
1336 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1337 (nth (cond ((string-match "^[*^]" range) 1)
1338 ((string-match "^-" range) 0)
1339 ((string-equal range "$") nil)
1340 (t (string-to-number range))))
1341 (mth (cond ((string-match "[-*$]$" range) nil)
1342 ((string-match "-" range)
1343 (string-to-number (substring range (match-end 0))))
1344 (t nth))))
1345 (term-arguments string nth mth)))))
1347 ;; Return a list of arguments from ARG. Break it up at the
1348 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1349 (defun term-delim-arg (arg)
1350 (if (null term-delimiter-argument-list)
1351 (list arg)
1352 (let ((args nil)
1353 (pos 0)
1354 (len (length arg)))
1355 (while (< pos len)
1356 (let ((char (aref arg pos))
1357 (start pos))
1358 (if (memq char term-delimiter-argument-list)
1359 (while (and (< pos len) (eq (aref arg pos) char))
1360 (setq pos (1+ pos)))
1361 (while (and (< pos len)
1362 (not (memq (aref arg pos)
1363 term-delimiter-argument-list)))
1364 (setq pos (1+ pos))))
1365 (setq args (cons (substring arg start pos) args))))
1366 args)))
1368 (defun term-arguments (string nth mth)
1369 "Return from STRING the NTH to MTH arguments.
1370 NTH and/or MTH can be nil, which means the last argument.
1371 Returned arguments are separated by single spaces.
1372 We assume whitespace separates arguments, except within quotes.
1373 Also, a run of one or more of a single character
1374 in `term-delimiter-argument-list' is a separate argument.
1375 Argument 0 is the command name."
1377 (args ()) (pos 0)
1378 (count 0)
1379 beg str value quotes)
1380 ;; Build a list of all the args until we have as many as we want.
1381 (while (and (or (null mth) (<= count mth))
1382 (string-match argpart string pos))
1383 (if (and beg (= pos (match-beginning 0)))
1384 ;; It's contiguous, part of the same arg.
1385 (setq pos (match-end 0)
1386 quotes (or quotes (match-beginning 1)))
1387 ;; It's a new separate arg.
1388 (if beg
1389 ;; Put the previous arg, if there was one, onto ARGS.
1390 (setq str (substring string beg pos)
1391 args (if quotes (cons str args)
1392 (nconc (term-delim-arg str) args))
1393 count (1+ count)))
1394 (setq quotes (match-beginning 1))
1395 (setq beg (match-beginning 0))
1396 (setq pos (match-end 0))))
1397 (if beg
1398 (setq str (substring string beg pos)
1399 args (if quotes (cons str args)
1400 (nconc (term-delim-arg str) args))
1401 count (1+ count)))
1402 (let ((n (or nth (1- count)))
1403 (m (if mth (1- (- count mth)) 0)))
1404 (mapconcat
1405 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1406 \f
1407 ;;;
1408 ;;; Input processing stuff [line mode]
1409 ;;;
1411 (defun term-send-input ()
1412 "Send input to process.
1413 After the process output mark, sends all text from the process mark to
1414 point as input to the process. Before the process output mark, calls value
1415 of variable term-get-old-input to retrieve old input, copies it to the
1416 process mark, and sends it. A terminal newline is also inserted into the
1417 buffer and sent to the process. The list of function names contained in the
1418 value of `term-input-filter-functions' is called on the input before sending
1419 it. The input is entered into the input history ring, if the value of variable
1420 term-input-filter returns non-nil when called on the input.
1422 Any history reference may be expanded depending on the value of the variable
1423 `term-input-autoexpand'. The list of function names contained in the value
1424 of `term-input-filter-functions' is called on the input before sending it.
1425 The input is entered into the input history ring, if the value of variable
1426 `term-input-filter' returns non-nil when called on the input.
1428 If variable `term-eol-on-send' is non-nil, then point is moved to the
1429 end of line before sending the input.
1431 The values of `term-get-old-input', `term-input-filter-functions', and
1432 `term-input-filter' are chosen according to the command interpreter running
1433 in the buffer. E.g.,
1435 If the interpreter is the csh,
1436 term-get-old-input is the default: take the current line, discard any
1437 initial string matching regexp term-prompt-regexp.
1440 term-input-filter is the default: returns T if the input isn't all white
1441 space.
1443 If the term is Lucid Common Lisp,
1444 term-get-old-input snarfs the sexp ending at point.
1445 term-input-filter-functions does nothing.
1446 term-input-filter returns NIL if the input matches input-filter-regexp,
1447 which matches (1) all whitespace (2) :a, :c, etc.
1449 Similarly for Soar, Scheme, etc."
1450 (interactive)
1451 ;; Note that the input string does not include its terminal newline.
1452 (let ((proc (get-buffer-process (current-buffer))))
1453 (if (not proc) (error "Current buffer has no process")
1454 (let* ((pmark (process-mark proc))
1455 (pmark-val (marker-position pmark))
1456 (input-is-new (>= (point) pmark-val))
1457 (intxt (if input-is-new
1458 (progn (if term-eol-on-send (end-of-line))
1459 (buffer-substring pmark (point)))
1460 (funcall term-get-old-input)))
1461 (input (if (not (eq term-input-autoexpand 'input))
1462 ;; Just whatever's already there
1463 intxt
1464 ;; Expand and leave it visible in buffer
1465 (term-replace-by-expanded-history t)
1466 (buffer-substring pmark (point))))
1467 (history (if (not (eq term-input-autoexpand 'history))
1468 input
1469 ;; This is messy 'cos ultimately the original
1470 ;; functions used do insertion, rather than return
1471 ;; strings. We have to expand, then insert back.
1472 (term-replace-by-expanded-history t)
1473 (let ((copy (buffer-substring pmark (point))))
1474 (delete-region pmark (point))
1475 (insert input)
1476 copy))))
1477 (if (term-pager-enabled)
1478 (save-excursion
1479 (goto-char (process-mark proc))
1480 (setq term-pager-count (term-current-row))))
1481 (if (and (funcall term-input-filter history)
1482 (or (null term-input-ignoredups)
1483 (not (ring-p term-input-ring))
1484 (ring-empty-p term-input-ring)
1485 (not (string-equal (ring-ref term-input-ring 0)
1486 history))))
1487 (ring-insert term-input-ring history))
1488 (let ((functions term-input-filter-functions))
1489 (while functions
1491 (setq functions (cdr functions))))
1492 (setq term-input-ring-index nil)
1494 ;; Update the markers before we send the input
1495 ;; in case we get output amidst sending the input.
1496 (set-marker term-last-input-start pmark)
1497 (set-marker term-last-input-end (point))
1498 (if input-is-new
1499 (progn
1500 ;; Set up to delete, because inferior should echo.
1501 (if (marker-buffer term-pending-delete-marker)
1502 (delete-region term-pending-delete-marker pmark))
1503 (set-marker term-pending-delete-marker pmark-val)
1504 (set-marker (process-mark proc) (point))))
1505 (goto-char pmark)
1506 (funcall term-input-sender proc input)))))
1508 (defun term-get-old-input-default ()
1509 "Default for term-get-old-input.
1510 Take the current line, and discard any initial text matching
1511 term-prompt-regexp."
1512 (save-excursion
1513 (beginning-of-line)
1514 (term-skip-prompt)
1515 (let ((beg (point)))
1516 (end-of-line)
1517 (buffer-substring beg (point)))))
1519 (defun term-copy-old-input ()
1520 "Insert after prompt old input at point as new input to be edited.
1521 Calls `term-get-old-input' to get old input."
1522 (interactive)
1523 (let ((input (funcall term-get-old-input))
1524 (process (get-buffer-process (current-buffer))))
1525 (if (not process)
1526 (error "Current buffer has no process")
1527 (goto-char (process-mark process))
1528 (insert input))))
1530 (defun term-skip-prompt ()
1531 "Skip past the text matching regexp term-prompt-regexp.
1532 If this takes us past the end of the current line, don't skip at all."
1533 (let ((eol (save-excursion (end-of-line) (point))))
1534 (if (and (looking-at term-prompt-regexp)
1535 (<= (match-end 0) eol))
1536 (goto-char (match-end 0)))))
1539 (defun term-after-pmark-p ()
1540 "Is point after the process output marker?"
1541 ;; Since output could come into the buffer after we looked at the point
1542 ;; but before we looked at the process marker's value, we explicitly
1543 ;; serialise. This is just because I don't know whether or not emacs
1544 ;; services input during execution of lisp commands.
1545 (let ((proc-pos (marker-position
1546 (process-mark (get-buffer-process (current-buffer))))))
1547 (<= proc-pos (point))))
1549 (defun term-simple-send (proc string)
1550 "Default function for sending to PROC input STRING.
1551 This just sends STRING plus a newline. To override this,
1552 set the hook TERM-INPUT-SENDER."
1553 (term-send-string proc string)
1556 (defun term-bol (arg)
1557 "Goes to the beginning of line, then skips past the prompt, if any.
1559 -- go straight to column 0.
1561 The prompt skip is done by skipping text matching the regular expression
1562 term-prompt-regexp, a buffer local variable."
1563 (interactive "P")
1564 (beginning-of-line)
1565 (if (null arg) (term-skip-prompt)))
1567 ;;; These two functions are for entering text you don't want echoed or
1568 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1569 ;;; Just enter m-x term-send-invisible and type in your line.
1571 (defun term-read-noecho (prompt &optional stars)
1572 "Read a single line of text from user without echoing, and return it.
1573 Prompt with argument PROMPT, a string. Optional argument STARS causes
1574 input to be echoed with '*' characters on the prompt line. Input ends with
1575 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1576 `inhibit-quit' is set because e.g. this function was called from a process
1577 filter and C-g is pressed, this function returns nil rather than a string).
1579 Note that the keystrokes comprising the text can still be recovered
1581 applications."
1582 (let ((ans "")
1583 (c 0)
1584 (echo-keystrokes 0)
1585 (cursor-in-echo-area t)
1586 (done nil))
1587 (while (not done)
1588 (if stars
1589 (message "%s%s" prompt (make-string (length ans) ?*))
1590 (message "%s" prompt))
1591 (setq c (read-char))
1592 (cond ((= c ?\C-g)
1593 ;; This function may get called from a process filter, where
1594 ;; inhibit-quit is set. In later versions of emacs read-char
1595 ;; may clear quit-flag itself and return C-g. That would make
1596 ;; it impossible to quit this loop in a simple way, so
1597 ;; re-enable it here (for backward-compatibility the check for
1598 ;; quit-flag below would still be necessary, so this seems
1599 ;; like the simplest way to do things).
1600 (setq quit-flag t
1601 done t))
1603 (setq done t))
1604 ((= c ?\C-u)
1605 (setq ans ""))
1607 (setq ans (concat ans (char-to-string c))))
1608 ((> (length ans) 0)
1609 (setq ans (substring ans 0 -1)))))
1610 (if quit-flag
1611 ;; Emulate a true quit, except that we have to return a value.
1612 (prog1
1613 (setq quit-flag nil)
1614 (message "Quit")
1615 (beep t))
1616 (message "")
1617 ans)))
1619 (defun term-send-invisible (str &optional proc)
1620 "Read a string without echoing.
1621 Then send it to the process running in the current buffer. A new-line
1622 is additionally sent. String is not saved on term input history list.
1623 Security bug: your string can still be temporarily recovered with
1625 (interactive "P") ; Defeat snooping via C-x esc
1626 (if (not (stringp str))
1627 (setq str (term-read-noecho "Non-echoed text: " t)))
1628 (if (not proc)
1629 (setq proc (get-buffer-process (current-buffer))))
1630 (if (not proc) (error "Current buffer has no process")
1631 (setq term-kill-echo-list (nconc term-kill-echo-list
1632 (cons str nil)))
1633 (term-send-string proc str)
1636 \f
1637 ;;; Low-level process communication
1639 (defvar term-input-chunk-size 512
1640 "*Long inputs send to term processes are broken up into chunks of this size.
1641 If your process is choking on big inputs, try lowering the value.")
1643 (defun term-send-string (proc str)
1644 "Send PROCESS the contents of STRING as input.
1645 This is equivalent to process-send-string, except that long input strings
1646 are broken up into chunks of size term-input-chunk-size. Processes
1647 are given a chance to output between chunks. This can help prevent processes
1648 from hanging when you send them long inputs on some OS's."
1649 (let* ((len (length str))
1650 (i (min len term-input-chunk-size)))
1651 (process-send-string proc (substring str 0 i))
1652 (while (< i len)
1653 (let ((next-i (+ i term-input-chunk-size)))
1654 (accept-process-output)
1655 (process-send-string proc (substring str i (min len next-i)))
1656 (setq i next-i)))))
1658 (defun term-send-region (proc start end)
1659 "Sends to PROC the region delimited by START and END.
1660 This is a replacement for process-send-region that tries to keep
1661 your process from hanging on long inputs. See term-send-string."
1662 (term-send-string proc (buffer-substring start end)))
1664 \f
1665 ;;; Random input hackage
1667 (defun term-kill-output ()
1668 "Kill all output from interpreter since last input."
1669 (interactive)
1670 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1671 (kill-region term-last-input-end pmark)
1672 (goto-char pmark)
1674 (set-marker pmark (point))))
1676 (defun term-show-output ()
1677 "Display start of this batch of interpreter output at top of window.
1678 Sets mark to the value of point when this command is run."
1679 (interactive)
1680 (goto-char term-last-input-end)
1681 (backward-char)
1682 (beginning-of-line)
1683 (set-window-start (selected-window) (point))
1684 (end-of-line))
1686 (defun term-interrupt-subjob ()
1687 "Interrupt the current subjob."
1688 (interactive)
1689 (interrupt-process nil term-ptyp))
1691 (defun term-kill-subjob ()
1692 "Send kill signal to the current subjob."
1693 (interactive)
1694 (kill-process nil term-ptyp))
1696 (defun term-quit-subjob ()
1697 "Send quit signal to the current subjob."
1698 (interactive)
1699 (quit-process nil term-ptyp))
1701 (defun term-stop-subjob ()
1702 "Stop the current subjob.
1703 WARNING: if there is no current subjob, you can end up suspending
1704 the top-level process running in the buffer. If you accidentally do
1706 is not a problem with most shells, since they ignore this signal.)"
1707 (interactive)
1708 (stop-process nil term-ptyp))
1710 (defun term-continue-subjob ()
1711 "Send CONT signal to process buffer's process group.
1712 Useful if you accidentally suspend the top-level process."
1713 (interactive)
1714 (continue-process nil term-ptyp))
1716 (defun term-kill-input ()
1717 "Kill all text from last stuff output by interpreter to point."
1718 (interactive)
1719 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
1720 (p-pos (marker-position pmark)))
1721 (if (> (point) p-pos)
1722 (kill-region pmark (point)))))
1724 (defun term-delchar-or-maybe-eof (arg)
1725 "Delete ARG characters forward, or send an EOF to process if at end of buffer."
1726 (interactive "p")
1727 (if (eobp)
1728 (process-send-eof)
1729 (delete-char arg)))
1731 (defun term-send-eof ()
1732 "Send an EOF to the current buffer's process."
1733 (interactive)
1734 (process-send-eof))
1736 (defun term-backward-matching-input (regexp arg)
1737 "Search backward through buffer for match for REGEXP.
1738 Matches are searched for on lines that match `term-prompt-regexp'.
1739 With prefix argument N, search for Nth previous match.
1740 If N is negative, find the next or Nth next match."
1741 (interactive (term-regexp-arg "Backward input matching (regexp): "))
1742 (let* ((re (concat term-prompt-regexp ".*" regexp))
1743 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1744 (if (re-search-backward re nil t arg)
1745 (point)))))
1746 (if (null pos)
1747 (progn (message "Not found")
1748 (ding))
1749 (goto-char pos)
1750 (term-bol nil))))
1752 (defun term-forward-matching-input (regexp arg)
1753 "Search forward through buffer for match for REGEXP.
1754 Matches are searched for on lines that match `term-prompt-regexp'.
1755 With prefix argument N, search for Nth following match.
1756 If N is negative, find the previous or Nth previous match."
1757 (interactive (term-regexp-arg "Forward input matching (regexp): "))
1758 (term-backward-matching-input regexp (- arg)))
1761 (defun term-next-prompt (n)
1762 "Move to end of Nth next prompt in the buffer.
1763 See `term-prompt-regexp'."
1764 (interactive "p")
1765 (let ((paragraph-start term-prompt-regexp))
1766 (end-of-line (if (> n 0) 1 0))
1767 (forward-paragraph n)
1768 (term-skip-prompt)))
1770 (defun term-previous-prompt (n)
1771 "Move to end of Nth previous prompt in the buffer.
1772 See `term-prompt-regexp'."
1773 (interactive "p")
1774 (term-next-prompt (- n)))
1775 \f
1776 ;;; Support for source-file processing commands.
1777 ;;;============================================================================
1778 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1779 ;;; commands that process files of source text (e.g. loading or compiling
1780 ;;; files). So the corresponding process-in-a-buffer modes have commands
1781 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1782 ;;; for defining these commands.
1783 ;;;
1784 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1785 ;;; and Soar, in that they don't know anything about file extensions.
1786 ;;; So the compile/load interface gets the wrong default occasionally.
1787 ;;; The load-file/compile-file default mechanism could be smarter -- it
1788 ;;; doesn't know about the relationship between filename extensions and
1789 ;;; whether the file is source or executable. If you compile foo.lisp
1790 ;;; with compile-file, then the next load-file should use foo.bin for
1791 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1792 ;;; because the extension for executable files varies so much (.o, .bin,
1793 ;;; .lbin, .mo, .vo, .ao, ...).
1796 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
1797 ;;; commands.
1798 ;;;
1799 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1800 ;;; want to save the buffer before issuing any process requests to the command
1801 ;;; interpreter.
1802 ;;;
1803 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
1804 ;;; for the file to process.
1806 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
1807 ;;;============================================================================
1808 ;;; This function computes the defaults for the load-file and compile-file
1809 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1810 ;;;
1811 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1812 ;;; source-file processing command. NIL if there hasn't been one yet.
1813 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1814 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1815 ;;; Typically, (lisp-mode) or (scheme-mode).
1816 ;;;
1817 ;;; If the command is given while the cursor is inside a string, *and*
1818 ;;; the string is an existing filename, *and* the filename is not a directory,
1819 ;;; then the string is taken as default. This allows you to just position
1820 ;;; your cursor over a string that's a filename and have it taken as default.
1821 ;;;
1822 ;;; If the command is given in a file buffer whose major mode is in
1823 ;;; SOURCE-MODES, then the the filename is the default file, and the
1824 ;;; file's directory is the default directory.
1825 ;;;
1826 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1827 ;;; then the default directory & file are what was used in the last source-file
1828 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1829 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1831 ;;;
1832 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1833 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1834 ;;; for Soar programs, etc.
1835 ;;;
1836 ;;; The function returns a pair: (default-directory . default-file).
1838 (defun term-source-default (previous-dir/file source-modes)
1839 (cond ((and buffer-file-name (memq major-mode source-modes))
1840 (cons (file-name-directory buffer-file-name)
1841 (file-name-nondirectory buffer-file-name)))
1842 (previous-dir/file)
1843 (t
1844 (cons default-directory nil))))
1847 ;;; (TERM-CHECK-SOURCE fname)
1848 ;;;============================================================================
1849 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1850 ;;; process-in-a-buffer modes), this function can be called on the filename.
1851 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1852 ;;; is queried to see if he wants to save the buffer before proceeding with
1853 ;;; the load or compile.
1855 (defun term-check-source (fname)
1856 (let ((buff (get-file-buffer fname)))
1857 (if (and buff
1858 (buffer-modified-p buff)
1859 (y-or-n-p (format "Save buffer %s first? "
1860 (buffer-name buff))))
1861 ;; save BUFF.
1862 (let ((old-buffer (current-buffer)))
1863 (set-buffer buff)
1864 (save-buffer)
1865 (set-buffer old-buffer)))))
1868 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1869 ;;;============================================================================
1870 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
1871 ;;; commands that process source files (like loading or compiling a file).
1872 ;;; It prompts for the filename, provides a default, if there is one,
1873 ;;; and returns the result filename.
1874 ;;;
1875 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
1876 ;;;
1877 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1878 ;;; from the last source processing command. SOURCE-MODES is a list of major
1879 ;;; modes used to determine what file buffers contain source files. (These
1880 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1881 ;;; then the filename reader will only accept a file that exists.
1882 ;;;
1883 ;;; A typical use:
1884 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
1885 ;;; '(lisp-mode) t))
1887 ;;; This is pretty stupid about strings. It decides we're in a string
1888 ;;; if there's a quote on both sides of point on the current line.
1889 (defun term-extract-string ()
1890 "Returns string around POINT that starts the current line or nil."
1891 (save-excursion
1892 (let* ((point (point))
1893 (bol (progn (beginning-of-line) (point)))
1894 (eol (progn (end-of-line) (point)))
1895 (start (progn (goto-char point)
1897 (1+ (point)))))
1898 (end (progn (goto-char point)
1900 (1- (point))))))
1901 (and start end
1902 (buffer-substring start end)))))
1904 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
1905 (let* ((def (term-source-default prev-dir/file source-modes))
1906 (stringfile (term-extract-string))
1907 (sfile-p (and stringfile
1908 (condition-case ()
1909 (file-exists-p stringfile)
1910 (error nil))
1911 (not (file-directory-p stringfile))))
1912 (defdir (if sfile-p (file-name-directory stringfile)
1913 (car def)))
1914 (deffile (if sfile-p (file-name-nondirectory stringfile)
1915 (cdr def)))
1916 (ans (read-file-name (if deffile (format "%s(default %s) "
1917 prompt deffile)
1918 prompt)
1919 defdir
1920 (concat defdir deffile)
1921 mustmatch-p)))
1922 (list (expand-file-name (substitute-in-file-name ans)))))
1924 ;;; I am somewhat divided on this string-default feature. It seems
1925 ;;; to violate the principle-of-least-astonishment, in that it makes
1926 ;;; the default harder to predict, so you actually have to look and see
1927 ;;; what the default really is before choosing it. This can trip you up.
1928 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1929 ;;; on this.
1930 ;;; -Olin
1932 \f
1933 ;;; Simple process query facility.
1934 ;;; ===========================================================================
1935 ;;; This function is for commands that want to send a query to the process
1936 ;;; and show the response to the user. For example, a command to get the
1937 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1938 ;;; to an inferior Common Lisp process.
1939 ;;;
1940 ;;; This simple facility just sends strings to the inferior process and pops
1941 ;;; up a window for the process buffer so you can see what the process
1942 ;;; responds with. We don't do anything fancy like try to intercept what the
1943 ;;; process responds with and put it in a pop-up window or on the message
1944 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1946 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1947 ;;; a window for the inferior process so that its response can be seen.
1948 (defun term-proc-query (proc str)
1949 (let* ((proc-buf (process-buffer proc))
1950 (proc-mark (process-mark proc)))
1951 (display-buffer proc-buf)
1952 (set-buffer proc-buf) ; but it's not the selected *window*
1953 (let ((proc-win (get-buffer-window proc-buf))
1954 (proc-pt (marker-position proc-mark)))
1955 (term-send-string proc str) ; send the query
1956 (accept-process-output proc) ; wait for some output
1957 ;; Try to position the proc window so you can see the answer.
1958 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1959 ;; I don't know why. Wizards invited to improve it.
1960 (if (not (pos-visible-in-window-p proc-pt proc-win))
1961 (let ((opoint (window-point proc-win)))
1962 (set-window-point proc-win proc-mark) (sit-for 0)
1963 (if (not (pos-visible-in-window-p opoint proc-win))
1964 (push-mark opoint)
1965 (set-window-point proc-win opoint)))))))
1966 \f
1967 ;;; Returns the current column in the current screen line.
1968 ;;; Note: (current-column) yields column in buffer line.
1970 (defun term-horizontal-column ()
1971 (- (term-current-column) (term-start-line-column)))
1973 ;; Calls either vertical-motion or buffer-vertical-motion
1974 (defmacro term-vertical-motion (count)
1975 (list 'funcall 'term-vertical-motion count))
1977 ;; An emulation of vertical-motion that is independent of having a window.
1978 ;; Instead, it uses the term-width variable as the logical window width.
1980 (defun buffer-vertical-motion (count)
1981 (cond ((= count 0)
1982 (move-to-column (* term-width (/ (current-column) term-width)))
1983 0)
1984 ((> count 0)
1985 (let ((H)
1986 (todo (+ count (/ (current-column) term-width))))
1987 (end-of-line)
1988 ;; The loop iterates over buffer lines;
1989 ;; H is the number of screen lines in the current line, i.e.
1990 ;; the ceiling of dividing the buffer line width by term-width.
1991 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
1992 term-width)
1993 1))
1994 todo)
1995 (not (eobp)))
1996 (setq todo (- todo H))
1998 (end-of-line)) ;; and on to the end of the next line.
1999 (if (and (>= todo H) (> todo 0))
2000 (+ (- count todo) H -1) ;; Hit end of buffer.
2001 (move-to-column (* todo term-width))
2002 count)))
2003 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2004 (let ((H)
2005 (todo (- count)))
2006 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2007 term-width)
2008 1))
2009 todo)
2010 (progn (beginning-of-line)
2011 (not (bobp))))
2012 (setq todo (- todo H))
2013 (backward-char)) ;; Move to end of previous line.
2014 (if (and (>= todo H) (> todo 0))
2015 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2016 (move-to-column (* (- H todo 1) term-width))
2017 count)))))
2019 ;;; The term-start-line-column variable is used as a cache.
2020 (defun term-start-line-column ()
2021 (cond (term-start-line-column)
2022 ((let ((save-pos (point)))
2023 (term-vertical-motion 0)
2024 (setq term-start-line-column (current-column))
2025 (goto-char save-pos)
2026 term-start-line-column))))
2028 ;;; Same as (current-column), but uses term-current-column as a cache.
2029 (defun term-current-column ()
2030 (cond (term-current-column)
2031 ((setq term-current-column (current-column)))))
2033 ;;; Move DELTA column right (or left if delta < 0).
2035 (defun term-move-columns (delta)
2036 (setq term-current-column (+ (term-current-column) delta))
2037 (move-to-column term-current-column t))
2039 ;; Insert COUNT copies of CHAR in the default face.
2040 (defun term-insert-char (char count)
2041 (let ((old-point (point)))
2042 (insert-char char count)
2043 (put-text-property old-point (point) 'face 'default)))
2045 (defun term-current-row ()
2046 (cond (term-current-row)
2047 ((setq term-current-row
2048 (save-restriction
2049 (save-excursion
2050 (narrow-to-region term-home-marker (point-max))
2051 (- (term-vertical-motion -9999))))))))
2053 (defun term-adjust-current-row-cache (delta)
2054 (if term-current-row
2055 (setq term-current-row (+ term-current-row delta))))
2057 (defun term-terminal-pos ()
2058 (save-excursion ; save-restriction
2059 (let ((save-col (term-current-column))
2060 x y)
2061 (term-vertical-motion 0)
2062 (setq x (- save-col (current-column)))
2063 (setq y (term-vertical-motion term-height))
2064 (cons x y))))
2066 ;;; Terminal emulation
2067 ;;; This is the standard process filter for term buffers.
2068 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2070 (defun term-emulate-terminal (proc str)
2071 (let* ((previous-buffer (current-buffer))
2072 (i 0) char funny count save-point save-marker old-point temp win
2073 (selected (selected-window))
2074 (str-length (length str)))
2075 (unwind-protect
2076 (progn
2077 (set-buffer (process-buffer proc))
2079 (if (marker-buffer term-pending-delete-marker)
2080 (progn
2081 ;; Delete text following term-pending-delete-marker.
2082 (delete-region term-pending-delete-marker (process-mark proc))
2083 (set-marker term-pending-delete-marker nil)))
2085 (if (eq (window-buffer) (current-buffer))
2086 (progn
2087 (setq term-vertical-motion (symbol-function 'vertical-motion))
2088 (term-check-size proc))
2089 (setq term-vertical-motion
2090 (symbol-function 'buffer-vertical-motion)))
2092 (setq save-marker (copy-marker (process-mark proc)))
2094 (if (/= (point) (process-mark proc))
2095 (progn (setq save-point (point-marker))
2096 (goto-char (process-mark proc))))
2098 (save-restriction
2099 ;; If the buffer is in line mode, and there is a partial
2100 ;; input line, save the line (by narrowing to leave it
2101 ;; outside the restriction ) until we're done with output.
2102 (if (and (> (point-max) (process-mark proc))
2103 (term-in-line-mode))
2104 (narrow-to-region (point-min) (process-mark proc)))
2106 (if term-log-buffer
2107 (princ str term-log-buffer))
2108 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2109 (setq str (concat term-terminal-parameter str))
2110 (setq term-terminal-parameter nil)
2111 (setq str-length (length str))
2112 (setq term-terminal-state 0)))
2114 (while (< i str-length)
2115 (setq char (aref str i))
2116 (cond ((< term-terminal-state 2)
2117 ;; Look for prefix of regular chars
2118 (setq funny
2120 str i))
2121 (if (not funny) (setq funny str-length))
2122 (cond ((> funny i)
2123 (cond ((eq term-terminal-state 1)
2124 (term-move-columns 1)
2125 (setq term-terminal-state 0)))
2126 (setq count (- funny i))
2127 (setq temp (- (+ (term-horizontal-column) count)
2128 term-width))
2129 (cond ((<= temp 0)) ;; All count chars fit in line.
2130 ((> count temp) ;; Some chars fit.
2131 ;; This iteration, handle only what fits.
2132 (setq count (- count temp))
2133 (setq funny (+ count i)))
2134 ((or (not (or term-pager-count
2135 term-scroll-with-delete))
2136 (> (term-handle-scroll 1) 0))
2137 (term-adjust-current-row-cache 1)
2138 (setq count (min count term-width))
2139 (setq funny (+ count i))
2140 (setq term-start-line-column
2141 term-current-column))
2142 (t ;; Doing PAGER processing.
2143 (setq count 0 funny i)
2144 (setq term-current-column nil)
2145 (setq term-start-line-column nil)))
2146 (setq old-point (point))
2147 ;; In the common case that we're at the end of
2148 ;; the buffer, we can save a little work.
2149 (cond ((/= (point) (point-max))
2150 (if term-insert-mode
2151 ;; Inserting spaces, then deleting them,
2152 ;; then inserting the actual text is
2153 ;; inefficient, but it is simple, and
2154 ;; the actual overhead is miniscule.
2155 (term-insert-spaces count))
2156 (term-move-columns count)
2157 (delete-region old-point (point)))
2158 (t (setq term-current-column (+ (term-current-column) count))))
2159 (insert (substring str i funny))
2160 (put-text-property old-point (point)
2161 'face term-current-face)
2162 ;; If the last char was written in last column,
2163 ;; back up one column, but remember we did so.
2164 ;; Thus we emulate xterm/vt100-style line-wrapping.
2165 (cond ((eq temp 0)
2166 (term-move-columns -1)
2167 (setq term-terminal-state 1)))
2168 (setq i (1- funny)))
2169 ((and (setq term-terminal-state 0)
2170 (eq char ?\^I)) ; TAB
2171 ;; FIXME: Does not handle line wrap!
2172 (setq count (term-current-column))
2173 (setq count (+ count 8 (- (mod count 8))))
2174 (if (< (move-to-column count nil) count)
2175 (term-insert-char char 1))
2176 (setq term-current-column count))
2178 ;; Optimize CRLF at end of buffer:
2179 (cond ((and (< (setq temp (1+ i)) str-length)
2181 (= (point) (point-max))
2182 (not (or term-pager-count
2183 term-kill-echo-list
2184 term-scroll-with-delete)))
2186 (term-adjust-current-row-cache 1)
2187 (setq term-start-line-column 0)
2188 (setq term-current-column 0)
2189 (setq i temp))
2190 (t ;; Not followed by LF or can't optimize:
2191 (term-vertical-motion 0)
2192 (setq term-current-column 0))))
2194 (if (not (and term-kill-echo-list
2195 (term-check-kill-echo-list)))
2196 (term-down 1 t)))
2198 (term-move-columns -1))
2200 (setq term-terminal-state 2))
2201 ((eq char 0)) ; NUL: Do nothing
2204 ((eq char ?\^G)
2205 (beep t)) ; Bell
2208 (if end
2209 (progn (funcall term-command-hook
2210 (substring str (1+ i) (1- end)))
2211 (setq i end))
2212 (setq term-terminal-parameter
2213 (substring str i))
2214 (setq term-terminal-state 4)
2215 (setq i str-length))))
2216 (t ; insert char FIXME: Should never happen
2217 (term-move-columns 1)
2218 (backward-delete-char 1)
2219 (insert char))))
2220 ((eq term-terminal-state 2) ; Seen Esc
2222 (make-local-variable 'term-terminal-parameter)
2223 (make-local-variable 'term-terminal-previous-parameter)
2224 (setq term-terminal-parameter 0)
2225 (setq term-terminal-previous-parameter 0)
2226 (setq term-terminal-state 3))
2227 ((eq char ?D) ;; scroll forward
2228 (term-handle-deferred-scroll)
2229 (term-down 1 t)
2230 (setq term-terminal-state 0))
2231 ((eq char ?M) ;; scroll reversed
2232 (term-insert-lines 1)
2233 (setq term-terminal-state 0))
2234 ((eq char ?7) ;; Save cursor
2235 (term-handle-deferred-scroll)
2236 (setq term-saved-cursor
2237 (cons (term-current-row)
2238 (term-horizontal-column)))
2239 (setq term-terminal-state 0))
2240 ((eq char ?8) ;; Restore cursor
2241 (if term-saved-cursor
2242 (term-goto (car term-saved-cursor)
2243 (cdr term-saved-cursor)))
2244 (setq term-terminal-state 0))
2245 ((setq term-terminal-state 0))))
2246 ((eq term-terminal-state 3) ; Seen Esc [
2247 (cond ((and (>= char ?0) (<= char ?9))
2248 (setq term-terminal-parameter
2249 (+ (* 10 term-terminal-parameter) (- char ?0))))
2251 (setq term-terminal-previous-parameter
2252 term-terminal-parameter)
2253 (setq term-terminal-parameter 0))
2254 ((eq char ??)) ; Ignore ?
2255 (t
2256 (term-handle-ansi-escape proc char)
2257 (setq term-terminal-state 0)))))
2258 (if (term-handling-pager)
2259 ;; Finish stuff to get ready to handle PAGER.
2260 (progn
2261 (if (> (% (current-column) term-width) 0)
2262 (setq term-terminal-parameter
2263 (substring str i))
2264 ;; We're at column 0. Goto end of buffer; to compensate,
2266 (if (zerop i)
2267 (setq term-terminal-parameter
2269 (setq term-terminal-parameter (substring str (1- i)))
2271 (goto-char (point-max)))
2272 (setq term-terminal-state 4)
2273 (make-local-variable 'term-pager-old-filter)
2274 (setq term-pager-old-filter (process-filter proc))
2275 (set-process-filter proc term-pager-filter)
2276 (setq i str-length)))
2277 (setq i (1+ i))))
2279 (if (>= (term-current-row) term-height)
2280 (term-handle-deferred-scroll))
2282 (set-marker (process-mark proc) (point))
2283 (if save-point
2284 (progn (goto-char save-point)
2285 (set-marker save-point nil)))
2287 ;; Check for a pending filename-and-line number to display.
2288 ;; We do this before scrolling, because we might create a new window.
2289 (if (and term-pending-frame
2290 (eq (window-buffer selected) (current-buffer)))
2291 (progn (term-display-line (car term-pending-frame)
2292 (cdr term-pending-frame))
2293 (setq term-pending-frame nil)
2294 ;; We have created a new window, so check the window size.
2295 (term-check-size proc)))
2297 ;; Scroll each window displaying the buffer but (by default)
2298 ;; only if the point matches the process-mark we started with.
2299 (setq win selected)
2300 (while (progn
2301 (setq win (next-window win nil t))
2302 (if (eq (window-buffer win) (process-buffer proc))
2303 (let ((scroll term-scroll-to-bottom-on-output))
2304 (select-window win)
2305 (if (or (= (point) save-marker)
2306 (eq scroll t) (eq scroll 'all)
2307 ;; Maybe user wants point to jump to the end.
2308 (and (eq selected win)
2309 (or (eq scroll 'this) (not save-point)))
2310 (and (eq scroll 'others)
2311 (not (eq selected win))))
2312 (progn
2313 (goto-char term-home-marker)
2314 (recenter 0)
2315 (goto-char (process-mark proc))
2316 (if (not (pos-visible-in-window-p (point) win))
2317 (recenter -1))))
2318 ;; Optionally scroll so that the text
2319 ;; ends at the bottom of the window.
2320 (if (and term-scroll-show-maximum-output
2321 (>= (point) (process-mark proc)))
2322 (save-excursion
2323 (goto-char (point-max))
2324 (recenter -1)))))
2325 (not (eq win selected))))
2327 (set-marker save-marker nil))
2328 ;; unwind-protect cleanup-forms follow:
2329 (set-buffer previous-buffer)
2330 (select-window selected))))
2332 (defun term-handle-deferred-scroll ()
2333 (let ((count (- (term-current-row) term-height)))
2334 (if (> count 0)
2335 (save-excursion
2336 (goto-char term-home-marker)
2337 (term-vertical-motion count)
2338 (set-marker term-home-marker (point))
2339 (setq term-current-row (1- term-height))))))
2341 ;;; Handle a character assuming (eq terminal-state 2) -
2342 ;;; i.e. we have previously seen Escape followed by ?[.
2344 (defun term-handle-ansi-escape (proc char)
2345 (cond
2346 ((eq char ?H) ; cursor motion
2347 (if (<= term-terminal-parameter 0)
2348 (setq term-terminal-parameter 1))
2349 (if (<= term-terminal-previous-parameter 0)
2350 (setq term-terminal-previous-parameter 1))
2351 (if (> term-terminal-previous-parameter term-height)
2352 (setq term-terminal-previous-parameter term-height))
2353 (if (> term-terminal-parameter term-width)
2354 (setq term-terminal-parameter term-width))
2355 (term-goto
2356 (1- term-terminal-previous-parameter)
2357 (1- term-terminal-parameter)))
2358 ;; \E[A - cursor up
2359 ((eq char ?A)
2360 (term-handle-deferred-scroll)
2361 (term-down (- (max 1 term-terminal-parameter)) t))
2362 ;; \E[B - cursor down
2363 ((eq char ?B)
2364 (term-down (max 1 term-terminal-parameter) t))
2365 ;; \E[C - cursor right
2366 ((eq char ?C)
2367 (term-move-columns (max 1 term-terminal-parameter)))
2368 ;; \E[D - cursor left
2369 ((eq char ?D)
2370 (term-move-columns (- (max 1 term-terminal-parameter))))
2371 ;; \E[J - clear to end of screen
2372 ((eq char ?J)
2373 (term-erase-in-display term-terminal-parameter))
2374 ;; \E[K - clear to end of line
2375 ((eq char ?K)
2376 (term-erase-in-line term-terminal-parameter))
2377 ;; \E[L - insert lines
2378 ((eq char ?L)
2379 (term-insert-lines (max 1 term-terminal-parameter)))
2380 ;; \E[M - delete lines
2381 ((eq char ?M)
2382 (term-delete-lines (max 1 term-terminal-parameter)))
2383 ;; \E[P - delete chars
2384 ((eq char ?P)
2385 (term-delete-chars (max 1 term-terminal-parameter)))
2386 ;; \E[@ - insert spaces
2387 ((eq char ?@)
2388 (term-insert-spaces (max 1 term-terminal-parameter)))
2389 ;; \E[?h - DEC Private Mode Set
2390 ((eq char ?h)
2391 (cond ((eq term-terminal-parameter 4)
2392 (setq term-insert-mode t))
2393 ((eq term-terminal-parameter 47)
2394 (term-switch-to-alternate-sub-buffer t))))
2395 ;; \E[?l - DEC Private Mode Reset
2396 ((eq char ?l)
2397 (cond ((eq term-terminal-parameter 4)
2398 (setq term-insert-mode nil))
2399 ((eq term-terminal-parameter 47)
2400 (term-switch-to-alternate-sub-buffer nil))))
2401 ;; \E[m - Set/reset standard mode
2402 ((eq char ?m)
2403 (cond ((eq term-terminal-parameter 7)
2404 (setq term-current-face 'highlight))
2405 ((eq term-terminal-parameter 4)
2406 (setq term-current-face 'term-underline-face))
2407 ((eq term-terminal-parameter 1)
2408 (setq term-current-face 'bold))
2409 (t (setq term-current-face 'default))))
2410 ;; \E[6n - Report cursor position
2411 ((eq char ?n)
2412 (term-handle-deferred-scroll)
2413 (process-send-string proc
2414 (format "\e[%s;%sR"
2415 (1+ (term-current-row))
2416 (1+ (term-horizontal-column)))))
2417 ;; \E[r - Set scrolling region
2418 ((eq char ?r)
2419 (term-scroll-region
2420 (1- term-terminal-previous-parameter)
2421 term-terminal-parameter))
2422 (t)))
2424 (defun term-scroll-region (top bottom)
2425 "Set scrolling region.
2426 TOP is the top-most line (inclusive) of the new scrolling region,
2427 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
2428 The top-most line is line 0."
2429 (setq term-scroll-start
2430 (if (or (< top 0) (>= top term-height))
2431 0
2432 top))
2433 (setq term-scroll-end
2434 (if (or (<= bottom term-scroll-start) (> bottom term-height))
2435 term-height
2436 bottom))
2437 (setq term-scroll-with-delete
2438 (or (term-using-alternate-sub-buffer)
2439 (not (and (= term-scroll-start 0)
2440 (= term-scroll-end term-height))))))
2442 (defun term-switch-to-alternate-sub-buffer (set)
2443 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
2444 ;; using it, do nothing. This test is needed for some programs (including
2445 ;; emacs) that emit the ti termcap string twice, for unknown reason.
2446 (term-handle-deferred-scroll)
2447 (if (eq set (not (term-using-alternate-sub-buffer)))
2448 (let ((row (term-current-row))
2449 (col (term-horizontal-column)))
2450 (cond (set
2451 (goto-char (point-max))
2454 (setq term-scroll-with-delete t)
2455 (setq term-saved-home-marker (copy-marker term-home-marker))
2456 (set-marker term-home-marker (point)))
2457 (t
2458 (setq term-scroll-with-delete
2459 (not (and (= term-scroll-start 0)
2460 (= term-scroll-end term-height))))
2461 (set-marker term-home-marker term-saved-home-marker)
2462 (set-marker term-saved-home-marker nil)
2463 (setq term-saved-home-marker nil)
2464 (goto-char term-home-marker)))
2465 (setq term-current-column nil)
2466 (setq term-current-row 0)
2467 (term-goto row col))))
2469 ;; Default value for the symbol term-command-hook.
2471 (defun term-command-hook (string)
2473 ;; gdb (when invoked with -fullname) prints:
2475 (let* ((first-colon (string-match ":" string 1))
2476 (second-colon
2477 (string-match ":" string (1+ first-colon)))
2478 (filename (substring string 1 first-colon))
2479 (fileline (string-to-int
2480 (substring string (1+ first-colon) second-colon))))
2481 (setq term-pending-frame (cons filename fileline))))
2482 ((= (aref string 0) ?/)
2483 (cd (substring string 1)))
2484 ;; Allowing the inferior to call functions in emacs is
2485 ;; probably too big a security hole.
2486 ;; ((= (aref string 0) ?!)
2487 ;; (eval (car (read-from-string string 1))))
2488 (t)));; Otherwise ignore it
2490 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2491 ;; and that its line LINE is visible.
2492 ;; Put the overlay-arrow on the line LINE in that buffer.
2493 ;; This is mainly used by gdb.
2495 (defun term-display-line (true-file line)
2496 (term-display-buffer-line (find-file-noselect true-file) line))
2498 (defun term-display-buffer-line (buffer line)
2499 (let* ((window (display-buffer buffer t))
2500 (pos))
2501 (save-excursion
2502 (set-buffer buffer)
2503 (save-restriction
2504 (widen)
2505 (goto-line line)
2506 (setq pos (point))
2507 (setq overlay-arrow-string "=>")
2508 (or overlay-arrow-position
2509 (setq overlay-arrow-position (make-marker)))
2510 (set-marker overlay-arrow-position (point) (current-buffer)))
2511 (cond ((or (< pos (point-min)) (> pos (point-max)))
2512 (widen)
2513 (goto-char pos))))
2514 (set-window-point window overlay-arrow-position)))
2516 ;;; The buffer-local marker term-home-marker defines the "home position"
2517 ;;; (in terms of cursor motion). However, we move the term-home-marker
2518 ;;; "down" as needed so that is no more that a window-full above (point-max).
2520 (defun term-goto-home ()
2521 (term-handle-deferred-scroll)
2522 (goto-char term-home-marker)
2523 (setq term-current-row 0)
2524 (setq term-current-column (current-column))
2525 (setq term-start-line-column term-current-column))
2527 (defun term-goto (row col)
2528 (term-handle-deferred-scroll)
2529 (cond ((and term-current-row (>= row term-current-row))
2530 ;; I assume this is a worthwhile optimization.
2531 (term-vertical-motion 0)
2532 (setq term-current-column term-start-line-column)
2533 (setq row (- row term-current-row)))
2534 (t
2535 (term-goto-home)))
2536 (term-down row)
2537 (term-move-columns col))
2539 ; The page is full, so enter "pager" mode, and wait for input.
2541 (defun term-process-pager ()
2542 (if (not term-pager-break-map)
2543 (let* ((map (make-keymap))
2544 (i 0) tmp)
2545 ; (while (< i 128)
2546 ; (define-key map (make-string 1 i) 'term-send-raw)
2547 ; (setq i (1+ i)))
2548 (define-key map "\e"
2549 (lookup-key (current-global-map) "\e"))
2550 (define-key map "\C-x"
2551 (lookup-key (current-global-map) "\C-x"))
2552 (define-key map "\C-u"
2553 (lookup-key (current-global-map) "\C-u"))
2554 (define-key map " " 'term-pager-page)
2556 (define-key map "?" 'term-pager-help)
2557 (define-key map "h" 'term-pager-help)
2558 (define-key map "b" 'term-pager-back-page)
2560 (define-key map "q" 'term-pager-discard)
2561 (define-key map "D" 'term-pager-disable)
2562 (define-key map "<" 'term-pager-bob)
2563 (define-key map ">" 'term-pager-eob)
2565 ;; Add menu bar.
2566 (term-if-emacs19
2567 (term-ifnot-xemacs
2568 (define-key map [menu-bar terminal] term-terminal-menu)
2569 (define-key map [menu-bar signals] term-signals-menu)
2570 (setq tmp (make-sparse-keymap "More pages?"))
2571 (define-key tmp [help] '("Help" . term-pager-help))
2572 (define-key tmp [disable]
2573 '("Disable paging" . term-fake-pager-disable))
2574 (define-key tmp [discard]
2575 '("Discard remaining output" . term-pager-discard))
2576 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
2577 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
2578 (define-key tmp [line] '("1 line forwards" . term-pager-line))
2579 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
2580 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
2581 (define-key tmp [page] '("1 page forwards" . term-pager-page))
2582 (define-key map [menu-bar page] (cons "More pages?" tmp))
2583 ))
2585 (setq term-pager-break-map map)))
2586 ; (let ((process (get-buffer-process (current-buffer))))
2587 ; (stop-process process))
2588 (setq term-pager-old-local-map (current-local-map))
2589 (use-local-map term-pager-break-map)
2590 (make-local-variable 'term-old-mode-line-format)
2591 (setq term-old-mode-line-format mode-line-format)
2592 (setq mode-line-format
2593 (list "-- **MORE** "
2594 mode-line-buffer-identification
2595 " [Type ? for help] "
2596 "%-"))
2597 (force-mode-line-update))
2599 (defun term-pager-line (lines)
2600 (interactive "p")
2601 (let* ((moved (vertical-motion (1+ lines)))
2602 (deficit (- lines moved)))
2603 (if (> moved lines)
2604 (backward-char))
2605 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
2606 (recenter (1- term-height)))
2607 ((term-pager-continue deficit)))))
2609 (defun term-pager-page (arg)
2610 "Proceed past the **MORE** break, allowing the next page of output to appear"
2611 (interactive "p")
2612 (term-pager-line (* arg term-height)))
2614 ; Pager mode command to go to beginning of buffer
2615 (defun term-pager-bob ()
2616 (interactive)
2617 (goto-char (point-min))
2618 (if (= (vertical-motion term-height) term-height)
2619 (backward-char))
2620 (recenter (1- term-height)))
2622 ; pager mode command to go to end of buffer
2623 (defun term-pager-eob ()
2624 (interactive)
2625 (goto-char term-home-marker)
2626 (recenter 0)
2627 (goto-char (process-mark (get-buffer-process (current-buffer)))))
2629 (defun term-pager-back-line (lines)
2630 (interactive "p")
2631 (vertical-motion (- 1 lines))
2632 (if (not (bobp))
2633 (backward-char)
2634 (beep)
2635 ;; Move cursor to end of window.
2636 (vertical-motion term-height)
2637 (backward-char))
2638 (recenter (1- term-height)))
2640 (defun term-pager-back-page (arg)
2641 (interactive "p")
2642 (term-pager-back-line (* arg term-height)))
2644 (defun term-pager-discard ()
2645 (interactive)
2646 (setq term-terminal-parameter "")
2647 (interrupt-process nil t)
2648 (term-pager-continue term-height))
2650 ; Disable pager processing.
2651 ; Only callable while in pager mode. (Contrast term-disable-pager.)
2652 (defun term-pager-disable ()
2653 (interactive)
2654 (if (term-handling-pager)
2655 (term-pager-continue nil)
2656 (setq term-pager-count nil))
2657 (term-update-mode-line))
2659 ; Enable pager processing.
2660 (defun term-pager-enable ()
2661 (interactive)
2662 (or (term-pager-enabled)
2663 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
2664 (term-update-mode-line))
2666 (defun term-pager-toggle ()
2667 (interactive)
2668 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
2670 (term-ifnot-xemacs
2671 (defalias 'term-fake-pager-enable 'term-pager-toggle)
2672 (defalias 'term-fake-pager-disable 'term-pager-toggle)
2673 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
2674 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
2675 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
2676 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
2678 (defun term-pager-help ()
2679 "Provide help on commands available in a terminal-emulator **MORE** break"
2680 (interactive)
2681 (message "Terminal-emulator pager break help...")
2682 (sit-for 0)
2683 (with-electric-help
2684 (function (lambda ()
2685 (princ (substitute-command-keys
2700 Any other key is passed through to the program
2701 running under the terminal emulator and disables pager processing until
2702 all pending output has been dealt with."))
2703 nil))))
2705 (defun term-pager-continue (new-count)
2706 (let ((process (get-buffer-process (current-buffer))))
2707 (use-local-map term-pager-old-local-map)
2708 (setq term-pager-old-local-map nil)
2709 (setq mode-line-format term-old-mode-line-format)
2710 (force-mode-line-update)
2711 (setq term-pager-count new-count)
2712 (set-process-filter process term-pager-old-filter)
2713 (funcall term-pager-old-filter process "")
2714 (continue-process process)))
2716 ;; Make sure there are DOWN blank lines below the current one.
2717 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
2719 (defun term-handle-scroll (down)
2720 (let ((scroll-needed
2721 (- (+ (term-current-row) down 1) term-scroll-end)))
2722 (if (> scroll-needed 0)
2723 (let ((save-point (copy-marker (point))) (save-top))
2724 (goto-char term-home-marker)
2725 (cond (term-scroll-with-delete
2726 ;; delete scroll-needed lines at term-scroll-start
2727 (term-vertical-motion term-scroll-start)
2728 (setq save-top (point))
2729 (term-vertical-motion scroll-needed)
2730 (delete-region save-top (point))
2731 (goto-char save-point)
2732 (term-vertical-motion down)
2733 (term-adjust-current-row-cache (- scroll-needed))
2734 (setq term-current-column nil)
2736 ((and (numberp term-pager-count)
2737 (< (setq term-pager-count (- term-pager-count down))
2738 0))
2739 (setq down 0)
2740 (term-process-pager))
2741 (t
2742 (term-adjust-current-row-cache (- scroll-needed))
2743 (term-vertical-motion scroll-needed)
2744 (set-marker term-home-marker (point))))
2745 (goto-char save-point)
2746 (set-marker save-point nil))))
2747 down)
2749 (defun term-down (down &optional check-for-scroll)
2750 "Move down DOWN screen lines vertically."
2751 (let ((start-column (term-horizontal-column)))
2752 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
2753 (setq down (term-handle-scroll down)))
2754 (term-adjust-current-row-cache down)
2755 (if (/= (point) (point-max))
2756 (setq down (- down (term-vertical-motion down))))
2757 ;; Extend buffer with extra blank lines if needed.
2758 (cond ((> down 0)
2760 (setq term-current-column 0)
2761 (setq term-start-line-column 0))
2762 (t
2763 (setq term-current-column nil)
2764 (setq term-start-line-column (current-column))))
2765 (if start-column
2766 (term-move-columns start-column))))
2768 ;; Assuming point is at the beginning of a screen line,
2770 ;; FIXME: Probably should be called more than it is.
2771 (defun term-unwrap-line ()
2774 (defun term-erase-in-line (kind)
2775 (if (> kind 1) ;; erase left of point
2776 (let ((cols (term-horizontal-column)) (saved-point (point)))
2777 (term-vertical-motion 0)
2778 (delete-region (point) saved-point)
2780 (if (not (eq kind 1)) ;; erase right of point
2781 (let ((saved-point (point))
2782 (wrapped (and (zerop (term-horizontal-column))
2783 (not (zerop (term-current-column))))))
2784 (term-vertical-motion 1)
2785 (delete-region saved-point (point))
2786 ;; wrapped is true if we're at the beginning of screen line,
2787 ;; but not a buffer line. If we delete the current screen line
2788 ;; that will make the previous line no longer wrap, and (because
2789 ;; of the way emacs display works) point will be at the end of
2790 ;; the previous screen line rather then the beginning of the
2791 ;; current one. To avoid that, we make sure that current line
2792 ;; contain a space, to force the previous line to continue to wrap.
2793 ;; We could do this always, but it seems preferable to not add the
2794 ;; extra space when wrapped is false.
2795 (if wrapped
2796 (insert ? ))
2798 (put-text-property saved-point (point) 'face 'default)
2799 (goto-char saved-point))))
2801 (defun term-erase-in-display (kind)
2802 "Erases (that is blanks out) part of the window.
2803 If KIND is 0, erase from (point) to (point-max);
2804 if KIND is 1, erase from home to point; else erase from home to point-max.
2805 Should only be called when point is at the start of a screen line."
2806 (term-handle-deferred-scroll)
2807 (cond ((eq term-terminal-parameter 0)
2808 (delete-region (point) (point-max))
2809 (term-unwrap-line))
2810 ((let ((row (term-current-row))
2811 (col (term-horizontal-column))
2812 (start-region term-home-marker)
2813 (end-region (if (eq kind 1) (point) (point-max))))
2814 (delete-region start-region end-region)
2815 (term-unwrap-line)
2816 (if (eq kind 1)
2818 (setq term-current-column nil)
2819 (setq term-current-row nil)
2820 (term-goto row col)))))
2822 (defun term-delete-chars (count)
2823 (let ((save-point (point)))
2824 (term-vertical-motion 1)
2825 (term-unwrap-line)
2826 (goto-char save-point)
2827 (move-to-column (+ (term-current-column) count) t)
2828 (delete-region save-point (point))))
2830 ;;; Insert COUNT spaces after point, but do not change any of
2831 ;;; following screen lines. Hence we may have to delete characters
2832 ;;; at teh end of this screen line to make room.
2834 (defun term-insert-spaces (count)
2835 (let ((save-point (point)) (save-eol))
2836 (term-vertical-motion 1)
2837 (if (bolp)
2838 (backward-char))
2839 (setq save-eol (point))
2840 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
2841 (if (> save-eol (point))
2842 (delete-region (point) save-eol))
2843 (goto-char save-point)
2844 (term-insert-char ? count)
2845 (goto-char save-point)))
2847 (defun term-delete-lines (lines)
2848 (let ((start (point))
2849 (save-current-column term-current-column)
2850 (save-start-line-column term-start-line-column)
2851 (save-current-row (term-current-row)))
2852 (term-down lines)
2853 (delete-region start (point))
2854 (term-down (- term-scroll-end save-current-row lines))
2856 (setq term-current-column save-current-column)
2857 (setq term-start-line-column save-start-line-column)
2858 (setq term-current-row save-current-row)
2859 (goto-char start)))
2861 (defun term-insert-lines (lines)
2862 (let ((start (point))
2863 (start-deleted)
2864 (save-current-column term-current-column)
2865 (save-start-line-column term-start-line-column)
2866 (save-current-row (term-current-row)))
2867 (term-down (- term-scroll-end save-current-row lines))
2868 (setq start-deleted (point))
2869 (term-down lines)
2870 (delete-region start-deleted (point))
2871 (goto-char start)
2872 (setq term-current-column save-current-column)
2873 (setq term-start-line-column save-start-line-column)
2874 (setq term-current-row save-current-row)
2876 (goto-char start)))
2877 \f
2878 (defun term-set-output-log (name)
2879 "Record raw inferior process output in a buffer."
2880 (interactive (list (if term-log-buffer
2881 nil
2882 (read-buffer "Record output in buffer: "
2883 (format "%s output-log"
2884 (buffer-name (current-buffer)))
2885 nil))))
2886 (if (or (null name) (equal name ""))
2887 (progn (setq term-log-buffer nil)
2888 (message "Output logging off."))
2889 (if (get-buffer name)
2890 nil
2891 (save-excursion
2892 (set-buffer (get-buffer-create name))
2893 (fundamental-mode)
2894 (buffer-disable-undo (current-buffer))
2895 (erase-buffer)))
2896 (setq term-log-buffer (get-buffer name))
2898 (buffer-name term-log-buffer))))
2900 (defun term-stop-photo ()
2901 "Discontinue raw inferior process logging."
2902 (interactive)
2903 (term-set-output-log nil))
2905 (defun term-show-maximum-output ()
2906 "Put the end of the buffer at the bottom of the window."
2907 (interactive)
2908 (goto-char (point-max))
2909 (recenter -1))
2910 \f
2911 ;;; Do the user's customisation...
2913 (defvar term-load-hook nil
2914 "This hook is run when term is loaded in.
2915 This is a good place to put keybindings.")
2917 (run-hooks 'term-load-hook)
2919 \f
2920 ;;; Filename/command/history completion in a buffer
2921 ;;; ===========================================================================
2922 ;;; Useful completion functions, courtesy of the Ergo group.
2924 ;;; Six commands:
2925 ;;; term-dynamic-complete Complete or expand command, filename,
2926 ;;; history at point.
2927 ;;; term-dynamic-complete-filename Complete filename at point.
2928 ;;; term-dynamic-list-filename-completions List completions in help buffer.
2929 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
2930 ;;; replace with expanded/completed name.
2931 ;;; term-dynamic-simple-complete Complete stub given candidates.
2933 ;;; These are not installed in the term-mode keymap. But they are
2934 ;;; available for people who want them. Shell-mode installs them:
2936 ;;; (define-key shell-mode-map "\M-?"
2937 ;;; 'term-dynamic-list-filename-completions)))
2938 ;;;
2939 ;;; Commands like this are fine things to put in load hooks if you
2940 ;;; want them present in specific modes.
2942 (defvar term-completion-autolist nil
2943 "*If non-nil, automatically list possibilities on partial completion.
2944 This mirrors the optional behavior of tcsh.")
2946 (defvar term-completion-addsuffix t
2947 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2948 This mirrors the optional behavior of tcsh.")
2950 (defvar term-completion-recexact nil
2951 "*If non-nil, use shortest completion if characters cannot be added.
2952 This mirrors the optional behavior of tcsh.
2954 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
2956 (defvar term-completion-fignore nil
2957 "*List of suffixes to be disregarded during file completion.
2958 This mirrors the optional behavior of bash and tcsh.
2960 Note that this applies to `term-dynamic-complete-filename' only.")
2962 (defvar term-file-name-prefix ""
2963 "Prefix prepended to absolute file names taken from process input.
2964 This is used by term's and shell's completion functions, and by shell's
2965 directory tracking functions.")
2968 (defun term-directory (directory)
2969 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
2970 (expand-file-name (if (file-name-absolute-p directory)
2971 (concat term-file-name-prefix directory)
2972 directory)))
2975 (defun term-word (word-chars)
2976 "Return the word of WORD-CHARS at point, or nil if non is found.
2977 Word constituents are considered to be those in WORD-CHARS, which is like the
2979 (save-excursion
2980 (let ((limit (point))
2981 (word (concat "[" word-chars "]"))
2982 (non-word (concat "[^" word-chars "]")))
2983 (if (re-search-backward non-word nil 'move)
2984 (forward-char 1))
2985 ;; Anchor the search forwards.
2986 (if (or (eolp) (looking-at non-word))
2987 nil
2988 (re-search-forward (concat word "+") limit)
2989 (buffer-substring (match-beginning 0) (match-end 0))))))
2992 (defun term-match-partial-filename ()
2993 "Return the filename at point, or nil if non is found.
2994 Environment variables are substituted. See `term-word'."
2995 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
2996 (and filename (substitute-in-file-name filename))))
2999 (defun term-dynamic-complete ()
3000 "Dynamically perform completion at point.
3001 Calls the functions in `term-dynamic-complete-functions' to perform
3002 completion until a function returns non-nil, at which point completion is
3003 assumed to have occurred."
3004 (interactive)
3005 (let ((functions term-dynamic-complete-functions))
3006 (while (and functions (null (funcall (car functions))))
3007 (setq functions (cdr functions)))))
3010 (defun term-dynamic-complete-filename ()
3011 "Dynamically complete the filename at point.
3012 Completes if after a filename. See `term-match-partial-filename' and
3013 `term-dynamic-complete-as-filename'.
3014 This function is similar to `term-replace-by-expanded-filename', except that
3015 it won't change parts of the filename already entered in the buffer; it just
3016 adds completion characters to the end of the filename. A completions listing
3017 may be shown in a help buffer if completion is ambiguous.
3019 Completion is dependent on the value of `term-completion-addsuffix',
3020 `term-completion-recexact' and `term-completion-fignore', and the timing of
3021 completions listing is dependent on the value of `term-completion-autolist'.
3023 Returns t if successful."
3024 (interactive)
3025 (if (term-match-partial-filename)
3026 (prog2 (or (eq (selected-window) (minibuffer-window))
3027 (message "Completing file name..."))
3028 (term-dynamic-complete-as-filename))))
3030 (defun term-dynamic-complete-as-filename ()
3031 "Dynamically complete at point as a filename.
3032 See `term-dynamic-complete-filename'. Returns t if successful."
3033 (let* ((completion-ignore-case nil)
3034 (completion-ignored-extensions term-completion-fignore)
3035 (success t)
3036 (filename (or (term-match-partial-filename) ""))
3037 (pathdir (file-name-directory filename))
3038 (pathnondir (file-name-nondirectory filename))
3039 (directory (if pathdir (term-directory pathdir) default-directory))
3040 (completion (file-name-completion pathnondir directory))
3041 (mini-flag (eq (selected-window) (minibuffer-window))))
3042 (cond ((null completion)
3043 (message "No completions of %s" filename)
3044 (setq success nil))
3045 ((eq completion t) ; Means already completed "file".
3046 (if term-completion-addsuffix (insert " "))
3047 (or mini-flag (message "Sole completion")))
3048 ((string-equal completion "") ; Means completion on "directory/".
3049 (term-dynamic-list-filename-completions))
3050 (t ; Completion string returned.
3051 (let ((file (concat (file-name-as-directory directory) completion)))
3052 (insert (substring (directory-file-name completion)
3053 (length pathnondir)))
3054 (cond ((symbolp (file-name-completion completion directory))
3055 ;; We inserted a unique completion.
3056 (if term-completion-addsuffix
3057 (insert (if (file-directory-p file) "/" " ")))
3058 (or mini-flag (message "Completed")))
3059 ((and term-completion-recexact term-completion-addsuffix
3060 (string-equal pathnondir completion)
3061 (file-exists-p file))
3062 ;; It's not unique, but user wants shortest match.
3063 (insert (if (file-directory-p file) "/" " "))
3064 (or mini-flag (message "Completed shortest")))
3065 ((or term-completion-autolist
3066 (string-equal pathnondir completion))
3067 ;; It's not unique, list possible completions.
3068 (term-dynamic-list-filename-completions))
3069 (t
3070 (or mini-flag (message "Partially completed")))))))
3071 success))
3074 (defun term-replace-by-expanded-filename ()
3075 "Dynamically expand and complete the filename at point.
3076 Replace the filename with an expanded, canonicalised and completed replacement.
3079 removed, and the filename is made absolute instead of relative. For expansion
3080 see `expand-file-name' and `substitute-in-file-name'. For completion see
3081 `term-dynamic-complete-filename'."
3082 (interactive)
3083 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3084 (term-dynamic-complete-filename))
3087 (defun term-dynamic-simple-complete (stub candidates)
3088 "Dynamically complete STUB from CANDIDATES list.
3089 This function inserts completion characters at point by completing STUB from
3090 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3091 if completion is ambiguous.
3093 Returns nil if no completion was inserted.
3094 Returns `sole' if completed with the only completion match.
3095 Returns `shortest' if completed with the shortest of the completion matches.
3096 Returns `partial' if completed as far as possible with the completion matches.
3097 Returns `listed' if a completion listing was shown.
3099 See also `term-dynamic-complete-filename'."
3100 (let* ((completion-ignore-case nil)
3101 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3102 (completions (all-completions stub candidates)))
3103 (cond ((null completions)
3104 (message "No completions of %s" stub)
3105 nil)
3106 ((= 1 (length completions)) ; Gotcha!
3107 (let ((completion (car completions)))
3108 (if (string-equal completion stub)
3109 (message "Sole completion")
3110 (insert (substring completion (length stub)))
3111 (message "Completed"))
3112 (if term-completion-addsuffix (insert " "))
3113 'sole))
3114 (t ; There's no unique completion.
3115 (let ((completion (try-completion stub candidates)))
3116 ;; Insert the longest substring.
3117 (insert (substring completion (length stub)))
3118 (cond ((and term-completion-recexact term-completion-addsuffix
3119 (string-equal stub completion)
3120 (member completion completions))
3121 ;; It's not unique, but user wants shortest match.
3122 (insert " ")
3123 (message "Completed shortest")
3124 'shortest)
3125 ((or term-completion-autolist
3126 (string-equal stub completion))
3127 ;; It's not unique, list possible completions.
3128 (term-dynamic-list-completions completions)
3129 'listed)
3130 (t
3131 (message "Partially completed")
3132 'partial)))))))
3135 (defun term-dynamic-list-filename-completions ()
3136 "List in help buffer possible completions of the filename at point."
3137 (interactive)
3138 (let* ((completion-ignore-case nil)
3139 (filename (or (term-match-partial-filename) ""))
3140 (pathdir (file-name-directory filename))
3141 (pathnondir (file-name-nondirectory filename))
3142 (directory (if pathdir (term-directory pathdir) default-directory))
3143 (completions (file-name-all-completions pathnondir directory)))
3144 (if completions
3145 (term-dynamic-list-completions completions)
3146 (message "No completions of %s" filename))))
3149 (defun term-dynamic-list-completions (completions)
3150 "List in help buffer sorted COMPLETIONS.
3151 Typing SPC flushes the help buffer."
3152 (let ((conf (current-window-configuration)))
3153 (with-output-to-temp-buffer "*Completions*"
3154 (display-completion-list (sort completions 'string-lessp)))
3155 (message "Hit space to flush")
3156 (let (key first)
3157 (if (save-excursion
3158 (set-buffer (get-buffer "*Completions*"))
3159 (setq key (read-key-sequence nil)
3160 first (aref key 0))
3161 (and (consp first)
3162 (eq (window-buffer (posn-window (event-start first)))
3163 (get-buffer "*Completions*"))
3164 (eq (key-binding key) 'mouse-choose-completion)))
3165 ;; If the user does mouse-choose-completion with the mouse,
3166 ;; execute the command, then delete the completion window.
3167 (progn
3168 (mouse-choose-completion first)
3169 (set-window-configuration conf))
3170 (if (eq first ?\ )
3171 (set-window-configuration conf)
3172 (setq unread-command-events (listify-key-sequence key)))))))
3173 \f
3174 ;;; Converting process modes to use term mode
3175 ;;; ===========================================================================
3176 ;;; Renaming variables
3177 ;;; Most of the work is renaming variables and functions. These are the common
3178 ;;; ones:
3179 ;;; Local variables:
3180 ;;; last-input-start term-last-input-start
3181 ;;; last-input-end term-last-input-end
3182 ;;; shell-prompt-pattern term-prompt-regexp
3183 ;;; shell-set-directory-error-hook <no equivalent>
3184 ;;; Miscellaneous:
3185 ;;; shell-set-directory <unnecessary>
3186 ;;; shell-mode-map term-mode-map
3187 ;;; Commands:
3188 ;;; shell-send-input term-send-input
3189 ;;; shell-send-eof term-delchar-or-maybe-eof
3190 ;;; kill-shell-input term-kill-input
3191 ;;; interrupt-shell-subjob term-interrupt-subjob
3192 ;;; stop-shell-subjob term-stop-subjob
3193 ;;; quit-shell-subjob term-quit-subjob
3194 ;;; kill-shell-subjob term-kill-subjob
3195 ;;; kill-output-from-shell term-kill-output
3196 ;;; show-output-from-shell term-show-output
3197 ;;; copy-last-shell-input Use term-previous-input/term-next-input
3198 ;;;
3199 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3200 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
3201 ;;; Term mode does not provide functionality equivalent to
3202 ;;; shell-set-directory-error-hook; it is gone.
3203 ;;;
3204 ;;; term-last-input-start is provided for modes which want to munge
3205 ;;; the buffer after input is sent, perhaps because the inferior
3206 ;;; insists on echoing the input. The LAST-INPUT-START variable in
3207 ;;; the old shell package was used to implement a history mechanism,
3208 ;;; but you should think twice before using term-last-input-start
3209 ;;; for this; the input history ring often does the job better.
3210 ;;;
3211 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3212 ;;; *not* create the term-mode local variables in your foo-mode function.
3213 ;;; This is not modular. Instead, call term-mode, and let *it* create the
3214 ;;; necessary term-specific local variables. Then create the
3215 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3216 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
3217 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
3218 ;;; get-old-input) that need to be different from the defaults. Call
3219 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
3220 ;;; term-mode will take care of it. The following example, from shell.el,
3221 ;;; is typical:
3222 ;;;
3223 ;;; (defvar shell-mode-map '())
3224 ;;; (cond ((not shell-mode-map)
3225 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
3226 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3227 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3229 ;;; (define-key shell-mode-map "\M-?"
3230 ;;; 'term-dynamic-list-filename-completions)))
3231 ;;;
3232 ;;; (defun shell-mode ()
3233 ;;; (interactive)
3234 ;;; (term-mode)
3235 ;;; (setq term-prompt-regexp shell-prompt-pattern)
3236 ;;; (setq major-mode 'shell-mode)
3237 ;;; (setq mode-name "Shell")
3238 ;;; (use-local-map shell-mode-map)
3239 ;;; (make-local-variable 'shell-directory-stack)
3240 ;;; (setq shell-directory-stack nil)
3241 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
3242 ;;; (run-hooks 'shell-mode-hook))
3243 ;;;
3244 ;;;
3245 ;;; Note that make-term is different from make-shell in that it
3246 ;;; doesn't have a default program argument. If you give make-shell
3247 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
3248 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-term a program argument
3249 ;;; of NIL, it barfs. Adjust your code accordingly...
3250 ;;;
3251 ;;; Completion for term-mode users
3252 ;;;
3253 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
3254 ;;; hook to add completion functions to. Functions on this list should return
3255 ;;; non-nil if completion occurs (i.e., further completion should not occur).
3256 ;;; You could use term-dynamic-simple-complete to do the bulk of the
3257 ;;; completion job.
3258 \f
3259 (provide 'term)
3261 ;;; term.el ends here