1 ;;; em-term.el --- running visual commands -*- lexical-binding:t -*-
3 ;; Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; At the moment, eshell is stream-based in its interactive input and
25 ;; output. This means that full-screen commands, such as "vi" or
26 ;; "lynx", will not display correctly. These are therefore thought of
27 ;; as "visual" programs. In order to run these programs under Emacs,
28 ;; Eshell uses the term.el package, and invokes them in a separate
29 ;; buffer, giving the illusion that Eshell itself is allowing these
30 ;; visual processes to execute.
37 (eval-when-compile (require 'eshell))
42 (defgroup eshell-term nil
43 "This module causes visual commands (e.g., `vi') to be executed by
44 the `term' package, which comes with Emacs. This package handles most
45 of the ANSI control codes, allowing curses-based applications to run
46 within an Emacs window. The variable `eshell-visual-commands' defines
47 which commands are considered visual in nature."
48 :tag "Running visual commands"
49 :group 'eshell-module))
53 (defcustom eshell-term-load-hook nil
54 "A list of functions to call when loading `eshell-term'."
55 :version "24.1" ; removed eshell-term-initialize
59 (defcustom eshell-visual-commands
60 '("vi" ; what is going on??
61 "screen" "top" ; ok, a valid program...
62 "less" "more" ; M-x view-file
63 "lynx" "ncftp" ; w3.el, ange-ftp
64 "pine" "tin" "trn" "elm") ; GNUS!!
65 "A list of commands that present their output in a visual fashion.
67 Commands listed here are run in a term buffer.
69 See also `eshell-visual-subcommands' and `eshell-visual-options'."
70 :type '(repeat string)
73 (defcustom eshell-visual-subcommands
75 "An alist of subcommands that present their output in a visual fashion.
79 ((COMMAND1 SUBCOMMAND1 SUBCOMMAND2...)
80 (COMMAND2 SUBCOMMAND1 ...))
82 of commands with subcommands that present their output in a
83 visual fashion. A likely entry is
85 (\"git\" \"log\" \"diff\" \"show\")
87 because git shows logs and diffs using a pager by default.
89 See also `eshell-visual-commands' and `eshell-visual-options'."
90 :type '(repeat (cons (string :tag "Command")
91 (repeat (string :tag "Subcommand"))))
95 (defcustom eshell-visual-options
99 ((COMMAND1 OPTION1 OPTION2...)
100 (COMMAND2 OPTION1 ...))
102 of commands with options that present their output in a visual
103 fashion. For example, a sensible entry would be
107 because \"git <command> --help\" shows the command's
108 documentation with a pager.
110 See also `eshell-visual-commands' and `eshell-visual-subcommands'."
111 :type '(repeat (cons (string :tag "Command")
112 (repeat (string :tag "Option"))))
116 ;; If you change this from term-term-name, you need to ensure that the
117 ;; value you choose exists in the system's terminfo database. (Bug#12485)
118 (defcustom eshell-term-name term-term-name
119 "Name to use for the TERM variable when running visual commands.
120 See `term-term-name' in term.el for more information on how this is
122 :version "24.3" ; eterm -> term-term-name = eterm-color
126 (defcustom eshell-escape-control-x t
127 "If non-nil, allow <C-x> to be handled by Emacs key in visual buffers.
128 See the variables `eshell-visual-commands',
129 `eshell-visual-subcommands', and `eshell-visual-options'. If
130 this variable is set to nil, <C-x> will send that control
131 character to the invoked process."
135 (defcustom eshell-destroy-buffer-when-process-dies nil
136 "If non-nil, term buffers are destroyed after their processes die.
137 WARNING: Setting this to non-nil may result in unexpected
138 behavior for short-lived processes, see bug#18108."
143 ;;; Internal Variables:
145 (defvar eshell-parent-buffer)
149 (defun eshell-term-initialize ()
150 "Initialize the `term' interface code."
151 (make-local-variable 'eshell-interpreter-alist)
152 (setq eshell-interpreter-alist
153 (cons (cons #'eshell-visual-command-p
155 eshell-interpreter-alist)))
157 (defun eshell-visual-command-p (command args)
158 "Returns non-nil when given a visual command.
159 If either COMMAND or a subcommand in ARGS (e.g. git log) is a
160 visual command, returns non-nil."
161 (let ((command (file-name-nondirectory command)))
162 (and (eshell-interactive-output-p)
163 (or (member command eshell-visual-commands)
165 (cdr (assoc command eshell-visual-subcommands)))
166 (cl-intersection args
167 (cdr (assoc command eshell-visual-options))
170 (defun eshell-exec-visual (&rest args)
171 "Run the specified PROGRAM in a terminal emulation buffer.
172 ARGS are passed to the program. At the moment, no piping of input is
174 (let* (eshell-interpreter-alist
175 (interp (eshell-find-interpreter (car args) (cdr args)))
176 (program (car interp))
177 (args (eshell-flatten-list
178 (eshell-stringify-list (append (cdr interp)
182 (concat "*" (file-name-nondirectory program) "*")))
183 (eshell-buf (current-buffer)))
185 (switch-to-buffer term-buf)
187 (set (make-local-variable 'term-term-name) eshell-term-name)
188 (make-local-variable 'eshell-parent-buffer)
189 (setq eshell-parent-buffer eshell-buf)
190 (term-exec term-buf program program nil args)
191 (let ((proc (get-buffer-process term-buf)))
192 (if (and proc (eq 'run (process-status proc)))
193 (set-process-sentinel proc 'eshell-term-sentinel)
194 (error "Failed to invoke visual command")))
196 (if eshell-escape-control-x
197 (term-set-escape-char ?\C-x))))
200 ;; Process sentinels receive two arguments.
201 (defun eshell-term-sentinel (proc msg)
202 "Clean up the buffer visiting PROC.
203 If `eshell-destroy-buffer-when-process-dies' is non-nil, destroy
205 (term-sentinel proc msg) ;; First call the normal term sentinel.
206 (when eshell-destroy-buffer-when-process-dies
207 (let ((proc-buf (process-buffer proc)))
208 (when (and proc-buf (buffer-live-p proc-buf)
209 (not (eq 'run (process-status proc)))
210 (= (process-exit-status proc) 0))
211 (if (eq (current-buffer) proc-buf)
212 (let ((buf (and (boundp 'eshell-parent-buffer)
214 (buffer-live-p eshell-parent-buffer)
215 eshell-parent-buffer)))
217 (switch-to-buffer buf))))
218 (kill-buffer proc-buf)))))
220 ;; jww (1999-09-17): The code below will allow Eshell to send input
221 ;; characters directly to the currently running interactive process.
222 ;; However, since this would introduce other problems that would need
223 ;; solutions, I'm going to let it wait until after 2.1.
225 ; (defvar eshell-term-raw-map nil
226 ; "Keyboard map for sending characters directly to the inferior process.")
227 ; (defvar eshell-term-escape-char nil
228 ; "Escape character for char-sub-mode of term mode.
229 ; Do not change it directly; use term-set-escape-char instead.")
230 ; (defvar eshell-term-raw-escape-map nil)
232 ; (defun eshell-term-send-raw-string (chars)
233 ; (goto-char eshell-last-output-end)
234 ; (process-send-string (eshell-interactive-process) chars))
236 ; (defun eshell-term-send-raw ()
237 ; "Send the last character typed through the terminal-emulator
238 ; without any interpretation."
240 ; ;; Convert `return' to C-m, etc.
241 ; (if (and (symbolp last-input-event)
242 ; (get last-input-event 'ascii-character))
243 ; (setq last-input-event (get last-input-event 'ascii-character)))
244 ; (eshell-term-send-raw-string (make-string 1 last-input-event)))
246 ; (defun eshell-term-send-raw-meta ()
248 ; (if (symbolp last-input-event)
249 ; ;; Convert `return' to C-m, etc.
250 ; (let ((tmp (get last-input-event 'event-symbol-elements)))
252 ; (setq last-input-event (car tmp)))
253 ; (if (symbolp last-input-event)
255 ; (setq tmp (get last-input-event 'ascii-character))
256 ; (if tmp (setq last-input-event tmp))))))
257 ; (eshell-term-send-raw-string (if (and (numberp last-input-event)
258 ; (> last-input-event 127)
259 ; (< last-input-event 256))
260 ; (make-string 1 last-input-event)
261 ; (format "\e%c" last-input-event))))
263 ; (defun eshell-term-mouse-paste (click arg)
264 ; "Insert the last stretch of killed text at the position clicked on."
265 ; (interactive "e\nP")
266 ; (if (boundp 'xemacs-logo)
267 ; (eshell-term-send-raw-string
268 ; (or (condition-case () (x-get-selection) (error ()))
269 ; (error "No selection available")))
270 ; ;; Give temporary modes such as isearch a chance to turn off.
271 ; (run-hooks 'mouse-leave-buffer-hook)
272 ; (setq this-command 'yank)
273 ; (eshell-term-send-raw-string
274 ; (current-kill (cond ((listp arg) 0)
278 ; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
279 ; ;; For my configuration it's definitely better \eOA but YMMV. -mm
280 ; ;; For example: vi works with \eOA while elm wants \e[A ...
281 ; (defun eshell-term-send-up () (interactive) (eshell-term-send-raw-string "\eOA"))
282 ; (defun eshell-term-send-down () (interactive) (eshell-term-send-raw-string "\eOB"))
283 ; (defun eshell-term-send-right () (interactive) (eshell-term-send-raw-string "\eOC"))
284 ; (defun eshell-term-send-left () (interactive) (eshell-term-send-raw-string "\eOD"))
285 ; (defun eshell-term-send-home () (interactive) (eshell-term-send-raw-string "\e[1~"))
286 ; (defun eshell-term-send-end () (interactive) (eshell-term-send-raw-string "\e[4~"))
287 ; (defun eshell-term-send-prior () (interactive) (eshell-term-send-raw-string "\e[5~"))
288 ; (defun eshell-term-send-next () (interactive) (eshell-term-send-raw-string "\e[6~"))
289 ; (defun eshell-term-send-del () (interactive) (eshell-term-send-raw-string "\C-?"))
290 ; (defun eshell-term-send-backspace () (interactive) (eshell-term-send-raw-string "\C-H"))
292 ; (defun eshell-term-set-escape-char (c)
293 ; "Change term-escape-char and keymaps that depend on it."
294 ; (if eshell-term-escape-char
295 ; (define-key eshell-term-raw-map eshell-term-escape-char 'eshell-term-send-raw))
296 ; (setq c (make-string 1 c))
297 ; (define-key eshell-term-raw-map c eshell-term-raw-escape-map)
298 ; ;; Define standard bindings in eshell-term-raw-escape-map
299 ; (define-key eshell-term-raw-escape-map "\C-x"
300 ; (lookup-key (current-global-map) "\C-x"))
301 ; (define-key eshell-term-raw-escape-map "\C-v"
302 ; (lookup-key (current-global-map) "\C-v"))
303 ; (define-key eshell-term-raw-escape-map "\C-u"
304 ; (lookup-key (current-global-map) "\C-u"))
305 ; (define-key eshell-term-raw-escape-map c 'eshell-term-send-raw))
307 ; (defun eshell-term-char-mode ()
308 ; "Switch to char (\"raw\") sub-mode of term mode.
309 ; Each character you type is sent directly to the inferior without
310 ; intervention from Emacs, except for the escape character (usually C-c)."
312 ; (if (not eshell-term-raw-map)
313 ; (let* ((map (make-keymap))
314 ; (esc-map (make-keymap))
317 ; (define-key map (make-string 1 i) 'eshell-term-send-raw)
318 ; (define-key esc-map (make-string 1 i) 'eshell-term-send-raw-meta)
320 ; (define-key map "\e" esc-map)
321 ; (setq eshell-term-raw-map map)
322 ; (setq eshell-term-raw-escape-map
323 ; (copy-keymap (lookup-key (current-global-map) "\C-x")))
324 ; (if (boundp 'xemacs-logo)
325 ; (define-key eshell-term-raw-map [button2] 'eshell-term-mouse-paste)
326 ; (define-key eshell-term-raw-map [mouse-2] 'eshell-term-mouse-paste))
327 ; (define-key eshell-term-raw-map [up] 'eshell-term-send-up)
328 ; (define-key eshell-term-raw-map [down] 'eshell-term-send-down)
329 ; (define-key eshell-term-raw-map [right] 'eshell-term-send-right)
330 ; (define-key eshell-term-raw-map [left] 'eshell-term-send-left)
331 ; (define-key eshell-term-raw-map [delete] 'eshell-term-send-del)
332 ; (define-key eshell-term-raw-map [backspace] 'eshell-term-send-backspace)
333 ; (define-key eshell-term-raw-map [home] 'eshell-term-send-home)
334 ; (define-key eshell-term-raw-map [end] 'eshell-term-send-end)
335 ; (define-key eshell-term-raw-map [prior] 'eshell-term-send-prior)
336 ; (define-key eshell-term-raw-map [next] 'eshell-term-send-next)
337 ; (eshell-term-set-escape-char ?\C-c))))
339 ; (defun eshell-term-line-mode ()
340 ; "Switch to line (\"cooked\") sub-mode of eshell-term mode."
341 ; (use-local-map term-old-mode-map))
346 ;; generated-autoload-file: "esh-groups.el"
349 ;;; em-term.el ends here