* lisp/eshell/esh-cmd.el (eshell-post-rewrite-command-function): New var.
[bpt/emacs.git] / lisp / eshell / esh-cmd.el
CommitLineData
ae5e4c48 1;;; esh-cmd.el --- command invocation -*- lexical-binding:t -*-
25fffb31 2
ab422c4d 3;; Copyright (C) 1999-2013 Free Software Foundation, Inc.
25fffb31 4
7de5b421
GM
5;; Author: John Wiegley <johnw@gnu.org>
6
25fffb31
GM
7;; This file is part of GNU Emacs.
8
4ee57b2a 9;; GNU Emacs is free software: you can redistribute it and/or modify
25fffb31 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.
25fffb31
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/>.
25fffb31 21
25fffb31
GM
22;;; Commentary:
23
24;;;_* Invoking external commands
25;;
26;; External commands cause processes to be created, by loading
27;; external executables into memory. This is what most normal shells
28;; do, most of the time. For more information, see [External commands].
29;;
30;;;_* Invoking Lisp functions
31;;
32;; A Lisp function can be invoked using Lisp syntax, or command shell
33;; syntax. For example, to run `dired' to edit the current directory:
34;;
35;; /tmp $ (dired ".")
36;;
37;; Or:
38;;
39;; /tmp $ dired .
40;;
41;; The latter form is preferable, but the former is more precise,
42;; since it involves no translations. See [Argument parsing], to
43;; learn more about how arguments are transformed before passing them
44;; to commands.
45;;
46;; Ordinarily, if 'dired' were also available as an external command,
47;; the external version would be called in preference to any Lisp
48;; function of the same name. To change this behavior so that Lisp
49;; functions always take precedence, set
50;; `eshell-prefer-lisp-functions' to t.
51
25fffb31
GM
52;;;_* Alias functions
53;;
54;; Whenever a command is specified using a simple name, such as 'ls',
55;; Eshell will first look for a Lisp function of the name `eshell/ls'.
56;; If it exists, it will be called in preference to any other command
57;; which might have matched the name 'ls' (such as command aliases,
58;; external commands, Lisp functions of that name, etc).
59;;
60;; This is the most flexible mechanism for creating new commands,
61;; since it does not pollute the global namespace, yet allows you to
62;; use all of Lisp's facilities to define that piece of functionality.
63;; Most of Eshell's "builtin" commands are defined as alias functions.
64;;
65;;;_* Lisp arguments
66;;
67;; It is possible to invoke a Lisp form as an argument. This can be
68;; done either by specifying the form as you might in Lisp, or by
69;; using the '$' character to introduce a value-interpolation:
70;;
71;; echo (+ 1 2)
72;;
73;; Or
74;;
75;; echo $(+ 1 2)
76;;
77;; The two forms are equivalent. The second is required only if the
78;; form being interpolated is within a string, or is a subexpression
79;; of a larger argument:
80;;
81;; echo x$(+ 1 2) "String $(+ 1 2)"
82;;
83;; To pass a Lisp symbol as a argument, use the alternate quoting
84;; syntax, since the single quote character is far too overused in
85;; shell syntax:
86;;
87;; echo #'lisp-symbol
88;;
89;; Backquote can also be used:
90;;
91;; echo `(list ,lisp-symbol)
92;;
93;; Lisp arguments are identified using the following regexp:
94
56590d2f
GM
95;;;_* Command hooks
96;;
97;; There are several hooks involved with command execution, which can
98;; be used either to change or augment Eshell's behavior.
99
100
101;;; Code:
102
103(require 'esh-util)
104(unless (featurep 'xemacs)
105 (require 'eldoc))
106(require 'esh-arg)
107(require 'esh-proc)
108(require 'esh-ext)
109
110(eval-when-compile
a464a6c7 111 (require 'cl-lib)
56590d2f
GM
112 (require 'pcomplete))
113
114
115(defgroup eshell-cmd nil
116 "Executing an Eshell command is as simple as typing it in and
117pressing <RET>. There are several different kinds of commands,
118however."
119 :tag "Command invocation"
120 ;; :link '(info-link "(eshell)Command invocation")
121 :group 'eshell)
122
123(defcustom eshell-prefer-lisp-functions nil
ec60da52 124 "If non-nil, prefer Lisp functions to external commands."
56590d2f
GM
125 :type 'boolean
126 :group 'eshell-cmd)
127
25fffb31 128(defcustom eshell-lisp-regexp "\\([(`]\\|#'\\)"
ec60da52 129 "A regexp which, if matched at beginning of an argument, means Lisp.
25fffb31
GM
130Such arguments will be passed to `read', and then evaluated."
131 :type 'regexp
132 :group 'eshell-cmd)
133
25fffb31 134(defcustom eshell-pre-command-hook nil
ec60da52 135 "A hook run before each interactive command is invoked."
25fffb31
GM
136 :type 'hook
137 :group 'eshell-cmd)
138
139(defcustom eshell-post-command-hook nil
ec60da52 140 "A hook run after each interactive command is invoked."
25fffb31
GM
141 :type 'hook
142 :group 'eshell-cmd)
143
144(defcustom eshell-prepare-command-hook nil
ec60da52 145 "A set of functions called to prepare a named command.
25fffb31
GM
146The command name and its argument are in `eshell-last-command-name'
147and `eshell-last-arguments'. The functions on this hook can change
148the value of these symbols if necessary.
149
150To prevent a command from executing at all, set
151`eshell-last-command-name' to nil."
152 :type 'hook
153 :group 'eshell-cmd)
154
155(defcustom eshell-named-command-hook nil
ec60da52 156 "A set of functions called before a named command is invoked.
25fffb31
GM
157Each function will be passed the command name and arguments that were
158passed to `eshell-named-command'.
159
160If any of the functions returns a non-nil value, the named command
161will not be invoked, and that value will be returned from
162`eshell-named-command'.
163
164In order to substitute an alternate command form for execution, the
165hook function should throw it using the tag `eshell-replace-command'.
166For example:
167
168 (add-hook 'eshell-named-command-hook 'subst-with-cd)
169 (defun subst-with-cd (command args)
170 (throw 'eshell-replace-command
171 (eshell-parse-command \"cd\" args)))
172
173Although useless, the above code will cause any non-glob, non-Lisp
174command (i.e., 'ls' as opposed to '*ls' or '(ls)') to be replaced by a
175call to `cd' using the arguments that were passed to the function."
176 :type 'hook
177 :group 'eshell-cmd)
178
179(defcustom eshell-pre-rewrite-command-hook
180 '(eshell-no-command-conversion
181 eshell-subcommand-arg-values)
ec60da52 182 "A hook run before command rewriting begins.
25fffb31
GM
183The terms of the command to be rewritten is passed as arguments, and
184may be modified in place. Any return value is ignored."
185 :type 'hook
186 :group 'eshell-cmd)
187
188(defcustom eshell-rewrite-command-hook
189 '(eshell-rewrite-for-command
190 eshell-rewrite-while-command
191 eshell-rewrite-if-command
192 eshell-rewrite-sexp-command
193 eshell-rewrite-initial-subcommand
194 eshell-rewrite-named-command)
ec60da52 195 "A set of functions used to rewrite the command argument.
25fffb31
GM
196Once parsing of a command line is completed, the next step is to
197rewrite the initial argument into something runnable.
198
199A module may wish to associate special behavior with certain argument
200syntaxes at the beginning of a command line. They are welcome to do
201so by adding a function to this hook. The first function to return a
202substitute command form is the one used. Each function is passed the
203command's full argument list, which is a list of sexps (typically
204forms or strings)."
205 :type 'hook
206 :group 'eshell-cmd)
207
e8b66a6a
SM
208(defvar eshell-post-rewrite-command-function #'identity
209 "Function run after command rewriting is finished.
210Takes the (rewritten) command, modifies it as it sees fit and returns
211the new result to use instead.")
212(defvar eshell-post-rewrite-command-hook nil
ec60da52 213 "A hook run after command rewriting is finished.
25fffb31 214Each function is passed the symbol containing the rewritten command,
e8b66a6a
SM
215which may be modified directly. Any return value is ignored.")
216(make-obsolete-variable 'eshell-post-rewrite-command-hook
217 'eshell-post-rewrite-command-function "24.4")
25fffb31 218
820b9143 219(defcustom eshell-complex-commands '("ls")
ec60da52 220 "A list of commands names or functions, that determine complexity.
dace60cf
JW
221That is, if a command is defined by a function named eshell/NAME,
222and NAME is part of this list, it is invoked as a complex command.
223Complex commands are always correct, but run much slower. If a
224command works fine without being part of this list, then it doesn't
225need to be.
226
227If an entry is a function, it will be called with the name, and should
228return non-nil if the command is complex."
229 :type '(repeat :tag "Commands"
230 (choice (string :tag "Name")
231 (function :tag "Predicate")))
232 :group 'eshell-cmd)
233
25fffb31
GM
234;;; User Variables:
235
d783d303 236(defcustom eshell-cmd-load-hook nil
ec60da52 237 "A hook that gets run when `eshell-cmd' is loaded."
d783d303 238 :version "24.1" ; removed eshell-cmd-initialize
25fffb31
GM
239 :type 'hook
240 :group 'eshell-cmd)
241
242(defcustom eshell-debug-command nil
beb83b5a
GM
243 "If non-nil, enable Eshell debugging code.
244This is slow, and only useful for debugging problems with Eshell.
245If you change this without using customize after Eshell has loaded,
aac7ba08 246you must re-load 'esh-cmd.el'."
beb83b5a
GM
247 :initialize 'custom-initialize-default
248 :set (lambda (symbol value)
b499d8d0 249 (set symbol value)
beb83b5a 250 (load-library "esh-cmd"))
25fffb31
GM
251 :type 'boolean
252 :group 'eshell-cmd)
253
254(defcustom eshell-deferrable-commands
255 '(eshell-named-command
256 eshell-lisp-command
257 eshell-process-identity)
91af3942 258 "A list of functions which might return an asynchronous process.
25fffb31
GM
259If they return a process object, execution of the calling Eshell
260command will wait for completion (in the background) before finishing
261the command."
262 :type '(repeat function)
263 :group 'eshell-cmd)
264
265(defcustom eshell-subcommand-bindings
266 '((eshell-in-subcommand-p t)
267 (default-directory default-directory)
268 (process-environment (eshell-copy-environment)))
ec60da52 269 "A list of `let' bindings for subcommand environments."
25fffb31
GM
270 :type 'sexp
271 :group 'eshell-cmd)
272
273(put 'risky-local-variable 'eshell-subcommand-bindings t)
274
275(defvar eshell-ensure-newline-p nil
276 "If non-nil, ensure that a newline is emitted after a Lisp form.
277This can be changed by Lisp forms that are evaluated from the Eshell
278command line.")
279
280;;; Internal Variables:
281
282(defvar eshell-current-command nil)
283(defvar eshell-command-name nil)
284(defvar eshell-command-arguments nil)
5101a9dc
GM
285(defvar eshell-in-pipeline-p nil
286 "Internal Eshell variable, non-nil inside a pipeline.
287Has the value 'first, 'last for the first/last commands in the pipeline,
288otherwise t.")
25fffb31
GM
289(defvar eshell-in-subcommand-p nil)
290(defvar eshell-last-arguments nil)
291(defvar eshell-last-command-name nil)
292(defvar eshell-last-async-proc nil
293 "When this foreground process completes, resume command evaluation.")
294
295;;; Functions:
296
297(defsubst eshell-interactive-process ()
298 "Return currently running command process, if non-Lisp."
299 eshell-last-async-proc)
300
301(defun eshell-cmd-initialize ()
302 "Initialize the Eshell command processing module."
303 (set (make-local-variable 'eshell-current-command) nil)
304 (set (make-local-variable 'eshell-command-name) nil)
305 (set (make-local-variable 'eshell-command-arguments) nil)
306 (set (make-local-variable 'eshell-last-arguments) nil)
307 (set (make-local-variable 'eshell-last-command-name) nil)
308 (set (make-local-variable 'eshell-last-async-proc) nil)
309
25fffb31
GM
310 (add-hook 'eshell-kill-hook 'eshell-resume-command nil t)
311
312 ;; make sure that if a command is over, and no process is being
313 ;; waited for, that `eshell-current-command' is set to nil. This
314 ;; situation can occur, for example, if a Lisp function results in
315 ;; `debug' being called, and the user then types \\[top-level]
25fffb31
GM
316 (add-hook 'eshell-post-command-hook
317 (function
318 (lambda ()
319 (setq eshell-current-command nil
320 eshell-last-async-proc nil))) nil t)
321
25fffb31
GM
322 (add-hook 'eshell-parse-argument-hook
323 'eshell-parse-subcommand-argument nil t)
324 (add-hook 'eshell-parse-argument-hook
325 'eshell-parse-lisp-argument nil t)
326
327 (when (eshell-using-module 'eshell-cmpl)
25fffb31
GM
328 (add-hook 'pcomplete-try-first-hook
329 'eshell-complete-lisp-symbols nil t)))
330
25fffb31
GM
331(defun eshell-complete-lisp-symbols ()
332 "If there is a user reference, complete it."
333 (let ((arg (pcomplete-actual-arg)))
334 (when (string-match (concat "\\`" eshell-lisp-regexp) arg)
335 (setq pcomplete-stub (substring arg (match-end 0))
336 pcomplete-last-completion-raw t)
337 (throw 'pcomplete-completions
338 (all-completions pcomplete-stub obarray 'boundp)))))
339
340;; Command parsing
341
e8b66a6a 342(defun eshell-parse-command (command &optional args toplevel)
25fffb31
GM
343 "Parse the COMMAND, adding ARGS if given.
344COMMAND can either be a string, or a cons cell demarcating a buffer
e8b66a6a 345region. TOPLEVEL, if non-nil, means that the outermost command (the
25fffb31
GM
346user's input command) is being parsed, and that pre and post command
347hooks should be run before and after the command."
348 (let* (sep-terms
349 (terms
350 (append
351 (if (consp command)
352 (eshell-parse-arguments (car command) (cdr command))
353 (let ((here (point))
6e13206c
SM
354 (inhibit-point-motion-hooks t))
355 (with-silent-modifications
356 ;; FIXME: Why not use a temporary buffer and avoid this
357 ;; "insert&delete" business? --Stef
358 (insert command)
359 (prog1
360 (eshell-parse-arguments here (point))
361 (delete-region here (point))))))
25fffb31
GM
362 args))
363 (commands
364 (mapcar
365 (function
366 (lambda (cmd)
1bc4c3ae
SM
367 (setq cmd
368 (if (or (not (car sep-terms))
369 (string= (car sep-terms) ";"))
e8b66a6a 370 (eshell-parse-pipeline cmd)
1bc4c3ae
SM
371 `(eshell-do-subjob
372 (list ,(eshell-parse-pipeline cmd)))))
25fffb31
GM
373 (setq sep-terms (cdr sep-terms))
374 (if eshell-in-pipeline-p
375 cmd
1bc4c3ae 376 `(eshell-trap-errors ,cmd))))
25fffb31
GM
377 (eshell-separate-commands terms "[&;]" nil 'sep-terms))))
378 (let ((cmd commands))
379 (while cmd
380 (if (cdr cmd)
1bc4c3ae 381 (setcar cmd `(eshell-commands ,(car cmd))))
25fffb31 382 (setq cmd (cdr cmd))))
e8b66a6a
SM
383 (if toplevel
384 `(eshell-commands (progn
385 (run-hooks 'eshell-pre-command-hook)
386 (catch 'top-level (progn ,@commands))
387 (run-hooks 'eshell-post-command-hook)))
388 (macroexp-progn commands))))
25fffb31 389
56590d2f
GM
390(defun eshell-debug-command (tag subform)
391 "Output a debugging message to '*eshell last cmd*'."
392 (let ((buf (get-buffer-create "*eshell last cmd*"))
393 (text (eshell-stringify eshell-current-command)))
ee5b7365 394 (with-current-buffer buf
56590d2f
GM
395 (if (not tag)
396 (erase-buffer)
397 (insert "\n\C-l\n" tag "\n\n" text
398 (if subform
399 (concat "\n\n" (eshell-stringify subform)) ""))))))
400
25fffb31
GM
401(defun eshell-debug-show-parsed-args (terms)
402 "Display parsed arguments in the debug buffer."
403 (ignore
404 (if eshell-debug-command
405 (eshell-debug-command "parsed arguments" terms))))
406
407(defun eshell-no-command-conversion (terms)
408 "Don't convert the command argument."
409 (ignore
410 (if (and (listp (car terms))
411 (eq (caar terms) 'eshell-convert))
412 (setcar terms (cadr (car terms))))))
413
414(defun eshell-subcommand-arg-values (terms)
415 "Convert subcommand arguments {x} to ${x}, in order to take their values."
416 (setq terms (cdr terms)) ; skip command argument
417 (while terms
418 (if (and (listp (car terms))
419 (eq (caar terms) 'eshell-as-subcommand))
1bc4c3ae
SM
420 (setcar terms `(eshell-convert
421 (eshell-command-to-value ,(car terms)))))
25fffb31
GM
422 (setq terms (cdr terms))))
423
424(defun eshell-rewrite-sexp-command (terms)
425 "Rewrite a sexp in initial position, such as '(+ 1 2)'."
426 ;; this occurs when a Lisp expression is in first position
427 (if (and (listp (car terms))
428 (eq (caar terms) 'eshell-command-to-value))
429 (car (cdar terms))))
430
25fffb31
GM
431(defun eshell-rewrite-initial-subcommand (terms)
432 "Rewrite a subcommand in initial position, such as '{+ 1 2}'."
433 (if (and (listp (car terms))
434 (eq (caar terms) 'eshell-as-subcommand))
435 (car terms)))
436
25fffb31
GM
437(defun eshell-rewrite-named-command (terms)
438 "If no other rewriting rule transforms TERMS, assume a named command."
f4dd1361
JW
439 (let ((sym (if eshell-in-pipeline-p
440 'eshell-named-command*
441 'eshell-named-command))
442 (cmd (car terms))
443 (args (cdr terms)))
444 (if args
1bc4c3ae 445 (list sym cmd `(list ,@(cdr terms)))
f4dd1361 446 (list sym cmd))))
25fffb31 447
1a32899d
GM
448(defvar eshell-command-body)
449(defvar eshell-test-body)
25fffb31
GM
450
451(defsubst eshell-invokify-arg (arg &optional share-output silent)
452 "Change ARG so it can be invoked from a structured command.
453
454SHARE-OUTPUT, if non-nil, means this invocation should share the
455current output stream, which is separately redirectable. SILENT
456means the user and/or any redirections shouldn't see any output
457from this command. If both SHARE-OUTPUT and SILENT are non-nil,
458the second is ignored."
459 ;; something that begins with `eshell-convert' means that it
460 ;; intends to return a Lisp value. We want to get past this,
461 ;; but if it's not _actually_ a value interpolation -- in which
462 ;; we leave it alone. In fact, the only time we muck with it
463 ;; is in the case of a {subcommand} that has been turned into
464 ;; the interpolation, ${subcommand}, by the parser because it
465 ;; didn't know better.
466 (if (and (listp arg)
467 (eq (car arg) 'eshell-convert)
468 (eq (car (cadr arg)) 'eshell-command-to-value))
469 (if share-output
470 (cadr (cadr arg))
1bc4c3ae 471 `(eshell-commands ,(cadr (cadr arg)) ,silent))
25fffb31
GM
472 arg))
473
1bc4c3ae 474(defvar eshell-last-command-status) ;Define in esh-io.el.
1e53bb4b
GM
475(defvar eshell--local-vars nil
476 "List of locally bound vars that should take precedence over env-vars.")
1bc4c3ae 477
25fffb31
GM
478(defun eshell-rewrite-for-command (terms)
479 "Rewrite a `for' command into its equivalent Eshell command form.
480Because the implementation of `for' relies upon conditional evaluation
31096fe8 481of its argument (i.e., use of a Lisp special form), it must be
25fffb31 482implemented via rewriting, rather than as a function."
1bc4c3ae
SM
483 (if (and (equal (car terms) "for")
484 (equal (nth 2 terms) "in"))
25fffb31
GM
485 (let ((body (car (last terms))))
486 (setcdr (last terms 2) nil)
1bc4c3ae 487 `(let ((for-items
045ef729
CY
488 (copy-tree
489 (append
490 ,@(mapcar
491 (lambda (elem)
492 (if (listp elem)
493 elem
494 `(list ,elem)))
495 (cdr (cddr terms))))))
496 (eshell-command-body '(nil))
1bc4c3ae 497 (eshell-test-body '(nil)))
045ef729 498 (while (car for-items)
1e53bb4b
GM
499 (let ((,(intern (cadr terms)) (car for-items))
500 (eshell--local-vars (cons ',(intern (cadr terms))
501 eshell--local-vars)))
045ef729
CY
502 (eshell-protect
503 ,(eshell-invokify-arg body t)))
504 (setcar for-items (cadr for-items))
505 (setcdr for-items (cddr for-items)))
1bc4c3ae
SM
506 (eshell-close-handles
507 eshell-last-command-status
508 (list 'quote eshell-last-command-result))))))
25fffb31
GM
509
510(defun eshell-structure-basic-command (func names keyword test body
e8b66a6a 511 &optional else)
25fffb31
GM
512 "With TERMS, KEYWORD, and two NAMES, structure a basic command.
513The first of NAMES should be the positive form, and the second the
514negative. It's not likely that users should ever need to call this
e8b66a6a 515function."
25fffb31
GM
516 ;; If the test form begins with `eshell-convert', it means
517 ;; something data-wise will be returned, and we should let
518 ;; that determine the truth of the statement.
519 (unless (eq (car test) 'eshell-convert)
520 (setq test
1bc4c3ae
SM
521 `(progn ,test
522 (eshell-exit-success-p))))
25fffb31
GM
523
524 ;; should we reverse the sense of the test? This depends
525 ;; on the `names' parameter. If it's the symbol nil, yes.
526 ;; Otherwise, it can be a pair of strings; if the keyword
527 ;; we're using matches the second member of that pair (a
528 ;; list), we should reverse it.
529 (if (or (eq names nil)
530 (and (listp names)
531 (string= keyword (cadr names))))
1bc4c3ae 532 (setq test `(not ,test)))
25fffb31
GM
533
534 ;; finally, create the form that represents this structured
535 ;; command
1bc4c3ae
SM
536 `(let ((eshell-command-body '(nil))
537 (eshell-test-body '(nil)))
538 (,func ,test ,body ,else)
539 (eshell-close-handles
540 eshell-last-command-status
541 (list 'quote eshell-last-command-result))))
25fffb31
GM
542
543(defun eshell-rewrite-while-command (terms)
544 "Rewrite a `while' command into its equivalent Eshell command form.
545Because the implementation of `while' relies upon conditional
546evaluation of its argument (i.e., use of a Lisp special form), it
547must be implemented via rewriting, rather than as a function."
548 (if (and (stringp (car terms))
549 (member (car terms) '("while" "until")))
550 (eshell-structure-basic-command
551 'while '("while" "until") (car terms)
552 (eshell-invokify-arg (cadr terms) nil t)
1bc4c3ae
SM
553 `(eshell-protect
554 ,(eshell-invokify-arg (car (last terms)) t)))))
25fffb31
GM
555
556(defun eshell-rewrite-if-command (terms)
557 "Rewrite an `if' command into its equivalent Eshell command form.
558Because the implementation of `if' relies upon conditional
559evaluation of its argument (i.e., use of a Lisp special form), it
560must be implemented via rewriting, rather than as a function."
561 (if (and (stringp (car terms))
562 (member (car terms) '("if" "unless")))
563 (eshell-structure-basic-command
564 'if '("if" "unless") (car terms)
565 (eshell-invokify-arg (cadr terms) nil t)
1bc4c3ae
SM
566 `(eshell-protect
567 ,(eshell-invokify-arg (car (last terms (if (= (length terms) 4) 2)))
568 t))
05a68572 569 (if (= (length terms) 4)
1bc4c3ae
SM
570 `(eshell-protect
571 ,(eshell-invokify-arg (car (last terms)))) t))))
572
573(defvar eshell-last-command-result) ;Defined in esh-io.el.
25fffb31
GM
574
575(defun eshell-exit-success-p ()
576 "Return non-nil if the last command was \"successful\".
577For a bit of Lisp code, this means a return value of non-nil.
578For an external command, it means an exit code of 0."
05a68572
JW
579 (if (save-match-data
580 (string-match "#<\\(Lisp object\\|function .*\\)>"
581 eshell-last-command-name))
25fffb31
GM
582 eshell-last-command-result
583 (= eshell-last-command-status 0)))
584
e8b66a6a
SM
585(defvar eshell--cmd)
586
587(defun eshell-parse-pipeline (terms)
25fffb31
GM
588 "Parse a pipeline from TERMS, return the appropriate Lisp forms."
589 (let* (sep-terms
590 (bigpieces (eshell-separate-commands terms "\\(&&\\|||\\)"
591 nil 'sep-terms))
592 (bp bigpieces)
593 (results (list t))
594 final)
595 (while bp
596 (let ((subterms (car bp)))
597 (let* ((pieces (eshell-separate-commands subterms "|"))
598 (p pieces))
599 (while p
600 (let ((cmd (car p)))
601 (run-hook-with-args 'eshell-pre-rewrite-command-hook cmd)
602 (setq cmd (run-hook-with-args-until-success
603 'eshell-rewrite-command-hook cmd))
e8b66a6a
SM
604 (let ((eshell--cmd cmd))
605 (run-hook-with-args 'eshell-post-rewrite-command-hook
606 'eshell--cmd)
607 (setq cmd eshell--cmd))
608 (setcar p (funcall eshell-post-rewrite-command-function cmd)))
25fffb31
GM
609 (setq p (cdr p)))
610 (nconc results
611 (list
612 (if (<= (length pieces) 1)
613 (car pieces)
a464a6c7 614 (cl-assert (not eshell-in-pipeline-p))
1bc4c3ae 615 `(eshell-execute-pipeline (quote ,pieces))))))
25fffb31
GM
616 (setq bp (cdr bp))))
617 ;; `results' might be empty; this happens in the case of
618 ;; multi-line input
619 (setq results (cdr results)
620 results (nreverse results)
621 final (car results)
622 results (cdr results)
623 sep-terms (nreverse sep-terms))
624 (while results
a464a6c7 625 (cl-assert (car sep-terms))
25fffb31
GM
626 (setq final (eshell-structure-basic-command
627 'if (string= (car sep-terms) "&&") "if"
1bc4c3ae 628 `(eshell-protect ,(car results))
e8b66a6a 629 `(eshell-protect ,final))
25fffb31
GM
630 results (cdr results)
631 sep-terms (cdr sep-terms)))
632 final))
633
634(defun eshell-parse-subcommand-argument ()
635 "Parse a subcommand argument of the form '{command}'."
636 (if (and (not eshell-current-argument)
637 (not eshell-current-quoted)
638 (eq (char-after) ?\{)
639 (or (= (point-max) (1+ (point)))
640 (not (eq (char-after (1+ (point))) ?\}))))
641 (let ((end (eshell-find-delimiter ?\{ ?\})))
642 (if (not end)
643 (throw 'eshell-incomplete ?\{)
644 (when (eshell-arg-delimiter (1+ end))
645 (prog1
1bc4c3ae
SM
646 `(eshell-as-subcommand
647 ,(eshell-parse-command (cons (1+ (point)) end)))
25fffb31
GM
648 (goto-char (1+ end))))))))
649
650(defun eshell-parse-lisp-argument ()
651 "Parse a Lisp expression which is specified as an argument."
652 (if (and (not eshell-current-argument)
653 (not eshell-current-quoted)
654 (looking-at eshell-lisp-regexp))
655 (let* ((here (point))
656 (obj
170266d0 657 (condition-case nil
25fffb31
GM
658 (read (current-buffer))
659 (end-of-file
660 (throw 'eshell-incomplete ?\()))))
661 (if (eshell-arg-delimiter)
1bc4c3ae
SM
662 `(eshell-command-to-value
663 (eshell-lisp-command (quote ,obj)))
25fffb31
GM
664 (ignore (goto-char here))))))
665
dace60cf
JW
666(defun eshell-separate-commands (terms separator &optional
667 reversed last-terms-sym)
25fffb31
GM
668 "Separate TERMS using SEPARATOR.
669If REVERSED is non-nil, the list of separated term groups will be
d4469517 670returned in reverse order. If LAST-TERMS-SYM is a symbol, its value
25fffb31
GM
671will be set to a list of all the separator operators found (or '(list
672nil)' if none)."
673 (let ((sub-terms (list t))
674 (eshell-sep-terms (list t))
675 subchains)
676 (while terms
677 (if (and (consp (car terms))
678 (eq (caar terms) 'eshell-operator)
679 (string-match (concat "^" separator "$")
680 (nth 1 (car terms))))
681 (progn
682 (nconc eshell-sep-terms (list (nth 1 (car terms))))
683 (setq subchains (cons (cdr sub-terms) subchains)
684 sub-terms (list t)))
685 (nconc sub-terms (list (car terms))))
686 (setq terms (cdr terms)))
687 (if (> (length sub-terms) 1)
688 (setq subchains (cons (cdr sub-terms) subchains)))
689 (if reversed
690 (progn
691 (if last-terms-sym
692 (set last-terms-sym (reverse (cdr eshell-sep-terms))))
693 subchains) ; already reversed
694 (if last-terms-sym
695 (set last-terms-sym (cdr eshell-sep-terms)))
696 (nreverse subchains))))
697
698;;_* Command evaluation macros
699;;
700;; The structure of the following macros is very important to
701;; `eshell-do-eval' [Iterative evaluation]:
702;;
703;; @ Don't use forms that conditionally evaluate their arguments, such
704;; as `setq', `if', `while', `let*', etc. The only special forms
705;; that can be used are `let', `condition-case' and
706;; `unwind-protect'.
707;;
708;; @ The main body of a `let' can contain only one form. Use `progn'
709;; if necessary.
710;;
711;; @ The two `special' variables are `eshell-current-handles' and
712;; `eshell-current-subjob-p'. Bind them locally with a `let' if you
713;; need to change them. Change them directly only if your intention
714;; is to change the calling environment.
715
716(defmacro eshell-do-subjob (object)
717 "Evaluate a command OBJECT as a subjob.
6b6f91b3 718We indicate that the process was run in the background by returning it
25fffb31
GM
719ensconced in a list."
720 `(let ((eshell-current-subjob-p t))
721 ,object))
722
723(defmacro eshell-commands (object &optional silent)
724 "Place a valid set of handles, and context, around command OBJECT."
725 `(let ((eshell-current-handles
726 (eshell-create-handles ,(not silent) 'append))
727 eshell-current-subjob-p)
728 ,object))
729
730(defmacro eshell-trap-errors (object)
731 "Trap any errors that occur, so they are not entirely fatal.
732Also, the variable `eshell-this-command-hook' is available for the
733duration of OBJECT's evaluation. Note that functions should be added
734to this hook using `nconc', and *not* `add-hook'.
735
736Someday, when Scheme will become the dominant Emacs language, all of
737this grossness will be made to disappear by using `call/cc'..."
1bc4c3ae 738 `(let ((eshell-this-command-hook '(ignore)))
25fffb31
GM
739 (eshell-condition-case err
740 (prog1
741 ,object
742 (run-hooks 'eshell-this-command-hook))
743 (error
744 (run-hooks 'eshell-this-command-hook)
745 (eshell-errorn (error-message-string err))
746 (eshell-close-handles 1)))))
747
1bc4c3ae
SM
748(defvar eshell-output-handle) ;Defined in esh-io.el.
749(defvar eshell-error-handle) ;Defined in esh-io.el.
750
ca7aae91
JW
751(defmacro eshell-copy-handles (object)
752 "Duplicate current I/O handles, so OBJECT works with its own copy."
753 `(let ((eshell-current-handles
754 (eshell-create-handles
755 (car (aref eshell-current-handles
756 eshell-output-handle)) nil
757 (car (aref eshell-current-handles
758 eshell-error-handle)) nil)))
759 ,object))
760
25fffb31
GM
761(defmacro eshell-protect (object)
762 "Protect I/O handles, so they aren't get closed after eval'ing OBJECT."
763 `(progn
764 (eshell-protect-handles eshell-current-handles)
765 ,object))
766
5101a9dc
GM
767(defmacro eshell-do-pipelines (pipeline &optional notfirst)
768 "Execute the commands in PIPELINE, connecting each to one another.
769This macro calls itself recursively, with NOTFIRST non-nil."
25fffb31 770 (when (setq pipeline (cadr pipeline))
ca7aae91
JW
771 `(eshell-copy-handles
772 (progn
773 ,(when (cdr pipeline)
6dbe3e96
SM
774 `(let ((nextproc
775 (eshell-do-pipelines (quote ,(cdr pipeline)) t)))
1bc4c3ae
SM
776 (eshell-set-output-handle ,eshell-output-handle
777 'append nextproc)
778 (eshell-set-output-handle ,eshell-error-handle
779 'append nextproc)
780 (setq tailproc (or tailproc nextproc))))
ca7aae91
JW
781 ,(let ((head (car pipeline)))
782 (if (memq (car head) '(let progn))
783 (setq head (car (last head))))
784 (when (memq (car head) eshell-deferrable-commands)
785 (ignore
786 (setcar head
787 (intern-soft
788 (concat (symbol-name (car head)) "*"))))))
5101a9dc
GM
789 ;; First and last elements in a pipeline may need special treatment.
790 ;; (Currently only eshell-ls-files uses 'last.)
791 ;; Affects process-connection-type in eshell-gather-process-output.
792 (let ((eshell-in-pipeline-p
793 ,(cond ((not notfirst) (quote 'first))
794 ((cdr pipeline) t)
795 (t (quote 'last)))))
3fe3fd2c 796 ,(car pipeline))))))
ca7aae91
JW
797
798(defmacro eshell-do-pipelines-synchronously (pipeline)
799 "Execute the commands in PIPELINE in sequence synchronously.
800Output of each command is passed as input to the next one in the pipeline.
801This is used on systems where `start-process' is not supported."
802 (when (setq pipeline (cadr pipeline))
6dbe3e96 803 `(progn
1bc4c3ae 804 ,(when (cdr pipeline)
6dbe3e96 805 `(let ((output-marker ,(point-marker)))
1bc4c3ae
SM
806 (eshell-set-output-handle ,eshell-output-handle
807 'append output-marker)
808 (eshell-set-output-handle ,eshell-error-handle
809 'append output-marker)))
810 ,(let ((head (car pipeline)))
811 (if (memq (car head) '(let progn))
812 (setq head (car (last head))))
813 ;; FIXME: is deferrable significant here?
814 (when (memq (car head) eshell-deferrable-commands)
815 (ignore
816 (setcar head
6dbe3e96
SM
817 (intern-soft
818 (concat (symbol-name (car head)) "*"))))))
819 ;; The last process in the pipe should get its handles
1bc4c3ae
SM
820 ;; redirected as we found them before running the pipe.
821 ,(if (null (cdr pipeline))
822 `(progn
823 (setq eshell-current-handles tail-handles)
824 (setq eshell-in-pipeline-p nil)))
6dbe3e96
SM
825 (let ((result ,(car pipeline)))
826 ;; tailproc gets the result of the last successful process in
827 ;; the pipeline.
828 (setq tailproc (or result tailproc))
829 ,(if (cdr pipeline)
830 `(eshell-do-pipelines-synchronously (quote ,(cdr pipeline))))
831 result))))
25fffb31
GM
832
833(defalias 'eshell-process-identity 'identity)
834
835(defmacro eshell-execute-pipeline (pipeline)
836 "Execute the commands in PIPELINE, connecting each to one another."
837 `(let ((eshell-in-pipeline-p t) tailproc)
838 (progn
ca7aae91
JW
839 ,(if (fboundp 'start-process)
840 `(eshell-do-pipelines ,pipeline)
841 `(let ((tail-handles (eshell-create-handles
842 (car (aref eshell-current-handles
843 ,eshell-output-handle)) nil
844 (car (aref eshell-current-handles
845 ,eshell-error-handle)) nil)))
846 (eshell-do-pipelines-synchronously ,pipeline)))
25fffb31
GM
847 (eshell-process-identity tailproc))))
848
849(defmacro eshell-as-subcommand (command)
850 "Execute COMMAND using a temp buffer.
851This is used so that certain Lisp commands, such as `cd', when
852executed in a subshell, do not disturb the environment of the main
853Eshell buffer."
854 `(let ,eshell-subcommand-bindings
855 ,command))
856
857(defmacro eshell-do-command-to-value (object)
858 "Run a subcommand prepared by `eshell-command-to-value'.
859This avoids the need to use `let*'."
860 `(let ((eshell-current-handles
861 (eshell-create-handles value 'overwrite)))
862 (progn
863 ,object
864 (symbol-value value))))
865
866(defmacro eshell-command-to-value (object)
867 "Run OBJECT synchronously, returning its result as a string.
868Returns a string comprising the output from the command."
869 `(let ((value (make-symbol "eshell-temp")))
870 (eshell-do-command-to-value ,object)))
871
872;;;_* Iterative evaluation
873;;
874;; Eshell runs all of its external commands asynchronously, so that
875;; Emacs is not blocked while the operation is being performed.
876;; However, this introduces certain synchronization difficulties,
877;; since the Lisp code, once it returns, will not "go back" to finish
878;; executing the commands which haven't yet been started.
879;;
880;; What Eshell does to work around this problem (basically, the lack
881;; of threads in Lisp), is that it evaluates the command sequence
882;; iteratively. Whenever an asynchronous process is begun, evaluation
883;; terminates and control is given back to Emacs. When that process
884;; finishes, it will resume the evaluation using the remainder of the
885;; command tree.
886
887(defun eshell/eshell-debug (&rest args)
888 "A command for toggling certain debug variables."
889 (ignore
890 (cond
891 ((not args)
892 (if eshell-handle-errors
893 (eshell-print "errors\n"))
894 (if eshell-debug-command
895 (eshell-print "commands\n")))
6dbe3e96 896 ((member (car args) '("-h" "--help"))
25fffb31
GM
897 (eshell-print "usage: eshell-debug [kinds]
898
899This command is used to aid in debugging problems related to Eshell
900itself. It is not useful for anything else. The recognized `kinds'
901at the moment are:
902
903 errors stops Eshell from trapping errors
904 commands shows command execution progress in `*eshell last cmd*'
905"))
906 (t
907 (while args
908 (cond
909 ((string= (car args) "errors")
910 (setq eshell-handle-errors (not eshell-handle-errors)))
911 ((string= (car args) "commands")
912 (setq eshell-debug-command (not eshell-debug-command))))
913 (setq args (cdr args)))))))
914
915(defun pcomplete/eshell-mode/eshell-debug ()
916 "Completion for the `debug' command."
917 (while (pcomplete-here '("errors" "commands"))))
918
e8b66a6a 919(defun eshell-invoke-directly (command)
dace60cf
JW
920 (let ((base (cadr (nth 2 (nth 2 (cadr command))))) name)
921 (if (and (eq (car base) 'eshell-trap-errors)
922 (eq (car (cadr base)) 'eshell-named-command))
923 (setq name (cadr (cadr base))))
924 (and name (stringp name)
925 (not (member name eshell-complex-commands))
926 (catch 'simple
927 (progn
a9eeff78 928 (dolist (pred eshell-complex-commands)
dace60cf
JW
929 (if (and (functionp pred)
930 (funcall pred name))
931 (throw 'simple nil)))
932 t))
933 (fboundp (intern-soft (concat "eshell/" name))))))
934
25fffb31
GM
935(defun eshell-eval-command (command &optional input)
936 "Evaluate the given COMMAND iteratively."
937 (if eshell-current-command
938 ;; we can just stick the new command at the end of the current
939 ;; one, and everything will happen as it should
940 (setcdr (last (cdr eshell-current-command))
1bc4c3ae
SM
941 (list `(let ((here (and (eobp) (point))))
942 ,(and input
943 `(insert-and-inherit ,(concat input "\n")))
944 (if here
945 (eshell-update-markers here))
946 (eshell-do-eval ',command))))
25fffb31 947 (and eshell-debug-command
ee5b7365
SM
948 (with-current-buffer (get-buffer-create "*eshell last cmd*")
949 (erase-buffer)
950 (insert "command: \"" input "\"\n")))
25fffb31 951 (setq eshell-current-command command)
ca7aae91
JW
952 (let ((delim (catch 'eshell-incomplete
953 (eshell-resume-eval))))
4c334f5b
EZ
954 ;; On systems that don't support async subprocesses, eshell-resume
955 ;; can return t. Don't treat that as an error.
6b6f91b3
JW
956 (if (listp delim)
957 (setq delim (car delim)))
4c334f5b 958 (if (and delim (not (eq delim t)))
6b6f91b3 959 (error "Unmatched delimiter: %c" delim)))))
25fffb31
GM
960
961(defun eshell-resume-command (proc status)
962 "Resume the current command when a process ends."
963 (when proc
ca7aae91
JW
964 (unless (or (not (stringp status))
965 (string= "stopped" status)
25fffb31
GM
966 (string-match eshell-reset-signals status))
967 (if (eq proc (eshell-interactive-process))
968 (eshell-resume-eval)))))
969
970(defun eshell-resume-eval ()
971 "Destructively evaluate a form which may need to be deferred."
972 (eshell-condition-case err
973 (progn
974 (setq eshell-last-async-proc nil)
975 (when eshell-current-command
976 (let* (retval
977 (proc (catch 'eshell-defer
978 (ignore
979 (setq retval
980 (eshell-do-eval
981 eshell-current-command))))))
ca7aae91 982 (if (eshell-processp proc)
25fffb31
GM
983 (ignore (setq eshell-last-async-proc proc))
984 (cadr retval)))))
985 (error
986 (error (error-message-string err)))))
987
988(defmacro eshell-manipulate (tag &rest commands)
989 "Manipulate a COMMAND form, with TAG as a debug identifier."
1bc4c3ae 990 (declare (indent 1))
ee5b7365
SM
991 ;; Check `bound'ness since at compile time the code until here has not
992 ;; executed yet.
993 (if (not (and (boundp 'eshell-debug-command) eshell-debug-command))
25fffb31
GM
994 `(progn ,@commands)
995 `(progn
996 (eshell-debug-command ,(eval tag) form)
997 ,@commands
998 (eshell-debug-command ,(concat "done " (eval tag)) form))))
999
25fffb31
GM
1000(defun eshell-do-eval (form &optional synchronous-p)
1001 "Evaluate form, simplifying it as we go.
1002Unless SYNCHRONOUS-P is non-nil, throws `eshell-defer' if it needs to
1003be finished later after the completion of an asynchronous subprocess."
1004 (cond
1005 ((not (listp form))
1006 (list 'quote (eval form)))
1007 ((memq (car form) '(quote function))
1008 form)
1009 (t
1010 ;; skip past the call to `eshell-do-eval'
1011 (when (eq (car form) 'eshell-do-eval)
1012 (setq form (cadr (cadr form))))
1013 ;; expand any macros directly into the form. This is done so that
1014 ;; we can modify any `let' forms to evaluate only once.
671d5c16 1015 (if (macrop (car form))
25fffb31
GM
1016 (let ((exp (eshell-copy-tree (macroexpand form))))
1017 (eshell-manipulate (format "expanding macro `%s'"
1018 (symbol-name (car form)))
1019 (setcar form (car exp))
1020 (setcdr form (cdr exp)))))
1021 (let ((args (cdr form)))
1022 (cond
1023 ((eq (car form) 'while)
1024 ;; `eshell-copy-tree' is needed here so that the test argument
1025 ;; doesn't get modified and thus always yield the same result.
1026 (when (car eshell-command-body)
a464a6c7 1027 (cl-assert (not synchronous-p))
25fffb31 1028 (eshell-do-eval (car eshell-command-body))
ca7aae91
JW
1029 (setcar eshell-command-body nil)
1030 (setcar eshell-test-body nil))
25fffb31
GM
1031 (unless (car eshell-test-body)
1032 (setcar eshell-test-body (eshell-copy-tree (car args))))
ca7aae91 1033 (while (cadr (eshell-do-eval (car eshell-test-body)))
c1e2f5fa
SM
1034 (setcar eshell-command-body
1035 (if (cddr args)
1036 `(progn ,@(eshell-copy-tree (cdr args)))
1037 (eshell-copy-tree (cadr args))))
ca7aae91
JW
1038 (eshell-do-eval (car eshell-command-body) synchronous-p)
1039 (setcar eshell-command-body nil)
1040 (setcar eshell-test-body (eshell-copy-tree (car args))))
25fffb31
GM
1041 (setcar eshell-command-body nil))
1042 ((eq (car form) 'if)
1043 ;; `eshell-copy-tree' is needed here so that the test argument
1044 ;; doesn't get modified and thus always yield the same result.
ca7aae91
JW
1045 (if (car eshell-command-body)
1046 (progn
a464a6c7 1047 (cl-assert (not synchronous-p))
ca7aae91
JW
1048 (eshell-do-eval (car eshell-command-body)))
1049 (unless (car eshell-test-body)
1050 (setcar eshell-test-body (eshell-copy-tree (car args))))
1bc4c3ae
SM
1051 (setcar eshell-command-body
1052 (eshell-copy-tree
1053 (if (cadr (eshell-do-eval (car eshell-test-body)))
1054 (cadr args)
1055 (car (cddr args)))))
ca7aae91
JW
1056 (eshell-do-eval (car eshell-command-body) synchronous-p))
1057 (setcar eshell-command-body nil)
1058 (setcar eshell-test-body nil))
25fffb31
GM
1059 ((eq (car form) 'setcar)
1060 (setcar (cdr args) (eshell-do-eval (cadr args) synchronous-p))
1061 (eval form))
1062 ((eq (car form) 'setcdr)
1063 (setcar (cdr args) (eshell-do-eval (cadr args) synchronous-p))
1064 (eval form))
1065 ((memq (car form) '(let catch condition-case unwind-protect))
1066 ;; `let', `condition-case' and `unwind-protect' have to be
1067 ;; handled specially, because we only want to call
1068 ;; `eshell-do-eval' on their first form.
1069 ;;
1070 ;; NOTE: This requires obedience by all forms which this
1071 ;; function might encounter, that they do not contain
1072 ;; other special forms.
1073 (if (and (eq (car form) 'let)
1074 (not (eq (car (cadr args)) 'eshell-do-eval)))
1075 (eshell-manipulate "evaluating let args"
a9eeff78 1076 (dolist (letarg (car args))
25fffb31
GM
1077 (if (and (listp letarg)
1078 (not (eq (cadr letarg) 'quote)))
1079 (setcdr letarg
1080 (list (eshell-do-eval
1081 (cadr letarg) synchronous-p)))))))
1082 (unless (eq (car form) 'unwind-protect)
1083 (setq args (cdr args)))
1084 (unless (eq (caar args) 'eshell-do-eval)
1085 (eshell-manipulate "handling special form"
1bc4c3ae 1086 (setcar args `(eshell-do-eval ',(car args) ,synchronous-p))))
25fffb31 1087 (eval form))
6dbe3e96
SM
1088 ((eq (car form) 'setq)
1089 (if (cddr args) (error "Unsupported form (setq X1 E1 X2 E2..)"))
1090 (eshell-manipulate "evaluating arguments to setq"
1091 (setcar (cdr args) (eshell-do-eval (cadr args) synchronous-p)))
1092 (list 'quote (eval form)))
25fffb31
GM
1093 (t
1094 (if (and args (not (memq (car form) '(run-hooks))))
1095 (eshell-manipulate
1096 (format "evaluating arguments to `%s'"
1097 (symbol-name (car form)))
1098 (while args
1099 (setcar args (eshell-do-eval (car args) synchronous-p))
1100 (setq args (cdr args)))))
1101 (cond
1102 ((eq (car form) 'progn)
1103 (car (last form)))
1104 ((eq (car form) 'prog1)
1105 (cadr form))
1106 (t
dace60cf
JW
1107 ;; If a command desire to replace its execution form with
1108 ;; another command form, all it needs to do is throw the new
1109 ;; form using the exception tag `eshell-replace-command'.
1110 ;; For example, let's say that the form currently being
1111 ;; eval'd is:
1112 ;;
1113 ;; (eshell-named-command "hello")
1114 ;;
1115 ;; Now, let's assume the 'hello' command is an Eshell alias,
1116 ;; the definition of which yields the command:
1117 ;;
1118 ;; (eshell-named-command "echo" (list "Hello" "world"))
1119 ;;
1120 ;; What the alias code would like to do is simply substitute
1121 ;; the alias form for the original form. To accomplish
1122 ;; this, all it needs to do is to throw the substitution
1123 ;; form with the `eshell-replace-command' tag, and the form
1124 ;; will be replaced within the current command, and
1125 ;; execution will then resume (iteratively) as before.
1126 ;; Thus, aliases can even contain references to asynchronous
1127 ;; sub-commands, and things will still work out as they
1128 ;; should.
6dbe3e96
SM
1129 (let* (result
1130 (new-form
1131 (catch 'eshell-replace-command
1132 (ignore
1133 (setq result (eval form))))))
1134 (if new-form
25fffb31
GM
1135 (progn
1136 (eshell-manipulate "substituting replacement form"
1137 (setcar form (car new-form))
1138 (setcdr form (cdr new-form)))
1139 (eshell-do-eval form synchronous-p))
1140 (if (and (memq (car form) eshell-deferrable-commands)
1141 (not eshell-current-subjob-p)
1142 result
ca7aae91 1143 (eshell-processp result))
25fffb31
GM
1144 (if synchronous-p
1145 (eshell/wait result)
1146 (eshell-manipulate "inserting ignore form"
1147 (setcar form 'ignore)
1148 (setcdr form nil))
1149 (throw 'eshell-defer result))
1150 (list 'quote result))))))))))))
1151
1152;; command invocation
1153
1154(defun eshell/which (command &rest names)
1155 "Identify the COMMAND, and where it is located."
a9eeff78 1156 (dolist (name (cons command names))
25fffb31 1157 (let (program alias direct)
94d13633 1158 (if (eq (aref name 0) eshell-explicit-command-char)
25fffb31
GM
1159 (setq name (substring name 1)
1160 direct t))
1161 (if (and (not direct)
1162 (eshell-using-module 'eshell-alias)
1163 (setq alias
1164 (funcall (symbol-function 'eshell-lookup-alias)
1165 name)))
1166 (setq program
1167 (concat name " is an alias, defined as \""
1168 (cadr alias) "\"")))
1169 (unless program
1170 (setq program (eshell-search-path name))
1171 (let* ((esym (eshell-find-alias-function name))
1172 (sym (or esym (intern-soft name))))
ac03c474
JW
1173 (if (and (or esym (and sym (fboundp sym)))
1174 (or eshell-prefer-lisp-functions (not direct)))
25fffb31
GM
1175 (let ((desc (let ((inhibit-redisplay t))
1176 (save-window-excursion
1177 (prog1
1178 (describe-function sym)
1179 (message nil))))))
c1043701
GM
1180 (setq desc (if desc (substring desc 0
1181 (1- (or (string-match "\n" desc)
1182 (length desc))))
1183 ;; This should not happen.
1184 (format "%s is defined, \
1185but no documentation was found" name)))
ca7aae91
JW
1186 (if (buffer-live-p (get-buffer "*Help*"))
1187 (kill-buffer "*Help*"))
25fffb31
GM
1188 (setq program (or desc name))))))
1189 (if (not program)
1190 (eshell-error (format "which: no %s in (%s)\n"
1191 name (getenv "PATH")))
1192 (eshell-printn program)))))
1193
3cb27fd7
JW
1194(put 'eshell/which 'eshell-no-numeric-conversions t)
1195
25fffb31
GM
1196(defun eshell-named-command (command &optional args)
1197 "Insert output from a plain COMMAND, using ARGS.
1198COMMAND may result in an alias being executed, or a plain command."
1199 (setq eshell-last-arguments args
1200 eshell-last-command-name (eshell-stringify command))
1201 (run-hook-with-args 'eshell-prepare-command-hook)
a464a6c7 1202 (cl-assert (stringp eshell-last-command-name))
25fffb31
GM
1203 (if eshell-last-command-name
1204 (or (run-hook-with-args-until-success
1205 'eshell-named-command-hook eshell-last-command-name
1206 eshell-last-arguments)
1207 (eshell-plain-command eshell-last-command-name
1208 eshell-last-arguments))))
1209
1210(defalias 'eshell-named-command* 'eshell-named-command)
1211
1212(defun eshell-find-alias-function (name)
1213 "Check whether a function called `eshell/NAME' exists."
1214 (let* ((sym (intern-soft (concat "eshell/" name)))
5cb345c1 1215 (file (symbol-file sym 'defun)))
c7b1b508 1216 ;; If the function exists, but is defined in an eshell module
9a48e168 1217 ;; that's not currently enabled, don't report it as found.
25fffb31 1218 (if (and file
9a48e168
GM
1219 (setq file (file-name-base file))
1220 (string-match "\\`\\(em\\|esh\\)-\\([[:alnum:]]+\\)\\'" file))
c7b1b508 1221 (let ((module-sym
9a48e168 1222 (intern (concat "eshell-" (match-string 2 file)))))
2e88b53c
JW
1223 (if (and (functionp sym)
1224 (or (null module-sym)
1225 (eshell-using-module module-sym)
1226 (memq module-sym (eshell-subgroups 'eshell))))
c7b1b508
JW
1227 sym))
1228 ;; Otherwise, if it's bound, return it.
1229 (if (functionp sym)
1230 sym))))
25fffb31
GM
1231
1232(defun eshell-plain-command (command args)
1233 "Insert output from a plain COMMAND, using ARGS.
1234COMMAND may result in either a Lisp function being executed by name,
1235or an external command."
1236 (let* ((esym (eshell-find-alias-function command))
1237 (sym (or esym (intern-soft command))))
1238 (if (and sym (fboundp sym)
1239 (or esym eshell-prefer-lisp-functions
1240 (not (eshell-search-path command))))
1241 (eshell-lisp-command sym args)
1242 (eshell-external-command command args))))
1243
1244(defun eshell-exec-lisp (printer errprint func-or-form args form-p)
1245 "Execute a lisp FUNC-OR-FORM, maybe passing ARGS.
1246PRINTER and ERRPRINT are functions to use for printing regular
1247messages, and errors. FORM-P should be non-nil if FUNC-OR-FORM
1248represent a lisp form; ARGS will be ignored in that case."
6dbe3e96
SM
1249 (eshell-condition-case err
1250 (let ((result
1251 (save-current-buffer
1252 (if form-p
1253 (eval func-or-form)
1254 (apply func-or-form args)))))
1255 (and result (funcall printer result))
1256 result)
1257 (error
1258 (let ((msg (error-message-string err)))
1259 (if (and (not form-p)
1260 (string-match "^Wrong number of arguments" msg)
1261 (fboundp 'eldoc-get-fnsym-args-string))
1262 (let ((func-doc (eldoc-get-fnsym-args-string func-or-form)))
1263 (setq msg (format "usage: %s" func-doc))))
1264 (funcall errprint msg))
1265 nil)))
25fffb31
GM
1266
1267(defsubst eshell-apply* (printer errprint func args)
1268 "Call FUNC, with ARGS, trapping errors and return them as output.
1269PRINTER and ERRPRINT are functions to use for printing regular
1270messages, and errors."
1271 (eshell-exec-lisp printer errprint func args nil))
1272
1273(defsubst eshell-funcall* (printer errprint func &rest args)
1274 "Call FUNC, with ARGS, trapping errors and return them as output."
1275 (eshell-apply* printer errprint func args))
1276
1277(defsubst eshell-eval* (printer errprint form)
1278 "Evaluate FORM, trapping errors and returning them."
1279 (eshell-exec-lisp printer errprint form nil t))
1280
1281(defsubst eshell-apply (func args)
1282 "Call FUNC, with ARGS, trapping errors and return them as output.
1283PRINTER and ERRPRINT are functions to use for printing regular
1284messages, and errors."
1285 (eshell-apply* 'eshell-print 'eshell-error func args))
1286
1287(defsubst eshell-funcall (func &rest args)
1288 "Call FUNC, with ARGS, trapping errors and return them as output."
1289 (eshell-apply func args))
1290
1291(defsubst eshell-eval (form)
1292 "Evaluate FORM, trapping errors and returning them."
1293 (eshell-eval* 'eshell-print 'eshell-error form))
1294
1295(defsubst eshell-applyn (func args)
1296 "Call FUNC, with ARGS, trapping errors and return them as output.
1297PRINTER and ERRPRINT are functions to use for printing regular
1298messages, and errors."
1299 (eshell-apply* 'eshell-printn 'eshell-errorn func args))
1300
1301(defsubst eshell-funcalln (func &rest args)
1302 "Call FUNC, with ARGS, trapping errors and return them as output."
1303 (eshell-applyn func args))
1304
1305(defsubst eshell-evaln (form)
1306 "Evaluate FORM, trapping errors and returning them."
1307 (eshell-eval* 'eshell-printn 'eshell-errorn form))
1308
1bc4c3ae
SM
1309(defvar eshell-last-output-end) ;Defined in esh-mode.el.
1310
25fffb31
GM
1311(defun eshell-lisp-command (object &optional args)
1312 "Insert Lisp OBJECT, using ARGS if a function."
25fffb31
GM
1313 (catch 'eshell-external ; deferred to an external command
1314 (let* ((eshell-ensure-newline-p (eshell-interactive-output-p))
1315 (result
1316 (if (functionp object)
3cb27fd7
JW
1317 (progn
1318 (setq eshell-last-arguments args
1319 eshell-last-command-name
1320 (concat "#<function " (symbol-name object) ">"))
1321 ;; if any of the arguments are flagged as numbers
1322 ;; waiting for conversion, convert them now
1323 (unless (get object 'eshell-no-numeric-conversions)
1324 (while args
1325 (let ((arg (car args)))
1326 (if (and (stringp arg)
1327 (> (length arg) 0)
175acc2d
JW
1328 (not (text-property-not-all
1329 0 (length arg) 'number t arg)))
ea7974a6 1330 (setcar args (string-to-number arg))))
3cb27fd7
JW
1331 (setq args (cdr args))))
1332 (eshell-apply object eshell-last-arguments))
1333 (setq eshell-last-arguments args
1334 eshell-last-command-name "#<Lisp object>")
25fffb31
GM
1335 (eshell-eval object))))
1336 (if (and eshell-ensure-newline-p
1337 (save-excursion
1338 (goto-char eshell-last-output-end)
1339 (not (bolp))))
1340 (eshell-print "\n"))
1341 (eshell-close-handles 0 (list 'quote result)))))
1342
1343(defalias 'eshell-lisp-command* 'eshell-lisp-command)
1344
56590d2f
GM
1345(provide 'esh-cmd)
1346
25fffb31 1347;;; esh-cmd.el ends here