1 ;;; em-script.el --- Eshell script files
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
31 (defgroup eshell-script nil
32 "This module allows for the execution of files containing Eshell
33 commands, as a script file."
34 :tag
"Running script files."
35 :group
'eshell-module
)
39 (defcustom eshell-script-load-hook
'(eshell-script-initialize)
40 "*A list of functions to call when loading `eshell-script'."
42 :group
'eshell-script
)
44 (defcustom eshell-login-script
(concat eshell-directory-name
"login")
45 "*If non-nil, a file to invoke when starting up Eshell interactively.
46 This file should be a file containing Eshell commands, where comment
47 lines begin with '#'."
49 :group
'eshell-script
)
51 (defcustom eshell-rc-script
(concat eshell-directory-name
"profile")
52 "*If non-nil, a file to invoke whenever Eshell is started.
53 This includes when running `eshell-command'."
55 :group
'eshell-script
)
59 (defun eshell-script-initialize ()
60 "Initialize the script parsing code."
61 (make-local-variable 'eshell-interpreter-alist
)
62 (setq eshell-interpreter-alist
63 (cons '((lambda (file)
64 (string= (file-name-nondirectory file
)
65 "eshell")) . eshell
/source
)
66 eshell-interpreter-alist
))
67 (make-local-variable 'eshell-complex-commands
)
68 (setq eshell-complex-commands
69 (append '("source" ".") eshell-complex-commands
))
70 ;; these two variables are changed through usage, but we don't want
71 ;; to ruin it for other modules
72 (let (eshell-inside-quote-regexp
73 eshell-outside-quote-regexp
)
74 (and (not eshell-non-interactive-p
)
76 (file-readable-p eshell-login-script
)
78 (list 'eshell-commands
79 (catch 'eshell-replace-command
80 (eshell-source-file eshell-login-script
))) t
))
82 (file-readable-p eshell-rc-script
)
84 (list 'eshell-commands
85 (catch 'eshell-replace-command
86 (eshell-source-file eshell-rc-script
))) t
))))
88 (defun eshell-source-file (file &optional args subcommand-p
)
89 "Execute a series of Eshell commands in FILE, passing ARGS.
90 Comments begin with '#'."
94 (inhibit-point-motion-hooks t
)
95 after-change-functions
)
96 (goto-char (point-max))
97 (insert-file-contents file
)
98 (goto-char (point-max))
99 (throw 'eshell-replace-command
102 (list (list 'eshell-command-name
(list 'quote file
))
103 (list 'eshell-command-arguments
105 (let ((cmd (eshell-parse-command (cons here
(point)))))
107 (setq cmd
(list 'eshell-as-subcommand cmd
)))
109 (delete-region here
(point))
112 (defun eshell/source
(&rest args
)
113 "Source a file in a subshell environment."
114 (eshell-eval-using-options
116 '((?h
"help" nil nil
"show this usage screen")
119 Invoke the Eshell commands in FILE in a subshell, binding ARGS to $1,
121 (eshell-source-file (car args
) (cdr args
) t
)))
123 (put 'eshell
/source
'eshell-no-numeric-conversions t
)
125 (defun eshell/.
(&rest args
)
126 "Source a file in the current environment."
127 (eshell-eval-using-options
129 '((?h
"help" nil nil
"show this usage screen")
132 Invoke the Eshell commands in FILE within the current shell
133 environment, binding ARGS to $1, $2, etc.")
134 (eshell-source-file (car args
) (cdr args
))))
136 (put 'eshell
/.
'eshell-no-numeric-conversions t
)
140 ;; arch-tag: a346439d-5ba8-4faf-ac2b-3aacfeaa4647
141 ;;; em-script.el ends here