Mercurial > emacs
annotate lisp/progmodes/executable.el @ 14111:787061ad42ba
(executable-find): Renamed from `executable'.
(executable-set-magic): Use new name `executable'. Fix messages.
Add save-excursion. Don't test this-command--use interactive
to get the information. Simplify considerably.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Tue, 09 Jan 1996 23:17:18 +0000 |
parents | 8a10a3485eef |
children | 83f275dcd93a |
rev | line source |
---|---|
12504 | 1 ;;; executable.el --- base functionality for executable interpreter scripts |
2 ;; Copyright (C) 1994, 1995 by Free Software Foundation, Inc. | |
3 | |
4 ;; Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389 | |
5 ;; Keywords: languages, unix | |
6 | |
7 ;; This file is part of GNU Emacs. | |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
11 ;; the Free Software Foundation; either version 2, or (at your option) | |
12 ;; any later version. | |
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 | |
20 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
22 | |
23 ;;; Commentary: | |
12818 | 24 |
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 | |
27 ;; have one. | |
28 | |
12817 | 29 ;; This is support code for the likes of sh-, awk-, perl-, tcl- or |
30 ;; makefile-mode. Those mode-setting commands can call the like of | |
31 ;; `(executable-set-magic "sh")' or `(executable-set-magic "perl" "-f")'. | |
32 ;; Unless the file name matches `executable-magicless-file-regexp' this will | |
33 ;; search $PATH if the given interpreter isn't absolute, and then insert a | |
12818 | 34 ;; first line like `#! /bin/sh' or `#! /usr/local/bin/perl -f'. |
35 ;; Also it makes the file executable as soon as it's saved, if it wasn't. | |
12812
39e721f1681f
(interpreter-mode-alist): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12504
diff
changeset
|
36 |
12504 | 37 ;;; Code: |
38 | |
39 (defvar executable-insert 'not-modified | |
40 "*What to do when newly found file has no or wrong magic number: | |
41 nil do nothing | |
42 t insert or update magic number | |
43 other insert or update magic number, but mark as unmodified. | |
44 When the insertion is marked as unmodified, you can save it with \\[write-file] RET. | |
45 This variable is used when `executable-set-magic' is called as a function, | |
46 e.g. when Emacs sets some Un*x interpreter script mode. | |
47 With \\[executable-set-magic], this is always treated as if it were `t'.") | |
48 | |
49 | |
50 (defvar executable-query 'function | |
51 "*If non-`nil', ask user before inserting or changing magic number. | |
52 When this is `function', only ask when called non-interactively.") | |
53 | |
54 | |
55 (defvar executable-magicless-file-regexp "/[Mm]akefile$\\|/\\.\\(z?profile\\|bash_profile\\|z?login\\|bash_login\\|z?logout\\|bash_logout\\|.+shrc\\|esrc\\|rcrc\\|[kz]shenv\\)$" | |
56 "*On files with this kind of name no magic is inserted or changed.") | |
57 | |
58 | |
59 (defvar executable-prefix "#! " | |
60 "*Interpreter magic number prefix inserted when there was no magic number.") | |
61 | |
62 | |
63 | |
64 (defvar executable-chmod 73 | |
65 "*After saving, if the file is not executable, set this mode. | |
66 This mode passed to `set-file-modes' is taken absolutely when negative, or | |
67 relative to the files existing modes. Do nothing if this is nil. | |
68 Typical values are 73 (+x) or -493 (rwxr-xr-x).") | |
69 | |
70 | |
71 (defvar executable-command nil) | |
72 | |
73 (defvar executable-self-display "tail" | |
74 "*Command you use with argument `+2' to make text files self-display. | |
75 Note that the like of `more' doesn't work too well under Emacs \\[shell].") | |
76 | |
77 | |
78 (defvar executable-font-lock-keywords | |
79 '(("\\`#!.*/\\([^ \t\n]+\\)" 1 font-lock-keyword-face t)) | |
80 "*Rules for highlighting executable scripts' magic number. | |
81 This can be included in `font-lock-keywords' by modes that call `executable'.") | |
82 | |
83 | |
84 (defvar executable-error-regexp-alist | |
85 '(;; /bin/xyz: syntax error at line 14: `(' unexpected | |
86 ;; /bin/xyz[5]: syntax error at line 8 : ``' unmatched | |
87 ("^\\(.*[^[/]\\)\\(\\[[0-9]+\\]\\)?: .* error .* line \\([0-9]+\\)" 1 3) | |
88 ;; /bin/xyz[27]: ehco: not found | |
89 ("^\\(.*[^/]\\)\\[\\([0-9]+\\)\\]: .*: " 1 2) | |
90 ;; /bin/xyz: syntax error near unexpected token `)' | |
91 ;; /bin/xyz: /bin/xyz: line 2: `)' | |
92 ("^\\(.*[^/]\\): [^0-9\n]+\n\\1: \\1: line \\([0-9]+\\):" 1 2) | |
93 ;; /usr/bin/awk: syntax error at line 5 of file /bin/xyz | |
94 (" error .* line \\([0-9]+\\) of file \\(.+\\)$" 2 1) | |
95 ;; /usr/bin/awk: calling undefined function toto | |
96 ;; input record number 3, file awktestdata | |
97 ;; source line 4 of file /bin/xyz | |
98 ("^[^ ].+\n\\( .+\n\\)* line \\([0-9]+\\) of file \\(.+\\)$" 3 2) | |
99 ;; makefile:1: *** target pattern contains no `%'. Stop. | |
100 ("^\\(.+\\):\\([0-9]+\\): " 1 2)) | |
101 "Alist of regexps used to match script errors. | |
102 See `compilation-error-regexp-alist'.") | |
103 | |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
104 ;; The C function openp slightly modified would do the trick fine |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
105 (defun executable-find (command) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
106 "Search for COMMAND in $PATH and return the absolute file name. |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
107 Return nil if COMMAND is not found anywhere in $PATH." |
12504 | 108 (let ((list exec-path) |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
109 file) |
12504 | 110 (while list |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
111 (setq list (if (and (setq file (expand-file-name command (car list))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
112 (file-executable-p file) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
113 (not (file-directory-p file))) |
12504 | 114 nil |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
115 (setq file nil) |
12504 | 116 (cdr list)))) |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
117 file)) |
12504 | 118 |
119 | |
120 (defun executable-chmod () | |
121 "This gets called after saving a file to assure that it be executable. | |
122 You can set the absolute or relative mode in variable `executable-chmod' for | |
123 non-executable files." | |
124 (and executable-chmod | |
125 buffer-file-name | |
126 (or (file-executable-p buffer-file-name) | |
127 (set-file-modes buffer-file-name | |
128 (if (< executable-chmod 0) | |
129 (- executable-chmod) | |
130 (logior executable-chmod | |
131 (file-modes buffer-file-name))))))) | |
132 | |
133 | |
134 (defun executable-interpret (command) | |
135 "Run script with user-specified args, and collect output in a buffer. | |
136 While script runs asynchronously, you can use the \\[next-error] command | |
137 to find the next error." | |
138 (interactive (list (read-string "Run script: " | |
139 (or executable-command | |
140 buffer-file-name)))) | |
141 (require 'compile) | |
142 (save-some-buffers (not compilation-ask-about-save)) | |
143 (make-local-variable 'executable-command) | |
144 (compile-internal (setq executable-command command) | |
145 "No more errors." "Interpretation" | |
146 ;; Give it a simpler regexp to match. | |
147 nil executable-error-regexp-alist)) | |
148 | |
149 | |
150 | |
151 ;;;###autoload | |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
152 (defun executable-set-magic (interpreter &optional argument |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
153 no-query-flag insert-flag) |
12504 | 154 "Set this buffer's interpreter to INTERPRETER with optional ARGUMENT. |
155 The variables `executable-magicless-file-regexp', `executable-prefix', | |
156 `executable-insert', `executable-query' and `executable-chmod' control | |
157 when and how magic numbers are inserted or replaced and scripts made | |
158 executable." | |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
159 (interactive |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
160 (let* ((name (read-string "Name or file name of interpreter: ")) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
161 (arg (read-string (format "Argument for %s: " name)))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
162 (list name arg (eq executable-query 'function) t))) |
12504 | 163 (setq interpreter (if (file-name-absolute-p interpreter) |
164 interpreter | |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
165 (or (executable-find interpreter) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
166 (error "Interpreter %s not recognized" interpreter))) |
12504 | 167 argument (concat interpreter |
168 (and argument (string< "" argument) " ") | |
169 argument)) | |
170 (or buffer-read-only | |
171 (if buffer-file-name | |
172 (string-match executable-magicless-file-regexp | |
173 buffer-file-name)) | |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
174 (not (or insert-flag executable-insert)) |
12504 | 175 (> (point-min) 1) |
14111
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
176 (save-excursion |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
177 (let ((point (point-marker)) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
178 (buffer-modified-p (buffer-modified-p))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
179 (goto-char (point-min)) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
180 (make-local-hook 'after-save-hook) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
181 (add-hook 'after-save-hook 'executable-chmod nil t) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
182 (if (looking-at "#![ \t]*\\(.*\\)$") |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
183 (and (goto-char (match-beginning 1)) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
184 (not (string= argument |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
185 (buffer-substring (point) (match-end 1)))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
186 (or (not executable-query) no-query-flag |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
187 (save-window-excursion |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
188 ;; Make buffer visible before question. |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
189 (switch-to-buffer (current-buffer)) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
190 (y-or-n-p (concat "Replace magic number by `" |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
191 executable-prefix argument "'? ")))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
192 (progn |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
193 (replace-match argument t t nil 1) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
194 (message "Magic number changed to `%s'" |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
195 (concat executable-prefix argument)))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
196 (insert executable-prefix argument ?\n) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
197 (message "Magic number changed to `%s'" |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
198 (concat executable-prefix argument))) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
199 (or insert-flag |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
200 (eq executable-insert t) |
787061ad42ba
(executable-find): Renamed from `executable'.
Karl Heuer <kwzh@gnu.org>
parents:
14024
diff
changeset
|
201 (set-buffer-modified-p buffer-modified-p))))) |
12504 | 202 interpreter) |
203 | |
204 | |
205 | |
206 ;;;###autoload | |
207 (defun executable-self-display () | |
208 "Turn a text file into a self-displaying Un*x command. | |
209 The magic number of such a command displays all lines but itself." | |
210 (interactive) | |
211 (if (eq this-command 'executable-self-display) | |
212 (setq this-command 'executable-set-magic)) | |
213 (executable-set-magic executable-self-display "+2")) | |
214 | |
215 | |
216 | |
217 (provide 'executable) | |
218 | |
219 ;; executable.el ends here |