Commit | Line | Data |
---|---|---|
513749ee | 1 | ;;; macroexp.el --- Additional macro-expansion support -*- lexical-binding: t; coding: utf-8 -*- |
4d449b11 | 2 | ;; |
acaf905b | 3 | ;; Copyright (C) 2004-2012 Free Software Foundation, Inc. |
4d449b11 MB |
4 | ;; |
5 | ;; Author: Miles Bader <miles@gnu.org> | |
6 | ;; Keywords: lisp, compiler, macros | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
d6cba7ae | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
4d449b11 | 11 | ;; it under the terms of the GNU General Public License as published by |
d6cba7ae GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
4d449b11 MB |
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 | |
d6cba7ae | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
4d449b11 MB |
22 | |
23 | ;;; Commentary: | |
24 | ;; | |
25 | ;; This file contains macro-expansions functions that are not defined in | |
26 | ;; the Lisp core, namely `macroexpand-all', which expands all macros in | |
27 | ;; a form, not just a top-level one. | |
28 | ;; | |
29 | ||
30 | ;;; Code: | |
31 | ||
32 | ;; Bound by the top-level `macroexpand-all', and modified to include any | |
33 | ;; macros defined by `defmacro'. | |
34 | (defvar macroexpand-all-environment nil) | |
35 | ||
fa779ab0 | 36 | (defun macroexp--cons (car cdr original-cons) |
4d449b11 MB |
37 | "Return (CAR . CDR), using ORIGINAL-CONS if possible." |
38 | (if (and (eq car (car original-cons)) (eq cdr (cdr original-cons))) | |
39 | original-cons | |
40 | (cons car cdr))) | |
41 | ||
42 | ;; We use this special macro to iteratively process forms and share list | |
43 | ;; structure of the result with the input. Doing so recursively using | |
fa779ab0 | 44 | ;; `macroexp--cons' results in excessively deep recursion for very long |
4d449b11 | 45 | ;; input forms. |
fa779ab0 | 46 | (defmacro macroexp--accumulate (var+list &rest body) |
4d449b11 MB |
47 | "Return a list of the results of evaluating BODY for each element of LIST. |
48 | Evaluate BODY with VAR bound to each `car' from LIST, in turn. | |
49 | Return a list of the values of the final form in BODY. | |
50 | The list structure of the result will share as much with LIST as | |
51 | possible (for instance, when BODY just returns VAR unchanged, the | |
5de35ba4 RS |
52 | result will be eq to LIST). |
53 | ||
54 | \(fn (VAR LIST) BODY...)" | |
6fe79b7c | 55 | (declare (indent 1)) |
5de35ba4 RS |
56 | (let ((var (car var+list)) |
57 | (list (cadr var+list)) | |
4d449b11 MB |
58 | (shared (make-symbol "shared")) |
59 | (unshared (make-symbol "unshared")) | |
60 | (tail (make-symbol "tail")) | |
61 | (new-el (make-symbol "new-el"))) | |
62 | `(let* ((,shared ,list) | |
63 | (,unshared nil) | |
64 | (,tail ,shared) | |
65 | ,var ,new-el) | |
61b108cc | 66 | (while (consp ,tail) |
4d449b11 MB |
67 | (setq ,var (car ,tail) |
68 | ,new-el (progn ,@body)) | |
69 | (unless (eq ,var ,new-el) | |
70 | (while (not (eq ,shared ,tail)) | |
71 | (push (pop ,shared) ,unshared)) | |
72 | (setq ,shared (cdr ,shared)) | |
73 | (push ,new-el ,unshared)) | |
74 | (setq ,tail (cdr ,tail))) | |
75 | (nconc (nreverse ,unshared) ,shared)))) | |
4d449b11 | 76 | |
fa779ab0 | 77 | (defun macroexp--all-forms (forms &optional skip) |
4d449b11 MB |
78 | "Return FORMS with macros expanded. FORMS is a list of forms. |
79 | If SKIP is non-nil, then don't expand that many elements at the start of | |
80 | FORMS." | |
fa779ab0 | 81 | (macroexp--accumulate (form forms) |
4d449b11 | 82 | (if (or (null skip) (zerop skip)) |
fa779ab0 | 83 | (macroexp--expand-all form) |
4d449b11 MB |
84 | (setq skip (1- skip)) |
85 | form))) | |
86 | ||
fa779ab0 | 87 | (defun macroexp--all-clauses (clauses &optional skip) |
4d449b11 MB |
88 | "Return CLAUSES with macros expanded. |
89 | CLAUSES is a list of lists of forms; any clause that's not a list is ignored. | |
90 | If SKIP is non-nil, then don't expand that many elements at the start of | |
91 | each clause." | |
fa779ab0 | 92 | (macroexp--accumulate (clause clauses) |
4d449b11 | 93 | (if (listp clause) |
fa779ab0 | 94 | (macroexp--all-forms clause skip) |
4d449b11 MB |
95 | clause))) |
96 | ||
f38ea36d SM |
97 | (defun macroexp--compiler-macro (handler form) |
98 | (condition-case err | |
99 | (apply handler form (cdr form)) | |
100 | (error (message "Compiler-macro error for %S: %S" (car form) err) | |
a64a94ed | 101 | form))) |
f38ea36d | 102 | |
fa779ab0 | 103 | (defun macroexp--expand-all (form) |
4d449b11 MB |
104 | "Expand all macros in FORM. |
105 | This is an internal version of `macroexpand-all'. | |
106 | Assumes the caller has bound `macroexpand-all-environment'." | |
107 | (if (and (listp form) (eq (car form) 'backquote-list*)) | |
108 | ;; Special-case `backquote-list*', as it is normally a macro that | |
109 | ;; generates exceedingly deep expansions from relatively shallow input | |
110 | ;; forms. We just process it `in reverse' -- first we expand all the | |
111 | ;; arguments, _then_ we expand the top-level definition. | |
fa779ab0 | 112 | (macroexpand (macroexp--all-forms form 1) |
4d449b11 MB |
113 | macroexpand-all-environment) |
114 | ;; Normal form; get its expansion, and then expand arguments. | |
a9de04fa SM |
115 | (let ((new-form (macroexpand form macroexpand-all-environment))) |
116 | (when (and (not (eq form new-form)) ;It was a macro call. | |
117 | (car-safe form) | |
118 | (symbolp (car form)) | |
119 | (get (car form) 'byte-obsolete-info) | |
120 | (fboundp 'byte-compile-warn-obsolete)) | |
121 | (byte-compile-warn-obsolete (car form))) | |
122 | (setq form new-form)) | |
6fe79b7c SM |
123 | (pcase form |
124 | (`(cond . ,clauses) | |
fa779ab0 | 125 | (macroexp--cons 'cond (macroexp--all-clauses clauses) form)) |
6fe79b7c | 126 | (`(condition-case . ,(or `(,err ,body . ,handlers) dontcare)) |
fa779ab0 | 127 | (macroexp--cons |
6fe79b7c | 128 | 'condition-case |
fa779ab0 SM |
129 | (macroexp--cons err |
130 | (macroexp--cons (macroexp--expand-all body) | |
131 | (macroexp--all-clauses handlers 1) | |
6fe79b7c SM |
132 | (cddr form)) |
133 | (cdr form)) | |
134 | form)) | |
fa779ab0 | 135 | (`(,(or `defvar `defconst) . ,_) (macroexp--all-forms form 2)) |
6fe79b7c | 136 | (`(function ,(and f `(lambda . ,_))) |
fa779ab0 SM |
137 | (macroexp--cons 'function |
138 | (macroexp--cons (macroexp--all-forms f 2) | |
6fe79b7c SM |
139 | nil |
140 | (cdr form)) | |
141 | form)) | |
142 | (`(,(or `function `quote) . ,_) form) | |
143 | (`(,(and fun (or `let `let*)) . ,(or `(,bindings . ,body) dontcare)) | |
fa779ab0 SM |
144 | (macroexp--cons fun |
145 | (macroexp--cons (macroexp--all-clauses bindings 1) | |
146 | (macroexp--all-forms body) | |
6fe79b7c SM |
147 | (cdr form)) |
148 | form)) | |
149 | (`(,(and fun `(lambda . ,_)) . ,args) | |
150 | ;; Embedded lambda in function position. | |
fa779ab0 SM |
151 | (macroexp--cons (macroexp--all-forms fun 2) |
152 | (macroexp--all-forms args) | |
6fe79b7c SM |
153 | form)) |
154 | ;; The following few cases are for normal function calls that | |
155 | ;; are known to funcall one of their arguments. The byte | |
156 | ;; compiler has traditionally handled these functions specially | |
157 | ;; by treating a lambda expression quoted by `quote' as if it | |
158 | ;; were quoted by `function'. We make the same transformation | |
159 | ;; here, so that any code that cares about the difference will | |
160 | ;; see the same transformation. | |
161 | ;; First arg is a function: | |
9c848d8a | 162 | (`(,(and fun (or `funcall `apply `mapcar `mapatoms `mapconcat `mapc)) |
876c194c | 163 | ',(and f `(lambda . ,_)) . ,args) |
9c848d8a SM |
164 | (byte-compile-log-warning |
165 | (format "%s quoted with ' rather than with #'" | |
166 | (list 'lambda (nth 1 f) '...)) | |
167 | t) | |
fa779ab0 | 168 | ;; We don't use `macroexp--cons' since there's clearly a change. |
6fe79b7c | 169 | (cons fun |
fa779ab0 SM |
170 | (cons (macroexp--expand-all (list 'function f)) |
171 | (macroexp--all-forms args)))) | |
6fe79b7c | 172 | ;; Second arg is a function: |
876c194c | 173 | (`(,(and fun (or `sort)) ,arg1 ',(and f `(lambda . ,_)) . ,args) |
9c848d8a SM |
174 | (byte-compile-log-warning |
175 | (format "%s quoted with ' rather than with #'" | |
176 | (list 'lambda (nth 1 f) '...)) | |
177 | t) | |
fa779ab0 | 178 | ;; We don't use `macroexp--cons' since there's clearly a change. |
6fe79b7c | 179 | (cons fun |
fa779ab0 SM |
180 | (cons (macroexp--expand-all arg1) |
181 | (cons (macroexp--expand-all | |
6fe79b7c | 182 | (list 'function f)) |
fa779ab0 | 183 | (macroexp--all-forms args))))) |
57a7d507 SM |
184 | (`(,func . ,_) |
185 | ;; Macro expand compiler macros. This cannot be delayed to | |
186 | ;; byte-optimize-form because the output of the compiler-macro can | |
187 | ;; use macros. | |
188 | (let ((handler nil)) | |
189 | (while (and (symbolp func) | |
190 | (not (setq handler (get func 'compiler-macro))) | |
d9857e53 | 191 | (fboundp func)) |
57a7d507 SM |
192 | ;; Follow the sequence of aliases. |
193 | (setq func (symbol-function func))) | |
194 | (if (null handler) | |
195 | ;; No compiler macro. We just expand each argument (for | |
196 | ;; setq/setq-default this works alright because the variable names | |
197 | ;; are symbols). | |
fa779ab0 | 198 | (macroexp--all-forms form 1) |
d9857e53 SM |
199 | ;; If the handler is not loaded yet, try (auto)loading the |
200 | ;; function itself, which may in turn load the handler. | |
201 | (when (and (not (functionp handler)) | |
202 | (fboundp func) (eq (car-safe (symbol-function func)) | |
203 | 'autoload)) | |
204 | (ignore-errors | |
205 | (load (nth 1 (symbol-function func)) | |
206 | 'noerror 'nomsg))) | |
f38ea36d | 207 | (let ((newform (macroexp--compiler-macro handler form))) |
57a7d507 SM |
208 | (if (eq form newform) |
209 | ;; The compiler macro did not find anything to do. | |
fa779ab0 | 210 | (if (equal form (setq newform (macroexp--all-forms form 1))) |
57a7d507 SM |
211 | form |
212 | ;; Maybe after processing the args, some new opportunities | |
213 | ;; appeared, so let's try the compiler macro again. | |
f38ea36d | 214 | (setq form (macroexp--compiler-macro handler newform)) |
53aacf21 | 215 | (if (eq newform form) |
57a7d507 | 216 | newform |
fa779ab0 SM |
217 | (macroexp--expand-all newform))) |
218 | (macroexp--expand-all newform)))))) | |
57a7d507 | 219 | |
6fe79b7c | 220 | (t form)))) |
4d449b11 MB |
221 | |
222 | ;;;###autoload | |
223 | (defun macroexpand-all (form &optional environment) | |
224 | "Return result of expanding macros at all levels in FORM. | |
225 | If no macros are expanded, FORM is returned unchanged. | |
226 | The second optional arg ENVIRONMENT specifies an environment of macro | |
227 | definitions to shadow the loaded ones for use in file byte-compilation." | |
228 | (let ((macroexpand-all-environment environment)) | |
fa779ab0 | 229 | (macroexp--expand-all form))) |
4d449b11 | 230 | |
4dd1c416 SM |
231 | ;;; Handy functions to use in macros. |
232 | ||
233 | (defun macroexp-progn (exps) | |
234 | "Return an expression equivalent to `(progn ,@EXPS)." | |
235 | (if (cdr exps) `(progn ,@exps) (car exps))) | |
236 | ||
de7e2b36 SM |
237 | (defun macroexp-unprogn (exp) |
238 | "Turn EXP into a list of expressions to execute in sequence." | |
239 | (if (eq (car-safe exp) 'progn) (cdr exp) (list exp))) | |
240 | ||
4dd1c416 SM |
241 | (defun macroexp-let* (bindings exp) |
242 | "Return an expression equivalent to `(let* ,bindings ,exp)." | |
243 | (cond | |
244 | ((null bindings) exp) | |
245 | ((eq 'let* (car-safe exp)) `(let* (,@bindings ,@(cadr exp)) ,@(cddr exp))) | |
246 | (t `(let* ,bindings ,exp)))) | |
247 | ||
248 | (defun macroexp-if (test then else) | |
249 | "Return an expression equivalent to `(if ,test ,then ,else)." | |
250 | (cond | |
251 | ((eq (car-safe else) 'if) | |
252 | (if (equal test (nth 1 else)) | |
253 | ;; Doing a test a second time: get rid of the redundancy. | |
254 | `(if ,test ,then ,@(nthcdr 3 else)) | |
255 | `(cond (,test ,then) | |
256 | (,(nth 1 else) ,(nth 2 else)) | |
257 | (t ,@(nthcdr 3 else))))) | |
258 | ((eq (car-safe else) 'cond) | |
259 | `(cond (,test ,then) | |
260 | ;; Doing a test a second time: get rid of the redundancy, as above. | |
261 | ,@(remove (assoc test else) (cdr else)))) | |
262 | ;; Invert the test if that lets us reduce the depth of the tree. | |
263 | ((memq (car-safe then) '(if cond)) (macroexp-if `(not ,test) else then)) | |
264 | (t `(if ,test ,then ,else)))) | |
265 | ||
2ee3d7f0 | 266 | (defmacro macroexp-let2 (test var exp &rest exps) |
4dd1c416 SM |
267 | "Bind VAR to a copyable expression that returns the value of EXP. |
268 | This is like `(let ((v ,EXP)) ,EXPS) except that `v' is a new generated | |
269 | symbol which EXPS can find in VAR. | |
270 | TEST should be the name of a predicate on EXP checking whether the `let' can | |
271 | be skipped; if nil, as is usual, `macroexp-const-p' is used." | |
272 | (declare (indent 3) (debug (sexp form sexp body))) | |
273 | (let ((bodysym (make-symbol "body")) | |
274 | (expsym (make-symbol "exp"))) | |
275 | `(let* ((,expsym ,exp) | |
276 | (,var (if (,(or test #'macroexp-const-p) ,expsym) | |
277 | ,expsym (make-symbol "x"))) | |
278 | (,bodysym ,(macroexp-progn exps))) | |
279 | (if (eq ,var ,expsym) ,bodysym | |
280 | (macroexp-let* (list (list ,var ,expsym)) | |
281 | ,bodysym))))) | |
282 | ||
2ee3d7f0 SM |
283 | (defun macroexp--maxsize (exp size) |
284 | (cond ((< size 0) size) | |
285 | ((symbolp exp) (1- size)) | |
286 | ((stringp exp) (- size (/ (length exp) 16))) | |
287 | ((vectorp exp) | |
288 | (dotimes (i (length exp)) | |
289 | (setq size (macroexp--maxsize (aref exp i) size))) | |
290 | (1- size)) | |
291 | ((consp exp) | |
292 | ;; We could try to be more clever with quote&function, | |
293 | ;; but it is difficult to do so correctly, and it's not obvious that | |
294 | ;; it would be worth the effort. | |
295 | (dolist (e exp) | |
296 | (setq size (macroexp--maxsize e size))) | |
297 | (1- size)) | |
298 | (t -1))) | |
299 | ||
300 | (defun macroexp-small-p (exp) | |
301 | "Return non-nil if EXP can be considered small." | |
302 | (> (macroexp--maxsize exp 10) 0)) | |
303 | ||
4dd1c416 SM |
304 | (defsubst macroexp--const-symbol-p (symbol &optional any-value) |
305 | "Non-nil if SYMBOL is constant. | |
306 | If ANY-VALUE is nil, only return non-nil if the value of the symbol is the | |
307 | symbol itself." | |
308 | (or (memq symbol '(nil t)) | |
309 | (keywordp symbol) | |
310 | (if any-value | |
311 | (or (memq symbol byte-compile-const-variables) | |
312 | ;; FIXME: We should provide a less intrusive way to find out | |
313 | ;; if a variable is "constant". | |
314 | (and (boundp symbol) | |
315 | (condition-case nil | |
316 | (progn (set symbol (symbol-value symbol)) nil) | |
317 | (setting-constant t))))))) | |
318 | ||
319 | (defun macroexp-const-p (exp) | |
320 | "Return non-nil if EXP will always evaluate to the same value." | |
321 | (cond ((consp exp) (or (eq (car exp) 'quote) | |
322 | (and (eq (car exp) 'function) | |
323 | (symbolp (cadr exp))))) | |
324 | ;; It would sometimes make sense to pass `any-value', but it's not | |
325 | ;; always safe since a "constant" variable may not actually always have | |
326 | ;; the same value. | |
327 | ((symbolp exp) (macroexp--const-symbol-p exp)) | |
328 | (t t))) | |
329 | ||
330 | (defun macroexp-copyable-p (exp) | |
331 | "Return non-nil if EXP can be copied without extra cost." | |
332 | (or (symbolp exp) (macroexp-const-p exp))) | |
333 | ||
4d449b11 MB |
334 | (provide 'macroexp) |
335 | ||
4d449b11 | 336 | ;;; macroexp.el ends here |