code.delx.au - gnu-emacs/blob - lisp/progmodes/executable.el

   1 ;;; executable.el --- base functionality for executable interpreter scripts
   2
   3 ;; Copyright (C) 1994, 1995, 1996 by Free Software Foundation, Inc.
   4
   5 ;; Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389
   6 ;; Keywords: languages, unix
   7
   8 ;; This file is part of GNU Emacs.
   9
  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 2, or (at your option)
  13 ;; any later version.
  14
  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.
  19
  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., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; executable.el is used by certain major modes to insert a suitable
  28 ;; #! line at the beginning of the file, if the file does not already
  29 ;; have one.
  30
  31 ;; Unless it has a magic number, a Unix file with executable mode is passed to
  32 ;; a new instance of the running shell (or to a Bourne shell if a csh is
  33 ;; running and the file starts with `:').  Only a shell can start such a file,
  34 ;; exec() cannot, which is why it is important to have a magic number in every
  35 ;; executable script.  Such a magic number is made up by the characters `#!'
  36 ;; the filename of an interpreter (in COFF, ELF or somesuch format) and one
  37 ;; optional argument.
  38
  39 ;; This library is for certain major modes like sh-, awk-, perl-, tcl- or
  40 ;; makefile-mode to insert or update a suitable #! line at the beginning of
  41 ;; the file, if the file does not already have one and the file is not a
  42 ;; default file of that interpreter (like .profile or makefile).  It also
  43 ;; makes the file executable if it wasn't, as soon as it's saved.
  44
  45 ;; It also allows debugging scripts, with an adaptation of compile, as far
  46 ;; as interpreters give out meaningful error messages.
  47
  48 ;; Modes that use this should nconc `executable-map' to the end of their own
  49 ;; keymap and `executable-font-lock-keywords' to the end of their own font
  50 ;; lock keywords.  Their mode-setting commands should call
  51 ;; `executable-set-magic'.
  52
  53 ;;; Code:
  54
  55 (defvar executable-insert 'not-modified
  56   "*What to do when newly found file has no or wrong magic number:
  57         nil     do nothing
  58         t       insert or update magic number
  59         other   insert or update magic number, but mark as unmodified.
  60 When the insertion is marked as unmodified, you can save it with  \\[write-file] RET.
  61 This variable is used when `executable-set-magic' is called as a function,
  62 e.g. when Emacs sets some Un*x interpreter script mode.
  63 With \\[executable-set-magic], this is always treated as if it were `t'.")
  64
  65
  66 (defvar executable-query 'function
  67   "*If non-`nil', ask user before inserting or changing magic number.
  68 When this is `function', only ask when called non-interactively.")
  69
  70
  71 (defvar executable-magicless-file-regexp "/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$"
  72   "*On files with this kind of name no magic is inserted or changed.")
  73
  74
  75 (defvar executable-prefix "#! "
  76   "*Interpreter magic number prefix inserted when there was no magic number.")
  77
  78
  79
  80 (defvar executable-chmod 73
  81   "*After saving, if the file is not executable, set this mode.
  82 This mode passed to `set-file-modes' is taken absolutely when negative, or
  83 relative to the files existing modes.  Do nothing if this is nil.
  84 Typical values are 73 (+x) or -493 (rwxr-xr-x).")
  85
  86
  87 (defvar executable-command nil)
  88
  89 (defvar executable-self-display "tail"
  90   "*Command you use with argument `+2' to make text files self-display.
  91 Note that the like of `more' doesn't work too well under Emacs  \\[shell].")
  92
  93
  94 (defvar executable-font-lock-keywords
  95   '(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t))
  96   "*Rules for highlighting executable scripts' magic number.
  97 This can be included in `font-lock-keywords' by modes that call `executable'.")
  98
  99
 100 (defvar executable-error-regexp-alist
 101   '(;; /bin/xyz: syntax error at line 14: `(' unexpected
 102     ;; /bin/xyz[5]: syntax error at line 8 : ``' unmatched
 103     ("^\\(.*[^[/]\\)\\(\\[[0-9]+\\]\\)?: .* error .* line \\([0-9]+\\)" 1 3)
 104     ;; /bin/xyz[27]: ehco:  not found
 105     ("^\\(.*[^/]\\)\\[\\([0-9]+\\)\\]: .*: " 1 2)
 106     ;; /bin/xyz: syntax error near unexpected token `)'
 107     ;; /bin/xyz: /bin/xyz: line 2: `)'
 108     ("^\\(.*[^/]\\): [^0-9\n]+\n\\1: \\1: line \\([0-9]+\\):" 1 2)
 109     ;; /usr/bin/awk: syntax error at line 5 of file /bin/xyz
 110     (" error .* line \\([0-9]+\\) of file \\(.+\\)$" 2 1)
 111     ;; /usr/bin/awk: calling undefined function toto
 112     ;;  input record number 3, file awktestdata
 113     ;;  source line 4 of file /bin/xyz
 114     ("^[^ ].+\n\\( .+\n\\)* line \\([0-9]+\\) of file \\(.+\\)$" 3 2)
 115     ;; makefile:1: *** target pattern contains no `%'.  Stop.
 116     ("^\\(.+\\):\\([0-9]+\\): " 1 2))
 117   "Alist of regexps used to match script errors.
 118 See `compilation-error-regexp-alist'.")
 119
 120 ;; The C function openp slightly modified would do the trick fine
 121 (defun executable-find (command)
 122   "Search for COMMAND in $PATH and return the absolute file name.
 123 Return nil if COMMAND is not found anywhere in $PATH."
 124   (let ((list exec-path)
 125         file)
 126     (while list
 127       (setq list (if (and (setq file (expand-file-name command (car list)))
 128                           (file-executable-p file)
 129                           (not (file-directory-p file)))
 130                      nil
 131                    (setq file nil)
 132                    (cdr list))))
 133     file))
 134
 135
 136 (defun executable-chmod ()
 137   "This gets called after saving a file to assure that it be executable.
 138 You can set the absolute or relative mode in variable `executable-chmod' for
 139 non-executable files."
 140   (and executable-chmod
 141        buffer-file-name
 142        (or (file-executable-p buffer-file-name)
 143            (set-file-modes buffer-file-name
 144                            (if (< executable-chmod 0)
 145                                (- executable-chmod)
 146                              (logior executable-chmod
 147                                      (file-modes buffer-file-name)))))))
 148
 149
 150 (defun executable-interpret (command)
 151   "Run script with user-specified args, and collect output in a buffer.
 152 While script runs asynchronously, you can use the \\[next-error] command
 153 to find the next error."
 154   (interactive (list (read-string "Run script: "
 155                                   (or executable-command
 156                                       buffer-file-name))))
 157   (require 'compile)
 158   (save-some-buffers (not compilation-ask-about-save))
 159   (make-local-variable 'executable-command)
 160   (compile-internal (setq executable-command command)
 161                     "No more errors." "Interpretation"
 162                     ;; Give it a simpler regexp to match.
 163                     nil executable-error-regexp-alist))
 164
 165
 166
 167 ;;;###autoload
 168 (defun executable-set-magic (interpreter &optional argument
 169                                          no-query-flag insert-flag)
 170   "Set this buffer's interpreter to INTERPRETER with optional ARGUMENT.
 171 The variables `executable-magicless-file-regexp', `executable-prefix',
 172 `executable-insert', `executable-query' and `executable-chmod' control
 173 when and how magic numbers are inserted or replaced and scripts made
 174 executable."
 175   (interactive
 176    (let* ((name (read-string "Name or file name of interpreter: "))
 177           (arg (read-string (format "Argument for %s: " name))))
 178      (list name arg (eq executable-query 'function) t)))
 179   (setq interpreter (if (file-name-absolute-p interpreter)
 180                         interpreter
 181                       (or (executable-find interpreter)
 182                           (error "Interpreter %s not recognized" interpreter)))
 183         argument (concat interpreter
 184                          (and argument (string< "" argument) " ")
 185                          argument))
 186   (or buffer-read-only
 187       (if buffer-file-name
 188           (string-match executable-magicless-file-regexp
 189                         buffer-file-name))
 190       (not (or insert-flag executable-insert))
 191       (> (point-min) 1)
 192       (save-excursion
 193         (let ((point (point-marker))
 194               (buffer-modified-p (buffer-modified-p)))
 195           (goto-char (point-min))
 196           (make-local-hook 'after-save-hook)
 197           (add-hook 'after-save-hook 'executable-chmod nil t)
 198           (if (looking-at "#![ \t]*\\(.*\\)$")
 199               (and (goto-char (match-beginning 1))
 200                    (not (string= argument
 201                                  (buffer-substring (point) (match-end 1))))
 202                    (or (not executable-query) no-query-flag
 203                        (save-window-excursion
 204                          ;; Make buffer visible before question.
 205                          (switch-to-buffer (current-buffer))
 206                          (y-or-n-p (concat "Replace magic number by `"
 207                                            executable-prefix argument "'? "))))
 208                    (progn
 209                      (replace-match argument t t nil 1)
 210                      (message "Magic number changed to `%s'"
 211                               (concat executable-prefix argument))))
 212             (insert executable-prefix argument ?\n)
 213             (message "Magic number changed to `%s'"
 214                      (concat executable-prefix argument)))
 215           (or insert-flag
 216               (eq executable-insert t)
 217               (set-buffer-modified-p buffer-modified-p)))))
 218   interpreter)
 219
 220
 221
 222 ;;;###autoload
 223 (defun executable-self-display ()
 224   "Turn a text file into a self-displaying Un*x command.
 225 The magic number of such a command displays all lines but itself."
 226   (interactive)
 227   (if (eq this-command 'executable-self-display)
 228       (setq this-command 'executable-set-magic))
 229   (executable-set-magic executable-self-display "+2"))
 230
 231
 232
 233 (provide 'executable)
 234
 235 ;; executable.el ends here