1 ;;; executable.el --- base functionality for executable interpreter scripts -*- byte-compile-dynamic: t -*-
3 ;; Copyright (C) 1994-1996, 2000-2012 Free Software Foundation, Inc.
5 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
6 ;; Keywords: languages, unix
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 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
25 ;; executable.el is used by certain major modes to insert a suitable
26 ;; #! line at the beginning of the file, if the file does not already
29 ;; Unless it has a magic number, a Unix file with executable mode is passed to
30 ;; a new instance of the running shell (or to a Bourne shell if a csh is
31 ;; running and the file starts with `:'). Only a shell can start such a file,
32 ;; exec() cannot, which is why it is important to have a magic number in every
33 ;; executable script. Such a magic number is made up by the characters `#!'
34 ;; the filename of an interpreter (in COFF, ELF or somesuch format) and one
37 ;; This library is for certain major modes like sh-, awk-, perl-, tcl- or
38 ;; makefile-mode to insert or update a suitable #! line at the beginning of
39 ;; the file, if the file does not already have one and the file is not a
40 ;; default file of that interpreter (like .profile or makefile). It also
41 ;; makes the file executable if it wasn't, as soon as it's saved.
43 ;; It also allows debugging scripts, with an adaptation of compile, as far
44 ;; as interpreters give out meaningful error messages.
46 ;; Modes that use this should nconc `executable-map' to the end of their own
47 ;; keymap and `executable-font-lock-keywords' to the end of their own font
48 ;; lock keywords. Their mode-setting commands should call
49 ;; `executable-set-magic'.
53 (defgroup executable nil
54 "Base functionality for executable interpreter scripts."
57 ;; This used to default to `other', but that doesn't seem to have any
58 ;; significance. fx 2000-02-11.
59 (defcustom executable-insert t
; 'other
60 "Non-nil means offer to add a magic number to a file.
61 This takes effect when you switch to certain major modes,
62 including Shell-script mode (`sh-mode').
63 When you type \\[executable-set-magic], it always offers to add or
64 update the magic number."
65 ;;; :type '(choice (const :tag "off" nil)
66 ;;; (const :tag "on" t)
72 (defcustom executable-query
'function
73 "If non-nil, ask user before changing an existing magic number.
74 When this is `function', only ask when called non-interactively."
75 :type
'(choice (const :tag
"Don't Ask" nil
)
76 (const :tag
"Ask when non-interactive" function
)
81 (defcustom executable-magicless-file-regexp
"/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$"
82 "On files with this kind of name no magic is inserted or changed."
87 (defcustom executable-prefix
"#! "
88 "Interpreter magic number prefix inserted when there was no magic number."
93 (defcustom executable-chmod
73
94 "After saving, if the file is not executable, set this mode.
95 This mode passed to `set-file-modes' is taken absolutely when negative, or
96 relative to the files existing modes. Do nothing if this is nil.
97 Typical values are 73 (+x) or -493 (rwxr-xr-x)."
98 :type
'(choice integer
103 (defvar executable-command nil
)
105 (defcustom executable-self-display
"tail"
106 "Command you use with argument `+2' to make text files self-display.
107 Note that the like of `more' doesn't work too well under Emacs \\[shell]."
112 (defvar executable-font-lock-keywords
113 '(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t
))
114 "Rules for highlighting executable scripts' magic number.
115 This can be included in `font-lock-keywords' by modes that call `executable'.")
118 (defvar executable-error-regexp-alist
119 '(;; /bin/xyz: syntax error at line 14: `(' unexpected
120 ;; /bin/xyz[5]: syntax error at line 8 : ``' unmatched
121 ("^\\(.*[^[/]\\)\\(\\[[0-9]+\\]\\)?: .* error .* line \\([0-9]+\\)" 1 3)
122 ;; /bin/xyz[27]: ehco: not found
123 ("^\\(.*[^/]\\)\\[\\([0-9]+\\)\\]: .*: " 1 2)
124 ;; /bin/xyz: syntax error near unexpected token `)'
125 ;; /bin/xyz: /bin/xyz: line 2: `)'
126 ("^\\(.*[^/]\\): [^0-9\n]+\n\\1: \\1: line \\([0-9]+\\):" 1 2)
127 ;; /usr/bin/awk: syntax error at line 5 of file /bin/xyz
128 (" error .* line \\([0-9]+\\) of file \\(.+\\)$" 2 1)
129 ;; /usr/bin/awk: calling undefined function toto
130 ;; input record number 3, file awktestdata
131 ;; source line 4 of file /bin/xyz
132 ("^[^ ].+\n\\( .+\n\\)* line \\([0-9]+\\) of file \\(.+\\)$" 3 2)
133 ;; makefile:1: *** target pattern contains no `%'. Stop.
134 ("^\\(.+\\):\\([0-9]+\\): " 1 2))
135 "Alist of regexps used to match script errors.
136 See `compilation-error-regexp-alist'.")
138 ;; The C function openp slightly modified would do the trick fine
139 (defvaralias 'executable-binary-suffixes
'exec-suffixes
)
142 (defun executable-command-find-posix-p (&optional program
)
143 "Check if PROGRAM handles arguments Posix-style.
144 If PROGRAM is non-nil, use that instead of \"find\"."
145 ;; Pick file to search from location we know
146 (let* ((dir (file-truename data-directory
))
147 (file (car (directory-files dir nil
"^[^.]"))))
149 (call-process (or program
"find")
158 (goto-char (point-min))
159 (if (search-forward file nil t
)
162 (defun executable-chmod ()
163 "This gets called after saving a file to assure that it be executable.
164 You can set the absolute or relative mode in variable `executable-chmod' for
165 non-executable files."
166 (and executable-chmod
168 (or (file-executable-p buffer-file-name
)
169 (set-file-modes buffer-file-name
170 (if (< executable-chmod
0)
172 (logior executable-chmod
173 (file-modes buffer-file-name
)))))))
176 (defvar compilation-error-regexp-alist
) ; from compile.el
179 (defun executable-interpret (command)
180 "Run script with user-specified args, and collect output in a buffer.
181 While script runs asynchronously, you can use the \\[next-error]
182 command to find the next error. The buffer is also in `comint-mode' and
183 `compilation-shell-minor-mode', so that you can answer any prompts."
184 (interactive (list (read-string "Run script: "
185 (or executable-command
188 (save-some-buffers (not compilation-ask-about-save
))
189 (set (make-local-variable 'executable-command
) command
)
190 (let ((compilation-error-regexp-alist executable-error-regexp-alist
))
191 (compilation-start command t
(lambda (_x) "*interpretation*"))))
196 (defun executable-set-magic (interpreter &optional argument
197 no-query-flag insert-flag
)
198 "Set this buffer's interpreter to INTERPRETER with optional ARGUMENT.
199 The variables `executable-magicless-file-regexp', `executable-prefix',
200 `executable-insert', `executable-query' and `executable-chmod' control
201 when and how magic numbers are inserted or replaced and scripts made
204 (let* ((name (read-string "Name or file name of interpreter: "))
205 (arg (read-string (format "Argument for %s: " name
))))
206 (list name arg
(eq executable-query
'function
) t
)))
208 (setq interpreter
(if (file-name-absolute-p interpreter
)
210 (or (executable-find interpreter
)
211 (error "Interpreter %s not recognized"
214 (setq argument
(concat (if (string-match "\\`/:" interpreter
)
215 (replace-match "" nil nil interpreter
)
217 (and argument
(string< "" argument
) " ")
222 (string-match executable-magicless-file-regexp
224 (not (or insert-flag executable-insert
))
227 (goto-char (point-min))
228 (add-hook 'after-save-hook
'executable-chmod nil t
)
229 (if (looking-at "#![ \t]*\\(.*\\)$")
230 (and (goto-char (match-beginning 1))
231 ;; If the line ends in a space,
232 ;; don't offer to change it.
233 (not (= (char-after (1- (match-end 1))) ?\s
))
234 (not (string= argument
235 (buffer-substring (point) (match-end 1))))
236 (if (or (not executable-query
) no-query-flag
237 (save-window-excursion
238 ;; Make buffer visible before question.
239 (switch-to-buffer (current-buffer))
240 (y-or-n-p (concat "Replace magic number by `"
241 executable-prefix argument
"'? "))))
243 (replace-match argument t t nil
1)
244 (message "Magic number changed to `%s'"
245 (concat executable-prefix argument
)))))
246 (insert executable-prefix argument ?
\n)
247 (message "Magic number changed to `%s'"
248 (concat executable-prefix argument
)))))
254 (defun executable-self-display ()
255 "Turn a text file into a self-displaying Un*x command.
256 The magic number of such a command displays all lines but itself."
258 (if (eq this-command
'executable-self-display
)
259 (setq this-command
'executable-set-magic
))
260 (executable-set-magic executable-self-display
"+2"))
263 (defun executable-make-buffer-file-executable-if-script-p ()
264 "Make file executable according to umask if not already executable.
265 If file already has any execute bits set at all, do not change existing
267 (and (>= (buffer-size) 2)
270 (string= "#!" (buffer-substring (point-min) (+ 2 (point-min)))))
272 (let* ((current-mode (file-modes (buffer-file-name)))
273 (add-mode (logand ?
\111 (default-file-modes))))
274 (or (/= (logand ?
\111 current-mode
) 0)
276 (set-file-modes (buffer-file-name)
277 (logior current-mode add-mode
))))
278 ;; Eg file-modes can return nil (bug#9879). It should not,
279 ;; in this context, but we should handle it all the same.
280 (error (message "Unable to make file executable")))))
282 (provide 'executable
)
284 ;;; executable.el ends here