;;; executable.el --- base functionality for executable interpreter scripts -*- byte-compile-dynamic: t -*-
;; Copyright (C) 1994, 1995, 1996, 2000, 2003, 2004 by Free Software Foundation, Inc.
;; Author: Daniel Pfeiffer <firstname.lastname@example.org>
;; Keywords: languages, unix
;; This file is part of XEmacs.
;; XEmacs is free software; you can redistribute it and/or modify it
;; under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; XEmacs is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with XEmacs; see the file COPYING. If not, write to the Free
;; Software Foundation, Inc., 51 Franklin Street, Fifth Floor
;; Boston, MA 02110-1301, USA.
;;; Synched up with: FSF 188.8.131.52 (CVS)
;; executable.el is used by certain major modes to insert a suitable
;; #! line at the beginning of the file, if the file does not already
;; have one.
;; Unless it has a magic number, a Unix file with executable mode is passed to
;; a new instance of the running shell (or to a Bourne shell if a csh is
;; running and the file starts with `:'). Only a shell can start such a file,
;; exec() cannot, which is why it is important to have a magic number in every
;; executable script. Such a magic number is made up by the characters `#!'
;; the filename of an interpreter (in COFF, ELF or somesuch format) and one
;; optional argument.
;; This library is for certain major modes like sh-, awk-, perl-, tcl- or
;; makefile-mode to insert or update a suitable #! line at the beginning of
;; the file, if the file does not already have one and the file is not a
;; default file of that interpreter (like .profile or makefile). It also
;; makes the file executable if it wasn't, as soon as it's saved.
;; It also allows debugging scripts, with an adaptation of compile, as far
;; as interpreters give out meaningful error messages.
;; Modes that use this should nconc `executable-map' to the end of their own
;; keymap and `executable-font-lock-keywords' to the end of their own font
;; lock keywords. Their mode-setting commands should call
;; XEmacs change
(defgroup executable nil
"Base functionality for executable interpreter scripts"
;; This used to default to `other', but that doesn't seem to have any
;; significance. fx 2000-02-11.
(defcustom executable-insert t ; 'other
"*Non-nil means offer to add a magic number to a file.
This takes effect when you switch to certain major modes,
including Shell-script mode (`sh-mode').
When you type \\[executable-set-magic], it always offers to add or
update the magic number."
;;; :type '(choice (const :tag "off" nil)
;;; (const :tag "on" t)
(defcustom executable-query 'function
"*If non-nil, ask user before changing an existing magic number.
When this is `function', only ask when called non-interactively."
:type '(choice (const :tag "Don't Ask" nil)
(const :tag "Ask when non-interactive" function)
(other :tag "Ask" t))
(defcustom executable-magicless-file-regexp "/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$"
"*On files with this kind of name no magic is inserted or changed."
(defcustom executable-prefix "#! "
"*Interpreter magic number prefix inserted when there was no magic number."
(defcustom executable-chmod 73
"*After saving, if the file is not executable, set this mode.
This mode passed to `set-file-modes' is taken absolutely when negative, or
relative to the files existing modes. Do nothing if this is nil.
Typical values are 73 (+x) or -493 (rwxr-xr-x)."
:type '(choice integer
(defvar executable-command nil)
(defcustom executable-self-display "tail"
"*Command you use with argument `+2' to make text files self-display.
Note that the like of `more' doesn't work too well under Emacs \\[shell]."
'(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t))
"*Rules for highlighting executable scripts' magic number.
This can be included in `font-lock-keywords' by modes that call `executable'.")
'(;; /bin/xyz: syntax error at line 14: `(' unexpected
;; /bin/xyz: syntax error at line 8 : ``' unmatched
("^\\(.*[^[/]\\)\\(\\[[0-9]+\\]\\)?: .* error .* line \\([0-9]+\\)" 1 3)
;; /bin/xyz: ehco: not found
("^\\(.*[^/]\\)\\[\\([0-9]+\\)\\]: .*: " 1 2)
;; /bin/xyz: syntax error near unexpected token `)'
;; /bin/xyz: /bin/xyz: line 2: `)'
("^\\(.*[^/]\\): [^0-9\n]+\n\\1: \\1: line \\([0-9]+\\):" 1 2)
;; /usr/bin/awk: syntax error at line 5 of file /bin/xyz
(" error .* line \\([0-9]+\\) of file \\(.+\\)$" 2 1)
;; /usr/bin/awk: calling undefined function toto
;; input record number 3, file awktestdata
;; source line 4 of file /bin/xyz
("^[^ ].+\n\\( .+\n\\)* line \\([0-9]+\\) of file \\(.+\\)$" 3 2)
;; makefile:1: *** target pattern contains no `%'. Stop.
("^\\(.+\\):\\([0-9]+\\): " 1 2))
"Alist of regexps used to match script errors.
;; The C function openp slightly modified would do the trick fine
;; XEmacs change: added cygwin32
(if (memq system-type '(ms-dos windows-nt cygwin32))
;; .btm is for 4DOS and friends, <URL:http://www.jpsoft.com/>
'(".exe" ".com" ".bat" ".cmd" ".btm" "")
(defun executable-command-find-posix-p (&optional program)
"Check if PROGRAM handles arguments Posix-style.
If PROGRAM is non-nil, use that instead of \"find\"."
;; Pick file to search from location we know
(let* ((dir (file-truename data-directory))
(file (car (directory-files dir nil "^[^.]"))))
(call-process (or program "find")
(if (search-forward file nil t)
(defun executable-find (command)
"Search for COMMAND in `exec-path' and return the absolute file name.
Return nil if COMMAND is not found anywhere in `exec-path'."
(let ((list exec-path)
(if (and (setq file (expand-file-name command (car list)))
(let ((suffixes executable-binary-suffixes)
(setq candidate (concat file (car suffixes)))
(if (and (file-executable-p candidate)
(not (file-directory-p candidate)))
(setq suffixes nil)
(setq suffixes (cdr suffixes))
(setq candidate nil)))
(setq file candidate)))
(setq file nil)
(defun executable-chmod ()
"This gets called after saving a file to assure that it be executable.
You can set the absolute or relative mode in variable `executable-chmod' for
(or (file-executable-p buffer-file-name)
(if (< executable-chmod 0)
(defun executable-interpret (command)
"Run script with user-specified args, and collect output in a buffer.
While script runs asynchronously, you can use the \\[next-error]
command to find the next error. The buffer is also in `comint-mode' and
`compilation-shell-minor-mode', so that you can answer any prompts."
(interactive (list (read-string "Run script: "
(save-some-buffers (not compilation-ask-about-save))
(set (make-local-variable 'executable-command) command)
(let ((compilation-error-regexp-alist executable-error-regexp-alist))
(compile-internal command t (lambda (x) "*interpretation*"))))
(defun executable-set-magic (interpreter &optional argument
"Set this buffer's interpreter to INTERPRETER with optional ARGUMENT.
The variables `executable-magicless-file-regexp', `executable-prefix',
`executable-insert', `executable-query' and `executable-chmod' control
when and how magic numbers are inserted or replaced and scripts made
(let* ((name (read-string "Name or file name of interpreter: "))
(arg (read-string (format "Argument for %s: " name))))
(list name arg (eq executable-query 'function) t)))
(setq interpreter (if (file-name-absolute-p interpreter)
(or (executable-find interpreter)
(error "Interpreter %s not recognized"
(setq argument (concat (if (string-match "\\`/:" interpreter)
(replace-match "" nil nil interpreter)
(and argument (string< "" argument) " ")
(not (or insert-flag executable-insert))
(> (point-min) 1)
(add-hook 'after-save-hook 'executable-chmod nil t)
(if (looking-at "#![ \t]*\\(.*\\)$")
(and (goto-char (match-beginning 1))
;; If the line ends in a space,
;; don't offer to change it.
(not (= (char-after (1- (match-end 1))) ?\ ))
(not (string= argument
(buffer-substring (point) (match-end 1))))
(if (or (not executable-query) no-query-flag
;; Make buffer visible before question.
(y-or-n-p (concat "Replace magic number by `"
executable-prefix argument "'? "))))
(replace-match argument t t nil 1)
(message "Magic number changed to `%s'"
(concat executable-prefix argument)))))
(insert executable-prefix argument ?\n)
(message "Magic number changed to `%s'"
(concat executable-prefix argument)))))
(defun executable-self-display ()
"Turn a text file into a self-displaying Un*x command.
The magic number of such a command displays all lines but itself."
(if (eq this-command 'executable-self-display)
(setq this-command 'executable-set-magic))
(executable-set-magic executable-self-display "+2"))
(defun executable-make-buffer-file-executable-if-script-p ()
"Make file executable according to umask if not already executable.
If file already has any execute bits set at all, do not change existing
(and (>= (buffer-size) 2)
(string= "#!" (buffer-substring (point-min) (+ 2 (point-min)))))
(let* ((current-mode (file-modes (buffer-file-name)))
(add-mode (logand ?\111 (default-file-modes))))
(or (/= (logand ?\111 current-mode) 0)
(logior current-mode add-mode))))))
;;; executable.el ends here