Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; em-term.el --- running visual commands |
affbf647 | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1999-2013 Free Software Foundation, Inc. |
affbf647 | 4 | |
7de5b421 GM |
5 | ;; Author: John Wiegley <johnw@gnu.org> |
6 | ||
affbf647 GM |
7 | ;; This file is part of GNU Emacs. |
8 | ||
4ee57b2a | 9 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
affbf647 | 10 | ;; it under the terms of the GNU General Public License as published by |
4ee57b2a GM |
11 | ;; the Free Software Foundation, either version 3 of the License, or |
12 | ;; (at your option) any later version. | |
affbf647 GM |
13 | |
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. | |
18 | ||
19 | ;; You should have received a copy of the GNU General Public License | |
4ee57b2a | 20 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
affbf647 | 21 | |
affbf647 GM |
22 | ;;; Commentary: |
23 | ||
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 | |
e1dbe924 | 27 | ;; as "visual" programs. In order to run these programs under Emacs, |
affbf647 GM |
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. | |
31 | ||
dbba8a04 GM |
32 | ;;; Code: |
33 | ||
068922a2 | 34 | (require 'cl-lib) |
f87b1284 GM |
35 | (require 'esh-util) |
36 | (require 'esh-ext) | |
dbba8a04 | 37 | (eval-when-compile (require 'eshell)) |
affbf647 GM |
38 | (require 'term) |
39 | ||
3146b070 | 40 | ;;;###autoload |
35ff222c GM |
41 | (progn |
42 | (defgroup eshell-term nil | |
dbba8a04 GM |
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" | |
35ff222c | 49 | :group 'eshell-module)) |
dbba8a04 | 50 | |
affbf647 GM |
51 | ;;; User Variables: |
52 | ||
d783d303 | 53 | (defcustom eshell-term-load-hook nil |
ec60da52 | 54 | "A list of functions to call when loading `eshell-term'." |
d783d303 | 55 | :version "24.1" ; removed eshell-term-initialize |
affbf647 GM |
56 | :type 'hook |
57 | :group 'eshell-term) | |
58 | ||
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!! | |
ec60da52 | 65 | "A list of commands that present their output in a visual fashion." |
affbf647 GM |
66 | :type '(repeat string) |
67 | :group 'eshell-term) | |
68 | ||
d105b0e2 TH |
69 | (defcustom eshell-visual-subcommands |
70 | nil | |
71 | "An alist of the form | |
72 | ||
73 | ((COMMAND1 SUBCOMMAND1 SUBCOMMAND2...) | |
74 | (COMMAND2 SUBCOMMAND1 ...)) | |
75 | ||
76 | of commands with subcommands that present their output in a | |
77 | visual fashion. A likely entry is | |
78 | ||
79 | (\"git\" \"log\" \"diff\" \"show\") | |
80 | ||
81 | because git shows logs and diffs using a pager by default." | |
82 | :type '(repeat (cons (string :tag "Command") | |
a2d98946 GM |
83 | (repeat (string :tag "Subcommand")))) |
84 | :version "24.4" | |
85 | :group 'eshell-term) | |
d105b0e2 TH |
86 | |
87 | (defcustom eshell-visual-options | |
88 | nil | |
89 | "An alist of the form | |
90 | ||
91 | ((COMMAND1 OPTION1 OPTION2...) | |
92 | (COMMAND2 OPTION1 ...)) | |
93 | ||
94 | of commands with options that present their output in a visual | |
95 | fashion. For example, a sensible entry would be | |
96 | ||
97 | (\"git\" \"--help\") | |
98 | ||
99 | because \"git <command> --help\" shows the command's | |
100 | documentation with a pager." | |
101 | :type '(repeat (cons (string :tag "Command") | |
a2d98946 GM |
102 | (repeat (string :tag "Option")))) |
103 | :version "24.4" | |
104 | :group 'eshell-term) | |
d105b0e2 | 105 | |
cca96c97 GM |
106 | ;; If you change this from term-term-name, you need to ensure that the |
107 | ;; value you choose exists in the system's terminfo database. (Bug#12485) | |
108 | (defcustom eshell-term-name term-term-name | |
ec60da52 | 109 | "Name to use for the TERM variable when running visual commands. |
affbf647 GM |
110 | See `term-term-name' in term.el for more information on how this is |
111 | used." | |
cca96c97 | 112 | :version "24.3" ; eterm -> term-term-name = eterm-color |
affbf647 GM |
113 | :type 'string |
114 | :group 'eshell-term) | |
115 | ||
116 | (defcustom eshell-escape-control-x t | |
ec60da52 | 117 | "If non-nil, allow <C-x> to be handled by Emacs key in visual buffers. |
d105b0e2 TH |
118 | See the variables `eshell-visual-commands', |
119 | `eshell-visual-subcommands', and `eshell-visual-options'. If | |
120 | this variable is set to nil, <C-x> will send that control | |
121 | character to the invoked process." | |
affbf647 GM |
122 | :type 'boolean |
123 | :group 'eshell-term) | |
124 | ||
125 | ;;; Internal Variables: | |
126 | ||
127 | (defvar eshell-parent-buffer) | |
128 | ||
129 | ;;; Functions: | |
130 | ||
131 | (defun eshell-term-initialize () | |
132 | "Initialize the `term' interface code." | |
133 | (make-local-variable 'eshell-interpreter-alist) | |
134 | (setq eshell-interpreter-alist | |
135 | (cons (cons (function | |
d105b0e2 TH |
136 | (lambda (command args) |
137 | (let ((command (file-name-nondirectory command))) | |
138 | (or (member command eshell-visual-commands) | |
139 | (member (car args) | |
140 | (cdr (assoc command eshell-visual-subcommands))) | |
26b3353a TH |
141 | (cl-intersection args |
142 | (cdr (assoc command eshell-visual-options)) | |
143 | :test 'string=))))) | |
affbf647 GM |
144 | 'eshell-exec-visual) |
145 | eshell-interpreter-alist))) | |
146 | ||
147 | (defun eshell-exec-visual (&rest args) | |
148 | "Run the specified PROGRAM in a terminal emulation buffer. | |
149 | ARGS are passed to the program. At the moment, no piping of input is | |
150 | allowed." | |
151 | (let* (eshell-interpreter-alist | |
d105b0e2 | 152 | (interp (eshell-find-interpreter (car args) (cdr args))) |
affbf647 GM |
153 | (program (car interp)) |
154 | (args (eshell-flatten-list | |
155 | (eshell-stringify-list (append (cdr interp) | |
156 | (cdr args))))) | |
157 | (term-buf | |
158 | (generate-new-buffer | |
159 | (concat "*" (file-name-nondirectory program) "*"))) | |
160 | (eshell-buf (current-buffer))) | |
161 | (save-current-buffer | |
162 | (switch-to-buffer term-buf) | |
163 | (term-mode) | |
164 | (set (make-local-variable 'term-term-name) eshell-term-name) | |
165 | (make-local-variable 'eshell-parent-buffer) | |
166 | (setq eshell-parent-buffer eshell-buf) | |
167 | (term-exec term-buf program program nil args) | |
168 | (let ((proc (get-buffer-process term-buf))) | |
169 | (if (and proc (eq 'run (process-status proc))) | |
170 | (set-process-sentinel proc 'eshell-term-sentinel) | |
171 | (error "Failed to invoke visual command"))) | |
172 | (term-char-mode) | |
173 | (if eshell-escape-control-x | |
174 | (term-set-escape-char ?\C-x)))) | |
175 | nil) | |
176 | ||
177 | (defun eshell-term-sentinel (proc string) | |
178 | "Destroy the buffer visiting PROC." | |
179 | (let ((proc-buf (process-buffer proc))) | |
180 | (when (and proc-buf (buffer-live-p proc-buf) | |
181 | (not (eq 'run (process-status proc))) | |
182 | (= (process-exit-status proc) 0)) | |
183 | (if (eq (current-buffer) proc-buf) | |
184 | (let ((buf (and (boundp 'eshell-parent-buffer) | |
185 | eshell-parent-buffer | |
186 | (buffer-live-p eshell-parent-buffer) | |
187 | eshell-parent-buffer))) | |
188 | (if buf | |
189 | (switch-to-buffer buf)))) | |
190 | (kill-buffer proc-buf)))) | |
191 | ||
192 | ;; jww (1999-09-17): The code below will allow Eshell to send input | |
193 | ;; characters directly to the currently running interactive process. | |
194 | ;; However, since this would introduce other problems that would need | |
195 | ;; solutions, I'm going to let it wait until after 2.1. | |
196 | ||
197 | ; (defvar eshell-term-raw-map nil | |
198 | ; "Keyboard map for sending characters directly to the inferior process.") | |
199 | ; (defvar eshell-term-escape-char nil | |
200 | ; "Escape character for char-sub-mode of term mode. | |
201 | ; Do not change it directly; use term-set-escape-char instead.") | |
202 | ; (defvar eshell-term-raw-escape-map nil) | |
203 | ||
204 | ; (defun eshell-term-send-raw-string (chars) | |
205 | ; (goto-char eshell-last-output-end) | |
206 | ; (process-send-string (eshell-interactive-process) chars)) | |
207 | ||
208 | ; (defun eshell-term-send-raw () | |
209 | ; "Send the last character typed through the terminal-emulator | |
210 | ; without any interpretation." | |
211 | ; (interactive) | |
212 | ; ;; Convert `return' to C-m, etc. | |
cfa29281 GM |
213 | ; (if (and (symbolp last-input-event) |
214 | ; (get last-input-event 'ascii-character)) | |
215 | ; (setq last-input-event (get last-input-event 'ascii-character))) | |
216 | ; (eshell-term-send-raw-string (make-string 1 last-input-event))) | |
affbf647 GM |
217 | |
218 | ; (defun eshell-term-send-raw-meta () | |
219 | ; (interactive) | |
cfa29281 | 220 | ; (if (symbolp last-input-event) |
affbf647 | 221 | ; ;; Convert `return' to C-m, etc. |
cfa29281 | 222 | ; (let ((tmp (get last-input-event 'event-symbol-elements))) |
affbf647 | 223 | ; (if tmp |
cfa29281 GM |
224 | ; (setq last-input-event (car tmp))) |
225 | ; (if (symbolp last-input-event) | |
affbf647 | 226 | ; (progn |
cfa29281 GM |
227 | ; (setq tmp (get last-input-event 'ascii-character)) |
228 | ; (if tmp (setq last-input-event tmp)))))) | |
229 | ; (eshell-term-send-raw-string (if (and (numberp last-input-event) | |
230 | ; (> last-input-event 127) | |
231 | ; (< last-input-event 256)) | |
232 | ; (make-string 1 last-input-event) | |
233 | ; (format "\e%c" last-input-event)))) | |
affbf647 GM |
234 | |
235 | ; (defun eshell-term-mouse-paste (click arg) | |
236 | ; "Insert the last stretch of killed text at the position clicked on." | |
237 | ; (interactive "e\nP") | |
238 | ; (if (boundp 'xemacs-logo) | |
239 | ; (eshell-term-send-raw-string | |
240 | ; (or (condition-case () (x-get-selection) (error ())) | |
45240125 | 241 | ; (error "No selection available"))) |
affbf647 GM |
242 | ; ;; Give temporary modes such as isearch a chance to turn off. |
243 | ; (run-hooks 'mouse-leave-buffer-hook) | |
244 | ; (setq this-command 'yank) | |
245 | ; (eshell-term-send-raw-string | |
246 | ; (current-kill (cond ((listp arg) 0) | |
247 | ; ((eq arg '-) -1) | |
248 | ; (t (1- arg))))))) | |
249 | ||
250 | ; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either. | |
251 | ; ;; For my configuration it's definitely better \eOA but YMMV. -mm | |
252 | ; ;; For example: vi works with \eOA while elm wants \e[A ... | |
253 | ; (defun eshell-term-send-up () (interactive) (eshell-term-send-raw-string "\eOA")) | |
254 | ; (defun eshell-term-send-down () (interactive) (eshell-term-send-raw-string "\eOB")) | |
255 | ; (defun eshell-term-send-right () (interactive) (eshell-term-send-raw-string "\eOC")) | |
256 | ; (defun eshell-term-send-left () (interactive) (eshell-term-send-raw-string "\eOD")) | |
257 | ; (defun eshell-term-send-home () (interactive) (eshell-term-send-raw-string "\e[1~")) | |
258 | ; (defun eshell-term-send-end () (interactive) (eshell-term-send-raw-string "\e[4~")) | |
259 | ; (defun eshell-term-send-prior () (interactive) (eshell-term-send-raw-string "\e[5~")) | |
260 | ; (defun eshell-term-send-next () (interactive) (eshell-term-send-raw-string "\e[6~")) | |
261 | ; (defun eshell-term-send-del () (interactive) (eshell-term-send-raw-string "\C-?")) | |
262 | ; (defun eshell-term-send-backspace () (interactive) (eshell-term-send-raw-string "\C-H")) | |
263 | ||
264 | ; (defun eshell-term-set-escape-char (c) | |
265 | ; "Change term-escape-char and keymaps that depend on it." | |
266 | ; (if eshell-term-escape-char | |
267 | ; (define-key eshell-term-raw-map eshell-term-escape-char 'eshell-term-send-raw)) | |
268 | ; (setq c (make-string 1 c)) | |
269 | ; (define-key eshell-term-raw-map c eshell-term-raw-escape-map) | |
270 | ; ;; Define standard bindings in eshell-term-raw-escape-map | |
271 | ; (define-key eshell-term-raw-escape-map "\C-x" | |
272 | ; (lookup-key (current-global-map) "\C-x")) | |
273 | ; (define-key eshell-term-raw-escape-map "\C-v" | |
274 | ; (lookup-key (current-global-map) "\C-v")) | |
275 | ; (define-key eshell-term-raw-escape-map "\C-u" | |
276 | ; (lookup-key (current-global-map) "\C-u")) | |
277 | ; (define-key eshell-term-raw-escape-map c 'eshell-term-send-raw)) | |
278 | ||
279 | ; (defun eshell-term-char-mode () | |
280 | ; "Switch to char (\"raw\") sub-mode of term mode. | |
281 | ; Each character you type is sent directly to the inferior without | |
282 | ; intervention from Emacs, except for the escape character (usually C-c)." | |
283 | ; (interactive) | |
284 | ; (if (not eshell-term-raw-map) | |
285 | ; (let* ((map (make-keymap)) | |
286 | ; (esc-map (make-keymap)) | |
287 | ; (i 0)) | |
288 | ; (while (< i 128) | |
289 | ; (define-key map (make-string 1 i) 'eshell-term-send-raw) | |
290 | ; (define-key esc-map (make-string 1 i) 'eshell-term-send-raw-meta) | |
291 | ; (setq i (1+ i))) | |
292 | ; (define-key map "\e" esc-map) | |
293 | ; (setq eshell-term-raw-map map) | |
294 | ; (setq eshell-term-raw-escape-map | |
295 | ; (copy-keymap (lookup-key (current-global-map) "\C-x"))) | |
296 | ; (if (boundp 'xemacs-logo) | |
297 | ; (define-key eshell-term-raw-map [button2] 'eshell-term-mouse-paste) | |
298 | ; (define-key eshell-term-raw-map [mouse-2] 'eshell-term-mouse-paste)) | |
299 | ; (define-key eshell-term-raw-map [up] 'eshell-term-send-up) | |
300 | ; (define-key eshell-term-raw-map [down] 'eshell-term-send-down) | |
301 | ; (define-key eshell-term-raw-map [right] 'eshell-term-send-right) | |
302 | ; (define-key eshell-term-raw-map [left] 'eshell-term-send-left) | |
303 | ; (define-key eshell-term-raw-map [delete] 'eshell-term-send-del) | |
304 | ; (define-key eshell-term-raw-map [backspace] 'eshell-term-send-backspace) | |
305 | ; (define-key eshell-term-raw-map [home] 'eshell-term-send-home) | |
306 | ; (define-key eshell-term-raw-map [end] 'eshell-term-send-end) | |
307 | ; (define-key eshell-term-raw-map [prior] 'eshell-term-send-prior) | |
308 | ; (define-key eshell-term-raw-map [next] 'eshell-term-send-next) | |
309 | ; (eshell-term-set-escape-char ?\C-c)))) | |
310 | ||
311 | ; (defun eshell-term-line-mode () | |
312 | ; "Switch to line (\"cooked\") sub-mode of eshell-term mode." | |
313 | ; (use-local-map term-old-mode-map)) | |
314 | ||
dbba8a04 | 315 | (provide 'em-term) |
affbf647 | 316 | |
3146b070 GM |
317 | ;; Local Variables: |
318 | ;; generated-autoload-file: "esh-groups.el" | |
319 | ;; End: | |
320 | ||
affbf647 | 321 | ;;; em-term.el ends here |