1 ;;; byte-run.el --- byte-compiler support for inlining -*- lexical-binding: t -*-
3 ;; Copyright (C) 1992, 2001-2014 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski <jwz@lucid.com>
6 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
7 ;; Maintainer: emacs-devel@gnu.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; interface to selectively inlining functions.
29 ;; This only happens when source-code optimization is turned on.
33 (defalias 'function-put
34 ;; We don't want people to just use `put' because we can't conveniently
35 ;; hook into `put' to remap old properties to new ones. But for now, there's
36 ;; no such remapping, so we just call `put'.
37 #'(lambda (f prop value
) (put f prop value
))
38 "Set function F's property PROP to VALUE.
39 The namespace for PROP is shared with symbols.
40 So far, F can only be a symbol, not a lambda expression.")
41 (function-put 'defmacro
'doc-string-elt
3)
42 (function-put 'defmacro
'lisp-indent-function
2)
44 ;; `macro-declaration-function' are both obsolete (as marked at the end of this
45 ;; file) but used in many .elc files.
47 (defvar macro-declaration-function
#'macro-declaration-function
48 "Function to process declarations in a macro definition.
49 The function will be called with two args MACRO and DECL.
50 MACRO is the name of the macro being defined.
51 DECL is a list `(declare ...)' containing the declarations.
52 The value the function returns is not used.")
54 (defalias 'macro-declaration-function
55 #'(lambda (macro decl
)
56 "Process a declaration found in a macro definition.
57 This is set as the value of the variable `macro-declaration-function'.
58 MACRO is the name of the macro being defined.
59 DECL is a list `(declare ...)' containing the declarations.
60 The return value of this function is not used."
61 ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons.
63 ;; Ignore the first element of `decl' (it's always `declare').
64 (while (setq decl
(cdr decl
))
69 (cond ((eq (car d
) 'indent
)
70 (put macro
'lisp-indent-function
(car (cdr d
))))
72 (put macro
'edebug-form-spec
(car (cdr d
))))
73 ((eq (car d
) 'doc-string
)
74 (put macro
'doc-string-elt
(car (cdr d
))))
76 (message "Unknown declaration %s" d
)))
77 (message "Invalid declaration %s" d
))))))
79 ;; We define macro-declaration-alist here because it is needed to
80 ;; handle declarations in macro definitions and this is the first file
81 ;; loaded by loadup.el that uses declarations in macros.
83 ;; Add any new entries to info node `(elisp)Declare Form'.
85 (defvar defun-declarations-alist
87 ;; We can only use backquotes inside the lambdas and not for those
88 ;; properties that are used by functions loaded before backquote.el.
89 (list 'advertised-calling-convention
90 #'(lambda (f _args arglist when
)
91 (list 'set-advertised-calling-convention
92 (list 'quote f
) (list 'quote arglist
) (list 'quote when
))))
94 #'(lambda (f _args new-name when
)
96 (list 'quote f
) (list 'quote new-name
) (list 'quote when
))))
97 (list 'interactive-only
98 #'(lambda (f _args instead
)
99 (list 'function-put
(list 'quote f
)
100 ''interactive-only
(list 'quote instead
))))
101 ;; FIXME: Merge `pure' and `side-effect-free'.
103 #'(lambda (f _args val
)
104 (list 'function-put
(list 'quote f
)
105 ''pure
(list 'quote val
)))
106 "If non-nil, the compiler can replace calls with their return value.
107 This may shift errors from run-time to compile-time.")
108 (list 'side-effect-free
109 #'(lambda (f _args val
)
110 (list 'function-put
(list 'quote f
)
111 ''side-effect-free
(list 'quote val
)))
112 "If non-nil, calls can be ignored if their value is unused.
113 If `error-free', drop calls even if `byte-compile-delete-errors' is nil.")
114 (list 'compiler-macro
115 #'(lambda (f args compiler-function
)
117 (function-put ',f
'compiler-macro
118 ,(if (eq (car-safe compiler-function
) 'lambda
)
119 `(lambda ,(append (cadr compiler-function
) args
)
120 ,@(cddr compiler-function
))
121 `#',compiler-function
)))))
123 #'(lambda (f _args pos
)
124 (list 'function-put
(list 'quote f
)
125 ''doc-string-elt
(list 'quote pos
))))
127 #'(lambda (f _args val
)
128 (list 'function-put
(list 'quote f
)
129 ''lisp-indent-function
(list 'quote val
)))))
130 "List associating function properties to their macro expansion.
131 Each element of the list takes the form (PROP FUN) where FUN is
132 a function. For each (PROP . VALUES) in a function's declaration,
133 the FUN corresponding to PROP is called with the function name,
134 the function's arglist, and the VALUES and should return the code to use
135 to set this property.
137 This is used by `declare'.")
139 (defvar macro-declarations-alist
142 #'(lambda (name _args spec
)
143 (list 'progn
:autoload-end
144 (list 'put
(list 'quote name
)
145 ''edebug-form-spec
(list 'quote spec
)))))
146 defun-declarations-alist
)
147 "List associating properties of macros to their macro expansion.
148 Each element of the list takes the form (PROP FUN) where FUN is a function.
149 For each (PROP . VALUES) in a macro's declaration, the FUN corresponding
150 to PROP is called with the macro name, the macro's arglist, and the VALUES
151 and should return the code to use to set this property.
153 This is used by `declare'."))
158 #'(lambda (name arglist
&optional docstring
&rest body
)
159 "Define NAME as a macro.
160 When the macro is called, as in (NAME ARGS...),
161 the function (lambda ARGLIST BODY...) is applied to
162 the list ARGS... as it appears in the expression,
163 and the result should be a form to be evaluated instead of the original.
164 DECL is a declaration, optional, of the form (declare DECLS...) where
165 DECLS is a list of elements of the form (PROP . VALUES). These are
166 interpreted according to `macro-declarations-alist'.
167 The return value is undefined.
169 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
170 ;; We can't just have `decl' as an &optional argument, because we need
172 ;; (defmacro foo (arg) (bar) nil)
174 ;; (defmacro foo (arg) (bar)).
176 ((eq (car-safe docstring
) 'declare
)
177 (prog1 (cdr docstring
) (setq docstring nil
)))
178 ((and (stringp docstring
)
179 (eq (car-safe (car body
)) 'declare
))
180 (prog1 (cdr (car body
)) (setq body
(cdr body
)))))))
181 (if docstring
(setq body
(cons docstring body
))
182 (if (null body
) (setq body
'(nil))))
183 ;; Can't use backquote because it's not defined yet!
184 (let* ((fun (list 'function
(cons 'lambda
(cons arglist body
))))
187 (list 'cons
''macro fun
)))
191 (let ((f (cdr (assq (car x
) macro-declarations-alist
))))
192 (if f
(apply (car f
) name arglist
(cdr x
))
193 (message "Warning: Unknown macro property %S in %S"
197 (cons 'prog1
(cons def declarations
))
200 ;; Now that we defined defmacro we can use it!
201 (defmacro defun
(name arglist
&optional docstring
&rest body
)
202 "Define NAME as a function.
203 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
204 See also the function `interactive'.
205 DECL is a declaration, optional, of the form (declare DECLS...) where
206 DECLS is a list of elements of the form (PROP . VALUES). These are
207 interpreted according to `defun-declarations-alist'.
208 The return value is undefined.
210 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
211 ;; We can't just have `decl' as an &optional argument, because we need
213 ;; (defun foo (arg) (toto) nil)
215 ;; (defun foo (arg) (toto)).
216 (declare (doc-string 3) (indent 2))
218 ((eq (car-safe docstring
) 'declare
)
219 (prog1 (cdr docstring
) (setq docstring nil
)))
220 ((and (stringp docstring
)
221 (eq (car-safe (car body
)) 'declare
))
222 (prog1 (cdr (car body
)) (setq body
(cdr body
)))))))
223 (if docstring
(setq body
(cons docstring body
))
224 (if (null body
) (setq body
'(nil))))
228 (let ((f (cdr (assq (car x
) defun-declarations-alist
))))
230 (f (apply (car f
) name arglist
(cdr x
)))
233 (memq (car x
) ;C.f. cl-do-proclaim.
234 '(special inline notinline optimize warn
)))
235 (setq body
(cons (list 'declare x
) body
))
237 (t (message "Warning: Unknown defun property `%S' in %S"
244 (cons arglist body
))))))
247 (cons 'prog1
(cons def declarations
))
250 (list '@ '(guile) 'set-procedure-property
!)
251 (list 'symbol-function
(list 'quote name
))
253 (list 'quote name
))))))
255 ;; Redefined in byte-optimize.el.
256 ;; This is not documented--it's not clear that we should promote it.
258 (defmacro inline
(&rest body
)
261 ;;; Interface to inline functions.
263 ;; (defmacro proclaim-inline (&rest fns)
264 ;; "Cause the named functions to be open-coded when called from compiled code.
265 ;; They will only be compiled open-coded when byte-compile-optimize is true."
266 ;; (cons 'eval-and-compile
267 ;; (mapcar (lambda (x)
268 ;; (or (memq (get x 'byte-optimizer)
269 ;; '(nil byte-compile-inline-expand))
271 ;; "%s already has a byte-optimizer, can't make it inline"
273 ;; (list 'put (list 'quote x)
274 ;; ''byte-optimizer ''byte-compile-inline-expand))
277 ;; (defmacro proclaim-notinline (&rest fns)
278 ;; "Cause the named functions to no longer be open-coded."
279 ;; (cons 'eval-and-compile
280 ;; (mapcar (lambda (x)
281 ;; (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand)
282 ;; (put x 'byte-optimizer nil))
283 ;; (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer)
284 ;; ''byte-compile-inline-expand)
285 ;; (list 'put x ''byte-optimizer nil)))
288 (defmacro defsubst
(name arglist
&rest body
)
289 "Define an inline function. The syntax is just like that of `defun'.
290 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
291 (declare (debug defun
) (doc-string 3))
292 (or (memq (get name
'byte-optimizer
)
293 '(nil byte-compile-inline-expand
))
294 (error "`%s' is a primitive" name
))
296 (defun ,name
,arglist
,@body
)
298 (put ',name
'byte-optimizer
'byte-compile-inline-expand
))))
300 (defvar advertised-signature-table
(make-hash-table :test
'eq
:weakness
'key
))
302 (defun set-advertised-calling-convention (function signature _when
)
303 "Set the advertised SIGNATURE of FUNCTION.
304 This will allow the byte-compiler to warn the programmer when she uses
305 an obsolete calling convention. WHEN specifies since when the calling
306 convention was modified."
307 (puthash (indirect-function function
) signature
308 advertised-signature-table
))
310 (defun make-obsolete (obsolete-name current-name
&optional when
)
311 "Make the byte-compiler warn that function OBSOLETE-NAME is obsolete.
312 OBSOLETE-NAME should be a function name or macro name (a symbol).
314 The warning will say that CURRENT-NAME should be used instead.
315 If CURRENT-NAME is a string, that is the `use instead' message
316 \(it should end with a period, and not start with a capital).
317 WHEN should be a string indicating when the function
318 was first made obsolete, for example a date or a release number."
319 (declare (advertised-calling-convention
320 ;; New code should always provide the `when' argument.
321 (obsolete-name current-name when
) "23.1"))
322 (put obsolete-name
'byte-obsolete-info
323 ;; The second entry used to hold the `byte-compile' handler, but
324 ;; is not used any more nowadays.
325 (purecopy (list current-name nil when
)))
328 (defmacro define-obsolete-function-alias
(obsolete-name current-name
329 &optional when docstring
)
330 "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
332 \(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")
334 is equivalent to the following two lines of code:
336 \(defalias 'old-fun 'new-fun \"old-fun's doc.\")
337 \(make-obsolete 'old-fun 'new-fun \"22.1\")
339 See the docstrings of `defalias' and `make-obsolete' for more details."
340 (declare (doc-string 4)
341 (advertised-calling-convention
342 ;; New code should always provide the `when' argument.
343 (obsolete-name current-name when
&optional docstring
) "23.1"))
345 (defalias ,obsolete-name
,current-name
,docstring
)
346 (make-obsolete ,obsolete-name
,current-name
,when
)))
348 (defun make-obsolete-variable (obsolete-name current-name
&optional when access-type
)
349 "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
350 The warning will say that CURRENT-NAME should be used instead.
351 If CURRENT-NAME is a string, that is the `use instead' message.
352 WHEN should be a string indicating when the variable
353 was first made obsolete, for example a date or a release number.
354 ACCESS-TYPE if non-nil should specify the kind of access that will trigger
355 obsolescence warnings; it can be either `get' or `set'."
356 (declare (advertised-calling-convention
357 ;; New code should always provide the `when' argument.
358 (obsolete-name current-name when
&optional access-type
) "23.1"))
359 (put obsolete-name
'byte-obsolete-variable
360 (purecopy (list current-name access-type when
)))
364 (defmacro define-obsolete-variable-alias
(obsolete-name current-name
365 &optional when docstring
)
366 "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
367 This uses `defvaralias' and `make-obsolete-variable' (which see).
368 See the Info node `(elisp)Variable Aliases' for more details.
370 If CURRENT-NAME is a defcustom (more generally, any variable
371 where OBSOLETE-NAME may be set, e.g. in an init file, before the
372 alias is defined), then the define-obsolete-variable-alias
373 statement should be evaluated before the defcustom, if user
374 customizations are to be respected. The simplest way to achieve
375 this is to place the alias statement before the defcustom (this
376 is not necessary for aliases that are autoloaded, or in files
377 dumped with Emacs). This is so that any user customizations are
378 applied before the defcustom tries to initialize the
379 variable (this is due to the way `defvaralias' works).
381 For the benefit of `custom-set-variables', if OBSOLETE-NAME has
382 any of the following properties, they are copied to
383 CURRENT-NAME, if it does not already have them:
384 'saved-value, 'saved-variable-comment."
385 (declare (doc-string 4)
386 (advertised-calling-convention
387 ;; New code should always provide the `when' argument.
388 (obsolete-name current-name when
&optional docstring
) "23.1"))
390 (defvaralias ,obsolete-name
,current-name
,docstring
)
392 (dolist (prop '(saved-value saved-variable-comment
))
393 (and (get ,obsolete-name prop
)
394 (null (get ,current-name prop
))
395 (put ,current-name prop
(get ,obsolete-name prop
))))
396 (make-obsolete-variable ,obsolete-name
,current-name
,when
)))
398 ;; FIXME This is only defined in this file because the variable- and
399 ;; function- versions are too. Unlike those two, this one is not used
400 ;; by the byte-compiler (would be nice if it could warn about obsolete
401 ;; faces, but it doesn't really do anything special with faces).
402 ;; It only really affects M-x describe-face output.
403 (defmacro define-obsolete-face-alias
(obsolete-face current-face when
)
404 "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete.
405 The string WHEN gives the Emacs version where OBSOLETE-FACE became
408 (put ,obsolete-face
'face-alias
,current-face
)
409 ;; Used by M-x describe-face.
410 (put ,obsolete-face
'obsolete-face
(or (purecopy ,when
) t
))))
412 (defmacro dont-compile
(&rest body
)
413 "Like `progn', but the body always runs interpreted (not compiled).
414 If you think you need this, you're probably making a mistake somewhere."
415 (declare (debug t
) (indent 0) (obsolete nil
"24.4"))
416 (list 'eval
(list 'quote
(if (cdr body
) (cons 'progn body
) (car body
)))))
419 ;; interface to evaluating things at compile time and/or load time
420 ;; these macro must come after any uses of them in this file, as their
421 ;; definition in the file overrides the magic definitions on the
422 ;; byte-compile-macro-environment.
424 (defmacro eval-when-compile
(&rest body
)
425 "Like `progn', but evaluates the body at compile time if you're compiling.
426 Thus, the result of the body appears to the compiler as a quoted
427 constant. In interpreted code, this is entirely equivalent to
428 `progn', except that the value of the expression may be (but is
429 not necessarily) computed at load time if eager macro expansion
431 (declare (debug (&rest def-form
)) (indent 0))
432 (list 'quote
(eval (cons 'progn body
) lexical-binding
)))
434 (defmacro eval-and-compile
(&rest body
)
435 "Like `progn', but evaluates the body at compile time and at
436 load time. In interpreted code, this is entirely equivalent to
437 `progn', except that the value of the expression may be (but is
438 not necessarily) computed at load time if eager macro expansion
440 (declare (debug t
) (indent 0))
441 ;; When the byte-compiler expands code, this macro is not used, so we're
442 ;; either about to run `body' (plain interpretation) or we're doing eager
444 (list 'quote
(eval (cons 'progn body
) lexical-binding
)))
446 (defun with-no-warnings (&rest body
)
447 "Like `progn', but prevents compiler warnings in the body."
449 ;; The implementation for the interpreter is basically trivial.
453 ;; I nuked this because it's not a good idea for users to think of using it.
454 ;; These options are a matter of installation preference, and have nothing to
455 ;; with particular source files; it's a mistake to suggest to users
456 ;; they should associate these with particular source files.
457 ;; There is hardly any reason to change these parameters, anyway.
460 ;; (put 'byte-compiler-options 'lisp-indent-function 0)
461 ;; (defmacro byte-compiler-options (&rest args)
462 ;; "Set some compilation-parameters for this file. This will affect only the
463 ;; file in which it appears; this does nothing when evaluated, and when loaded
466 ;; Each argument to this macro must be a list of a key and a value.
468 ;; Keys: Values: Corresponding variable:
470 ;; verbose t, nil byte-compile-verbose
471 ;; optimize t, nil, source, byte byte-compile-optimize
472 ;; warnings list of warnings byte-compile-warnings
473 ;; Valid elements: (callargs redefine free-vars unresolved)
474 ;; file-format emacs18, emacs19 byte-compile-compatibility
476 ;; For example, this might appear at the top of a source file:
478 ;; (byte-compiler-options
480 ;; (warnings (- free-vars)) ; Don't warn about free variables
481 ;; (file-format emacs19))"
484 (make-obsolete-variable 'macro-declaration-function
485 'macro-declarations-alist
"24.3")
486 (make-obsolete 'macro-declaration-function
487 'macro-declarations-alist
"24.3")
489 ;;; byte-run.el ends here