1 ;;; byte-run.el --- byte-compiler support for inlining -*- lexical-binding: t -*-
3 ;; Copyright (C) 1992, 2001-2013 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski <jwz@lucid.com>
6 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
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 ;; `macro-declaration-function' are both obsolete (as marked at the end of this
34 ;; file) but used in many .elc files.
36 (defvar macro-declaration-function #'macro-declaration-function
37 "Function to process declarations in a macro definition.
38 The function will be called with two args MACRO and DECL.
39 MACRO is the name of the macro being defined.
40 DECL is a list `(declare ...)' containing the declarations.
41 The value the function returns is not used.")
43 (defalias 'macro-declaration-function
44 #'(lambda (macro decl)
45 "Process a declaration found in a macro definition.
46 This is set as the value of the variable `macro-declaration-function'.
47 MACRO is the name of the macro being defined.
48 DECL is a list `(declare ...)' containing the declarations.
49 The return value of this function is not used."
50 ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons.
52 ;; Ignore the first element of `decl' (it's always `declare').
53 (while (setq decl (cdr decl))
58 (cond ((eq (car d) 'indent)
59 (put macro 'lisp-indent-function (car (cdr d))))
61 (put macro 'edebug-form-spec (car (cdr d))))
62 ((eq (car d) 'doc-string)
63 (put macro 'doc-string-elt (car (cdr d))))
65 (message "Unknown declaration %s" d)))
66 (message "Invalid declaration %s" d))))))
68 ;; We define macro-declaration-alist here because it is needed to
69 ;; handle declarations in macro definitions and this is the first file
70 ;; loaded by loadup.el that uses declarations in macros.
72 (defvar defun-declarations-alist
74 ;; We can only use backquotes inside the lambdas and not for those
75 ;; properties that are used by functions loaded before backquote.el.
76 (list 'advertised-calling-convention
77 #'(lambda (f _args arglist when)
78 (list 'set-advertised-calling-convention
79 (list 'quote f) (list 'quote arglist) (list 'quote when))))
81 #'(lambda (f _args new-name when)
82 `(make-obsolete ',f ',new-name ,when)))
84 #'(lambda (f _args compiler-function)
85 (if (not (symbolp compiler-function))
86 (error "Only symbols are supported in `compiler-macro'")
87 `(put ',f 'compiler-macro #',compiler-function))))
89 #'(lambda (f _args pos)
90 (list 'put (list 'quote f) ''doc-string-elt (list 'quote pos))))
92 #'(lambda (f _args val)
93 (list 'put (list 'quote f)
94 ''lisp-indent-function (list 'quote val)))))
95 "List associating function properties to their macro expansion.
96 Each element of the list takes the form (PROP FUN) where FUN is
97 a function. For each (PROP . VALUES) in a function's declaration,
98 the FUN corresponding to PROP is called with the function name,
99 the function's arglist, and the VALUES and should return the code to use
100 to set this property.")
102 (defvar macro-declarations-alist
105 #'(lambda (name _args spec)
106 (list 'progn :autoload-end
107 (list 'put (list 'quote name)
108 ''edebug-form-spec (list 'quote spec)))))
109 defun-declarations-alist)
110 "List associating properties of macros to their macro expansion.
111 Each element of the list takes the form (PROP FUN) where FUN is
112 a function. For each (PROP . VALUES) in a macro's declaration,
113 the FUN corresponding to PROP is called with the function name
114 and the VALUES and should return the code to use to set this property.")
116 (put 'defmacro 'doc-string-elt 3)
120 #'(lambda (name arglist &optional docstring &rest body)
121 "Define NAME as a macro.
122 When the macro is called, as in (NAME ARGS...),
123 the function (lambda ARGLIST BODY...) is applied to
124 the list ARGS... as it appears in the expression,
125 and the result should be a form to be evaluated instead of the original.
126 DECL is a declaration, optional, of the form (declare DECLS...) where
127 DECLS is a list of elements of the form (PROP . VALUES). These are
128 interpreted according to `macro-declarations-alist'.
129 The return value is undefined.
131 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
132 ;; We can't just have `decl' as an &optional argument, because we need
134 ;; (defmacro foo (arg) (bar) nil)
136 ;; (defmacro foo (arg) (bar)).
138 ((eq (car-safe docstring) 'declare)
139 (prog1 (cdr docstring) (setq docstring nil)))
140 ((and (stringp docstring)
141 (eq (car-safe (car body)) 'declare))
142 (prog1 (cdr (car body)) (setq body (cdr body)))))))
143 (if docstring (setq body (cons docstring body))
144 (if (null body) (setq body '(nil))))
145 ;; Can't use backquote because it's not defined yet!
146 (let* ((fun (list 'function (cons 'lambda (cons arglist body))))
149 (list 'cons ''macro fun)))
153 (let ((f (cdr (assq (car x) macro-declarations-alist))))
154 (if f (apply (car f) name arglist (cdr x))
155 (message "Warning: Unknown macro property %S in %S"
159 (cons 'prog1 (cons def declarations))
162 ;; Now that we defined defmacro we can use it!
163 (defmacro defun (name arglist &optional docstring &rest body)
164 "Define NAME as a function.
165 The definition is (lambda ARGLIST [DOCSTRING] BODY...).
166 See also the function `interactive'.
167 DECL is a declaration, optional, of the form (declare DECLS...) where
168 DECLS is a list of elements of the form (PROP . VALUES). These are
169 interpreted according to `defun-declarations-alist'.
170 The return value is undefined.
172 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
173 ;; We can't just have `decl' as an &optional argument, because we need
175 ;; (defun foo (arg) (toto) nil)
177 ;; (defun foo (arg) (toto)).
178 (declare (doc-string 3))
180 ((eq (car-safe docstring) 'declare)
181 (prog1 (cdr docstring) (setq docstring nil)))
182 ((and (stringp docstring)
183 (eq (car-safe (car body)) 'declare))
184 (prog1 (cdr (car body)) (setq body (cdr body)))))))
185 (if docstring (setq body (cons docstring body))
186 (if (null body) (setq body '(nil))))
190 (let ((f (cdr (assq (car x) defun-declarations-alist))))
192 (f (apply (car f) name arglist (cdr x)))
195 (memq (car x) ;C.f. cl-do-proclaim.
196 '(special inline notinline optimize warn)))
197 (push (list 'declare x)
198 (if (stringp docstring)
199 (if (eq (car-safe (cadr body)) 'interactive)
202 (if (eq (car-safe (car body)) 'interactive)
206 (t (message "Warning: Unknown defun property `%S' in %S"
213 (cons arglist body))))))
215 (cons 'prog1 (cons def declarations))
218 ;; Redefined in byte-optimize.el.
219 ;; This is not documented--it's not clear that we should promote it.
220 (fset 'inline 'progn)
222 ;;; Interface to inline functions.
224 ;; (defmacro proclaim-inline (&rest fns)
225 ;; "Cause the named functions to be open-coded when called from compiled code.
226 ;; They will only be compiled open-coded when byte-compile-optimize is true."
227 ;; (cons 'eval-and-compile
228 ;; (mapcar (lambda (x)
229 ;; (or (memq (get x 'byte-optimizer)
230 ;; '(nil byte-compile-inline-expand))
232 ;; "%s already has a byte-optimizer, can't make it inline"
234 ;; (list 'put (list 'quote x)
235 ;; ''byte-optimizer ''byte-compile-inline-expand))
238 ;; (defmacro proclaim-notinline (&rest fns)
239 ;; "Cause the named functions to no longer be open-coded."
240 ;; (cons 'eval-and-compile
241 ;; (mapcar (lambda (x)
242 ;; (if (eq (get x 'byte-optimizer) 'byte-compile-inline-expand)
243 ;; (put x 'byte-optimizer nil))
244 ;; (list 'if (list 'eq (list 'get (list 'quote x) ''byte-optimizer)
245 ;; ''byte-compile-inline-expand)
246 ;; (list 'put x ''byte-optimizer nil)))
249 (defmacro defsubst (name arglist &rest body)
250 "Define an inline function. The syntax is just like that of `defun'.
251 \(fn NAME ARGLIST &optional DOCSTRING DECL &rest BODY)"
252 (declare (debug defun) (doc-string 3))
253 (or (memq (get name 'byte-optimizer)
254 '(nil byte-compile-inline-expand))
255 (error "`%s' is a primitive" name))
257 (defun ,name ,arglist ,@body)
259 (put ',name 'byte-optimizer 'byte-compile-inline-expand))))
261 (defvar advertised-signature-table (make-hash-table :test 'eq :weakness 'key))
263 (defun set-advertised-calling-convention (function signature _when)
264 "Set the advertised SIGNATURE of FUNCTION.
265 This will allow the byte-compiler to warn the programmer when she uses
266 an obsolete calling convention. WHEN specifies since when the calling
267 convention was modified."
268 (puthash (indirect-function function) signature
269 advertised-signature-table))
271 (defun make-obsolete (obsolete-name current-name &optional when)
272 "Make the byte-compiler warn that function OBSOLETE-NAME is obsolete.
273 OBSOLETE-NAME should be a function name or macro name (a symbol).
275 The warning will say that CURRENT-NAME should be used instead.
276 If CURRENT-NAME is a string, that is the `use instead' message
277 \(it should end with a period, and not start with a capital).
278 WHEN should be a string indicating when the function
279 was first made obsolete, for example a date or a release number."
280 (declare (advertised-calling-convention
281 ;; New code should always provide the `when' argument.
282 (obsolete-name current-name when) "23.1"))
283 (interactive "aMake function obsolete: \nxObsoletion replacement: ")
284 (put obsolete-name 'byte-obsolete-info
285 ;; The second entry used to hold the `byte-compile' handler, but
286 ;; is not used any more nowadays.
287 (purecopy (list current-name nil when)))
290 (defmacro define-obsolete-function-alias (obsolete-name current-name
291 &optional when docstring)
292 "Set OBSOLETE-NAME's function definition to CURRENT-NAME and mark it obsolete.
294 \(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")
296 is equivalent to the following two lines of code:
298 \(defalias 'old-fun 'new-fun \"old-fun's doc.\")
299 \(make-obsolete 'old-fun 'new-fun \"22.1\")
301 See the docstrings of `defalias' and `make-obsolete' for more details."
302 (declare (doc-string 4)
303 (advertised-calling-convention
304 ;; New code should always provide the `when' argument.
305 (obsolete-name current-name when &optional docstring) "23.1"))
307 (defalias ,obsolete-name ,current-name ,docstring)
308 (make-obsolete ,obsolete-name ,current-name ,when)))
310 (defun make-obsolete-variable (obsolete-name current-name &optional when access-type)
311 "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
312 The warning will say that CURRENT-NAME should be used instead.
313 If CURRENT-NAME is a string, that is the `use instead' message.
314 WHEN should be a string indicating when the variable
315 was first made obsolete, for example a date or a release number.
316 ACCESS-TYPE if non-nil should specify the kind of access that will trigger
317 obsolescence warnings; it can be either `get' or `set'."
318 (declare (advertised-calling-convention
319 ;; New code should always provide the `when' argument.
320 (obsolete-name current-name when &optional access-type) "23.1"))
321 (put obsolete-name 'byte-obsolete-variable
322 (purecopy (list current-name access-type when)))
326 (defmacro define-obsolete-variable-alias (obsolete-name current-name
327 &optional when docstring)
328 "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
329 This uses `defvaralias' and `make-obsolete-variable' (which see).
330 See the Info node `(elisp)Variable Aliases' for more details.
332 If CURRENT-NAME is a defcustom (more generally, any variable
333 where OBSOLETE-NAME may be set, e.g. in an init file, before the
334 alias is defined), then the define-obsolete-variable-alias
335 statement should be evaluated before the defcustom, if user
336 customizations are to be respected. The simplest way to achieve
337 this is to place the alias statement before the defcustom (this
338 is not necessary for aliases that are autoloaded, or in files
339 dumped with Emacs). This is so that any user customizations are
340 applied before the defcustom tries to initialize the
341 variable (this is due to the way `defvaralias' works).
343 For the benefit of `custom-set-variables', if OBSOLETE-NAME has
344 any of the following properties, they are copied to
345 CURRENT-NAME, if it does not already have them:
346 'saved-value, 'saved-variable-comment."
347 (declare (doc-string 4)
348 (advertised-calling-convention
349 ;; New code should always provide the `when' argument.
350 (obsolete-name current-name when &optional docstring) "23.1"))
352 (defvaralias ,obsolete-name ,current-name ,docstring)
354 (dolist (prop '(saved-value saved-variable-comment))
355 (and (get ,obsolete-name prop)
356 (null (get ,current-name prop))
357 (put ,current-name prop (get ,obsolete-name prop))))
358 (make-obsolete-variable ,obsolete-name ,current-name ,when)))
360 ;; FIXME This is only defined in this file because the variable- and
361 ;; function- versions are too. Unlike those two, this one is not used
362 ;; by the byte-compiler (would be nice if it could warn about obsolete
363 ;; faces, but it doesn't really do anything special with faces).
364 ;; It only really affects M-x describe-face output.
365 (defmacro define-obsolete-face-alias (obsolete-face current-face when)
366 "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete.
367 The string WHEN gives the Emacs version where OBSOLETE-FACE became
370 (put ,obsolete-face 'face-alias ,current-face)
371 ;; Used by M-x describe-face.
372 (put ,obsolete-face 'obsolete-face (or (purecopy ,when) t))))
374 (defmacro dont-compile (&rest body)
375 "Like `progn', but the body always runs interpreted (not compiled).
376 If you think you need this, you're probably making a mistake somewhere."
377 (declare (debug t) (indent 0))
378 (list 'eval (list 'quote (if (cdr body) (cons 'progn body) (car body)))))
381 ;; interface to evaluating things at compile time and/or load time
382 ;; these macro must come after any uses of them in this file, as their
383 ;; definition in the file overrides the magic definitions on the
384 ;; byte-compile-macro-environment.
386 (defmacro eval-when-compile (&rest body)
387 "Like `progn', but evaluates the body at compile time if you're compiling.
388 Thus, the result of the body appears to the compiler as a quoted constant.
389 In interpreted code, this is entirely equivalent to `progn'."
390 (declare (debug t) (indent 0))
391 ;; Not necessary because we have it in b-c-initial-macro-environment
392 ;; (list 'quote (eval (cons 'progn body)))
395 (defmacro eval-and-compile (&rest body)
396 "Like `progn', but evaluates the body at compile time and at load time."
397 (declare (debug t) (indent 0))
398 ;; Remember, it's magic.
401 (put 'with-no-warnings 'lisp-indent-function 0)
402 (defun with-no-warnings (&rest body)
403 "Like `progn', but prevents compiler warnings in the body."
404 ;; The implementation for the interpreter is basically trivial.
408 ;; I nuked this because it's not a good idea for users to think of using it.
409 ;; These options are a matter of installation preference, and have nothing to
410 ;; with particular source files; it's a mistake to suggest to users
411 ;; they should associate these with particular source files.
412 ;; There is hardly any reason to change these parameters, anyway.
415 ;; (put 'byte-compiler-options 'lisp-indent-function 0)
416 ;; (defmacro byte-compiler-options (&rest args)
417 ;; "Set some compilation-parameters for this file. This will affect only the
418 ;; file in which it appears; this does nothing when evaluated, and when loaded
421 ;; Each argument to this macro must be a list of a key and a value.
423 ;; Keys: Values: Corresponding variable:
425 ;; verbose t, nil byte-compile-verbose
426 ;; optimize t, nil, source, byte byte-compile-optimize
427 ;; warnings list of warnings byte-compile-warnings
428 ;; Valid elements: (callargs redefine free-vars unresolved)
429 ;; file-format emacs18, emacs19 byte-compile-compatibility
431 ;; For example, this might appear at the top of a source file:
433 ;; (byte-compiler-options
435 ;; (warnings (- free-vars)) ; Don't warn about free variables
436 ;; (file-format emacs19))"
439 (make-obsolete-variable 'macro-declaration-function
440 'macro-declarations-alist "24.3")
441 (make-obsolete 'macro-declaration-function
442 'macro-declarations-alist "24.3")
444 ;;; byte-run.el ends here