Prefer directed to neutral quotes
[emacs.git] / lisp / emacs-lisp / bytecomp.el
blob8b8b667f596a248f4a8701050453bccf93f05ce1
1 ;;; bytecomp.el --- compilation of Lisp code into byte code -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2015 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
8 ;; Maintainer: emacs-devel@gnu.org
9 ;; Keywords: lisp
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
30 ;; of p-code (`lapcode') which takes up less space and can be interpreted
31 ;; faster. [`LAP' == `Lisp Assembly Program'.]
32 ;; The user entry points are byte-compile-file and byte-recompile-directory.
34 ;;; Todo:
36 ;; - Turn "not bound at runtime" functions into autoloads.
38 ;;; Code:
40 ;; ========================================================================
41 ;; Entry points:
42 ;; byte-recompile-directory, byte-compile-file,
43 ;; byte-recompile-file,
44 ;; batch-byte-compile, batch-byte-recompile-directory,
45 ;; byte-compile, compile-defun,
46 ;; display-call-tree
47 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
48 ;; because they are not terribly useful and get in the way of completion.)
50 ;; This version of the byte compiler has the following improvements:
51 ;; + optimization of compiled code:
52 ;; - removal of unreachable code;
53 ;; - removal of calls to side-effectless functions whose return-value
54 ;; is unused;
55 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
56 ;; and (ash 1 6);
57 ;; - open-coding of literal lambdas;
58 ;; - peephole optimization of emitted code;
59 ;; - trivial functions are left uncompiled for speed.
60 ;; + support for inline functions;
61 ;; + compile-time evaluation of arbitrary expressions;
62 ;; + compile-time warning messages for:
63 ;; - functions being redefined with incompatible arglists;
64 ;; - functions being redefined as macros, or vice-versa;
65 ;; - functions or macros defined multiple times in the same file;
66 ;; - functions being called with the incorrect number of arguments;
67 ;; - functions being called which are not defined globally, in the
68 ;; file, or as autoloads;
69 ;; - assignment and reference of undeclared free variables;
70 ;; - various syntax errors;
71 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
72 ;; + correct compilation of top-level uses of macros;
73 ;; + the ability to generate a histogram of functions called.
75 ;; User customization variables: M-x customize-group bytecomp
77 ;; New Features:
79 ;; o The form `defsubst' is just like `defun', except that the function
80 ;; generated will be open-coded in compiled code which uses it. This
81 ;; means that no function call will be generated, it will simply be
82 ;; spliced in. Lisp functions calls are very slow, so this can be a
83 ;; big win.
85 ;; You can generally accomplish the same thing with `defmacro', but in
86 ;; that case, the defined procedure can't be used as an argument to
87 ;; mapcar, etc.
89 ;; o You can also open-code one particular call to a function without
90 ;; open-coding all calls. Use the 'inline' form to do this, like so:
92 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
93 ;; or...
94 ;; (inline ;; `foo' and `baz' will be
95 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
96 ;; (baz 0))
98 ;; o It is possible to open-code a function in the same file it is defined
99 ;; in without having to load that file before compiling it. The
100 ;; byte-compiler has been modified to remember function definitions in
101 ;; the compilation environment in the same way that it remembers macro
102 ;; definitions.
104 ;; o Forms like ((lambda ...) ...) are open-coded.
106 ;; o The form `eval-when-compile' is like progn, except that the body
107 ;; is evaluated at compile-time. When it appears at top-level, this
108 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
109 ;; When it does not appear at top-level, it is similar to the
110 ;; Common Lisp #. reader macro (but not in interpreted code).
112 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
113 ;; the whole form is evalled both at compile-time and at run-time.
115 ;; o The command compile-defun is analogous to eval-defun.
117 ;; o If you run byte-compile-file on a filename which is visited in a
118 ;; buffer, and that buffer is modified, you are asked whether you want
119 ;; to save the buffer before compiling.
121 ;; o byte-compiled files now start with the string `;ELC'.
122 ;; Some versions of `file' can be customized to recognize that.
124 (require 'backquote)
125 (require 'macroexp)
126 (require 'cconv)
128 ;; During bootstrap, cl-loaddefs.el is not created yet, so loading cl-lib
129 ;; doesn't setup autoloads for things like cl-every, which is why we have to
130 ;; require cl-extra instead (bug#18804).
131 (require 'cl-extra)
133 (or (fboundp 'defsubst)
134 ;; This really ought to be loaded already!
135 (load "byte-run"))
137 ;; The feature of compiling in a specific target Emacs version
138 ;; has been turned off because compile time options are a bad idea.
139 (defgroup bytecomp nil
140 "Emacs Lisp byte-compiler."
141 :group 'lisp)
143 (defcustom emacs-lisp-file-regexp "\\.el\\'"
144 "Regexp which matches Emacs Lisp source files.
145 If you change this, you might want to set `byte-compile-dest-file-function'."
146 :group 'bytecomp
147 :type 'regexp)
149 (defcustom byte-compile-dest-file-function nil
150 "Function for the function `byte-compile-dest-file' to call.
151 It should take one argument, the name of an Emacs Lisp source
152 file name, and return the name of the compiled file."
153 :group 'bytecomp
154 :type '(choice (const nil) function)
155 :version "23.2")
157 ;; This enables file name handlers such as jka-compr
158 ;; to remove parts of the file name that should not be copied
159 ;; through to the output file name.
160 (defun byte-compiler-base-file-name (filename)
161 (let ((handler (find-file-name-handler filename
162 'byte-compiler-base-file-name)))
163 (if handler
164 (funcall handler 'byte-compiler-base-file-name filename)
165 filename)))
167 (or (fboundp 'byte-compile-dest-file)
168 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
169 ;; so only define it if it is undefined.
170 ;; Note - redefining this function is obsolete as of 23.2.
171 ;; Customize byte-compile-dest-file-function instead.
172 (defun byte-compile-dest-file (filename)
173 "Convert an Emacs Lisp source file name to a compiled file name.
174 If `byte-compile-dest-file-function' is non-nil, uses that
175 function to do the work. Otherwise, if FILENAME matches
176 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
177 adds `c' to it; otherwise adds `.elc'."
178 (if byte-compile-dest-file-function
179 (funcall byte-compile-dest-file-function filename)
180 (setq filename (file-name-sans-versions
181 (byte-compiler-base-file-name filename)))
182 (cond ((string-match emacs-lisp-file-regexp filename)
183 (concat (substring filename 0 (match-beginning 0)) ".elc"))
184 (t (concat filename ".elc"))))))
186 ;; This can be the 'byte-compile property of any symbol.
187 (autoload 'byte-compile-inline-expand "byte-opt")
189 ;; This is the entry point to the lapcode optimizer pass1.
190 (autoload 'byte-optimize-form "byte-opt")
191 ;; This is the entry point to the lapcode optimizer pass2.
192 (autoload 'byte-optimize-lapcode "byte-opt")
193 (autoload 'byte-compile-unfold-lambda "byte-opt")
195 ;; This is the entry point to the decompiler, which is used by the
196 ;; disassembler. The disassembler just requires 'byte-compile, but
197 ;; that doesn't define this function, so this seems to be a reasonable
198 ;; thing to do.
199 (autoload 'byte-decompile-bytecode "byte-opt")
201 (defcustom byte-compile-verbose
202 (and (not noninteractive) (> baud-rate search-slow-speed))
203 "Non-nil means print messages describing progress of byte-compiler."
204 :group 'bytecomp
205 :type 'boolean)
207 (defcustom byte-optimize t
208 "Enable optimization in the byte compiler.
209 Possible values are:
210 nil - no optimization
211 t - all optimizations
212 `source' - source-level optimizations only
213 `byte' - code-level optimizations only"
214 :group 'bytecomp
215 :type '(choice (const :tag "none" nil)
216 (const :tag "all" t)
217 (const :tag "source-level" source)
218 (const :tag "byte-level" byte)))
220 (defcustom byte-compile-delete-errors nil
221 "If non-nil, the optimizer may delete forms that may signal an error.
222 This includes variable references and calls to functions such as `car'."
223 :group 'bytecomp
224 :type 'boolean)
226 (defvar byte-compile-dynamic nil
227 "If non-nil, compile function bodies so they load lazily.
228 They are hidden in comments in the compiled file,
229 and each one is brought into core when the
230 function is called.
232 To enable this option, make it a file-local variable
233 in the source file you want it to apply to.
234 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
236 When this option is true, if you load the compiled file and then move it,
237 the functions you loaded will not be able to run.")
238 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
240 (defvar byte-compile-disable-print-circle nil
241 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
242 (make-obsolete-variable 'byte-compile-disable-print-circle nil "24.1")
243 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
245 (defcustom byte-compile-dynamic-docstrings t
246 "If non-nil, compile doc strings for lazy access.
247 We bury the doc strings of functions and variables inside comments in
248 the file, and bring them into core only when they are actually needed.
250 When this option is true, if you load the compiled file and then move it,
251 you won't be able to find the documentation of anything in that file.
253 To disable this option for a certain file, make it a file-local variable
254 in the source file. For example, add this to the first line:
255 -*-byte-compile-dynamic-docstrings:nil;-*-
256 You can also set the variable globally.
258 This option is enabled by default because it reduces Emacs memory usage."
259 :group 'bytecomp
260 :type 'boolean)
261 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
263 (defconst byte-compile-log-buffer "*Compile-Log*"
264 "Name of the byte-compiler's log buffer.")
266 (defcustom byte-optimize-log nil
267 "If non-nil, the byte-compiler will log its optimizations.
268 If this is 'source, then only source-level optimizations will be logged.
269 If it is 'byte, then only byte-level optimizations will be logged.
270 The information is logged to `byte-compile-log-buffer'."
271 :group 'bytecomp
272 :type '(choice (const :tag "none" nil)
273 (const :tag "all" t)
274 (const :tag "source-level" source)
275 (const :tag "byte-level" byte)))
277 (defcustom byte-compile-error-on-warn nil
278 "If true, the byte-compiler reports warnings with `error'."
279 :group 'bytecomp
280 :type 'boolean)
282 (defconst byte-compile-warning-types
283 '(redefine callargs free-vars unresolved
284 obsolete noruntime cl-functions interactive-only
285 make-local mapcar constants suspicious lexical)
286 "The list of warning types used when `byte-compile-warnings' is t.")
287 (defcustom byte-compile-warnings t
288 "List of warnings that the byte-compiler should issue (t for all).
290 Elements of the list may be:
292 free-vars references to variables not in the current lexical scope.
293 unresolved calls to unknown functions.
294 callargs function calls with args that don't match the definition.
295 redefine function name redefined from a macro to ordinary function or vice
296 versa, or redefined to take a different number of arguments.
297 obsolete obsolete variables and functions.
298 noruntime functions that may not be defined at runtime (typically
299 defined only under `eval-when-compile').
300 cl-functions calls to runtime functions (as distinguished from macros and
301 aliases) from the old CL package (not the newer cl-lib).
302 interactive-only
303 commands that normally shouldn't be called from Lisp code.
304 lexical global/dynamic variables lacking a prefix.
305 make-local calls to make-variable-buffer-local that may be incorrect.
306 mapcar mapcar called for effect.
307 constants let-binding of, or assignment to, constants/nonvariables.
308 suspicious constructs that usually don't do what the coder wanted.
310 If the list begins with `not', then the remaining elements specify warnings to
311 suppress. For example, (not mapcar) will suppress warnings about mapcar."
312 :group 'bytecomp
313 :type `(choice (const :tag "All" t)
314 (set :menu-tag "Some"
315 ,@(mapcar (lambda (x) `(const ,x))
316 byte-compile-warning-types))))
318 ;;;###autoload
319 (put 'byte-compile-warnings 'safe-local-variable
320 (lambda (v)
321 (or (symbolp v)
322 (null (delq nil (mapcar (lambda (x) (not (symbolp x))) v))))))
324 (defun byte-compile-warning-enabled-p (warning)
325 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
326 (or (eq byte-compile-warnings t)
327 (if (eq (car byte-compile-warnings) 'not)
328 (not (memq warning byte-compile-warnings))
329 (memq warning byte-compile-warnings))))
331 ;;;###autoload
332 (defun byte-compile-disable-warning (warning)
333 "Change `byte-compile-warnings' to disable WARNING.
334 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
335 Otherwise, if the first element is `not', add WARNING, else remove it.
336 Normally you should let-bind `byte-compile-warnings' before calling this,
337 else the global value will be modified."
338 (setq byte-compile-warnings
339 (cond ((eq byte-compile-warnings t)
340 (list 'not warning))
341 ((eq (car byte-compile-warnings) 'not)
342 (if (memq warning byte-compile-warnings)
343 byte-compile-warnings
344 (append byte-compile-warnings (list warning))))
346 (delq warning byte-compile-warnings)))))
348 ;;;###autoload
349 (defun byte-compile-enable-warning (warning)
350 "Change `byte-compile-warnings' to enable WARNING.
351 If `byte-compile-warnings' is t, do nothing. Otherwise, if the
352 first element is `not', remove WARNING, else add it.
353 Normally you should let-bind `byte-compile-warnings' before calling this,
354 else the global value will be modified."
355 (or (eq byte-compile-warnings t)
356 (setq byte-compile-warnings
357 (cond ((eq (car byte-compile-warnings) 'not)
358 (delq warning byte-compile-warnings))
359 ((memq warning byte-compile-warnings)
360 byte-compile-warnings)
362 (append byte-compile-warnings (list warning)))))))
364 (defvar byte-compile-interactive-only-functions nil
365 "List of commands that are not meant to be called from Lisp.")
366 (make-obsolete-variable 'byte-compile-interactive-only-functions
367 "use the `interactive-only' symbol property instead."
368 "24.4")
370 (defvar byte-compile-not-obsolete-vars nil
371 "List of variables that shouldn't be reported as obsolete.")
372 (defvar byte-compile-global-not-obsolete-vars nil
373 "Global list of variables that shouldn't be reported as obsolete.")
375 (defvar byte-compile-not-obsolete-funcs nil
376 "List of functions that shouldn't be reported as obsolete.")
378 (defcustom byte-compile-generate-call-tree nil
379 "Non-nil means collect call-graph information when compiling.
380 This records which functions were called and from where.
381 If the value is t, compilation displays the call graph when it finishes.
382 If the value is neither t nor nil, compilation asks you whether to display
383 the graph.
385 The call tree only lists functions called, not macros used. Those functions
386 which the byte-code interpreter knows about directly (eq, cons, etc.) are
387 not reported.
389 The call tree also lists those functions which are not known to be called
390 \(that is, to which no calls have been compiled). Functions which can be
391 invoked interactively are excluded from this list."
392 :group 'bytecomp
393 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
394 (other :tag "Ask" lambda)))
396 (defvar byte-compile-call-tree nil
397 "Alist of functions and their call tree.
398 Each element looks like
400 \(FUNCTION CALLERS CALLS\)
402 where CALLERS is a list of functions that call FUNCTION, and CALLS
403 is a list of functions for which calls were generated while compiling
404 FUNCTION.")
406 (defcustom byte-compile-call-tree-sort 'name
407 "If non-nil, sort the call tree.
408 The values `name', `callers', `calls', `calls+callers'
409 specify different fields to sort on."
410 :group 'bytecomp
411 :type '(choice (const name) (const callers) (const calls)
412 (const calls+callers) (const nil)))
414 (defvar byte-compile-debug nil)
415 (defvar byte-compile-constants nil
416 "List of all constants encountered during compilation of this form.")
417 (defvar byte-compile-variables nil
418 "List of all variables encountered during compilation of this form.")
419 (defvar byte-compile-bound-variables nil
420 "List of dynamic variables bound in the context of the current form.
421 This list lives partly on the stack.")
422 (defvar byte-compile-lexical-variables nil
423 "List of variables that have been treated as lexical.
424 Filled in `cconv-analyze-form' but initialized and consulted here.")
425 (defvar byte-compile-const-variables nil
426 "List of variables declared as constants during compilation of this file.")
427 (defvar byte-compile-free-references)
428 (defvar byte-compile-free-assignments)
430 (defvar byte-compiler-error-flag)
432 (defun byte-compile-recurse-toplevel (form non-toplevel-case)
433 "Implement `eval-when-compile' and `eval-and-compile'.
434 Return the compile-time value of FORM."
435 ;; Macroexpand (not macroexpand-all!) form at toplevel in case it
436 ;; expands into a toplevel-equivalent `progn'. See CLHS section
437 ;; 3.2.3.1, "Processing of Top Level Forms". The semantics are very
438 ;; subtle: see test/automated/bytecomp-tests.el for interesting
439 ;; cases.
440 (setf form (macroexp-macroexpand form byte-compile-macro-environment))
441 (if (eq (car-safe form) 'progn)
442 (cons 'progn
443 (mapcar (lambda (subform)
444 (byte-compile-recurse-toplevel
445 subform non-toplevel-case))
446 (cdr form)))
447 (funcall non-toplevel-case form)))
449 (defconst byte-compile-initial-macro-environment
451 ;; (byte-compiler-options . (lambda (&rest forms)
452 ;; (apply 'byte-compiler-options-handler forms)))
453 (declare-function . byte-compile-macroexpand-declare-function)
454 (eval-when-compile . ,(lambda (&rest body)
455 (let ((result nil))
456 (byte-compile-recurse-toplevel
457 (macroexp-progn body)
458 (lambda (form)
459 (setf result
460 (byte-compile-eval
461 (byte-compile-top-level
462 (byte-compile-preprocess form))))))
463 (list 'quote result))))
464 (eval-and-compile . ,(lambda (&rest body)
465 (byte-compile-recurse-toplevel
466 (macroexp-progn body)
467 (lambda (form)
468 ;; Don't compile here, since we don't know
469 ;; whether to compile as byte-compile-form
470 ;; or byte-compile-file-form.
471 (let ((expanded
472 (macroexpand-all
473 form
474 macroexpand-all-environment)))
475 (eval expanded lexical-binding)
476 expanded))))))
477 "The default macro-environment passed to macroexpand by the compiler.
478 Placing a macro here will cause a macro to have different semantics when
479 expanded by the compiler as when expanded by the interpreter.")
481 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
482 "Alist of macros defined in the file being compiled.
483 Each element looks like (MACRONAME . DEFINITION). It is
484 \(MACRONAME . nil) when a macro is redefined as a function.")
486 (defvar byte-compile-function-environment nil
487 "Alist of functions defined in the file being compiled.
488 This is so we can inline them when necessary.
489 Each element looks like (FUNCTIONNAME . DEFINITION). It is
490 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
491 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
492 and we don't know the definition. For an autoloaded function, DEFINITION
493 has the form (autoload . FILENAME).")
495 (defvar byte-compile-unresolved-functions nil
496 "Alist of undefined functions to which calls have been compiled.
497 This variable is only significant whilst compiling an entire buffer.
498 Used for warnings when a function is not known to be defined or is later
499 defined with incorrect args.")
501 (defvar byte-compile-noruntime-functions nil
502 "Alist of functions called that may not be defined when the compiled code is run.
503 Used for warnings about calling a function that is defined during compilation
504 but won't necessarily be defined when the compiled file is loaded.")
506 ;; Variables for lexical binding
507 (defvar byte-compile--lexical-environment nil
508 "The current lexical environment.")
510 (defvar byte-compile-tag-number 0)
511 (defvar byte-compile-output nil
512 "Alist describing contents to put in byte code string.
513 Each element is (INDEX . VALUE)")
514 (defvar byte-compile-depth 0 "Current depth of execution stack.")
515 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
518 ;;; The byte codes; this information is duplicated in bytecomp.c
520 (defvar byte-code-vector nil
521 "An array containing byte-code names indexed by byte-code values.")
523 (defvar byte-stack+-info nil
524 "An array with the stack adjustment for each byte-code.")
526 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
527 ;; This is a speed-hack for building the byte-code-vector at compile-time.
528 ;; We fill in the vector at macroexpand-time, and then after the last call
529 ;; to byte-defop, we write the vector out as a constant instead of writing
530 ;; out a bunch of calls to aset.
531 ;; Actually, we don't fill in the vector itself, because that could make
532 ;; it problematic to compile big changes to this compiler; we store the
533 ;; values on its plist, and remove them later in -extrude.
534 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
535 (put 'byte-code-vector 'tmp-compile-time-value
536 (make-vector 256 nil))))
537 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
538 (put 'byte-stack+-info 'tmp-compile-time-value
539 (make-vector 256 nil)))))
540 (aset v1 opcode opname)
541 (aset v2 opcode stack-adjust))
542 (if docstring
543 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
544 (list 'defconst opname opcode)))
546 (defmacro byte-extrude-byte-code-vectors ()
547 (prog1 (list 'setq 'byte-code-vector
548 (get 'byte-code-vector 'tmp-compile-time-value)
549 'byte-stack+-info
550 (get 'byte-stack+-info 'tmp-compile-time-value))
551 (put 'byte-code-vector 'tmp-compile-time-value nil)
552 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
555 ;; These opcodes are special in that they pack their argument into the
556 ;; opcode word.
558 (byte-defop 0 1 byte-stack-ref "for stack reference")
559 (byte-defop 8 1 byte-varref "for variable reference")
560 (byte-defop 16 -1 byte-varset "for setting a variable")
561 (byte-defop 24 -1 byte-varbind "for binding a variable")
562 (byte-defop 32 0 byte-call "for calling a function")
563 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
564 ;; codes 8-47 are consumed by the preceding opcodes
566 ;; New (in Emacs-24.4) bytecodes for more efficient handling of non-local exits
567 ;; (especially useful in lexical-binding code).
568 (byte-defop 48 0 byte-pophandler)
569 (byte-defop 50 -1 byte-pushcatch)
570 (byte-defop 49 -1 byte-pushconditioncase)
572 ;; unused: 51-55
574 (byte-defop 56 -1 byte-nth)
575 (byte-defop 57 0 byte-symbolp)
576 (byte-defop 58 0 byte-consp)
577 (byte-defop 59 0 byte-stringp)
578 (byte-defop 60 0 byte-listp)
579 (byte-defop 61 -1 byte-eq)
580 (byte-defop 62 -1 byte-memq)
581 (byte-defop 63 0 byte-not)
582 (byte-defop 64 0 byte-car)
583 (byte-defop 65 0 byte-cdr)
584 (byte-defop 66 -1 byte-cons)
585 (byte-defop 67 0 byte-list1)
586 (byte-defop 68 -1 byte-list2)
587 (byte-defop 69 -2 byte-list3)
588 (byte-defop 70 -3 byte-list4)
589 (byte-defop 71 0 byte-length)
590 (byte-defop 72 -1 byte-aref)
591 (byte-defop 73 -2 byte-aset)
592 (byte-defop 74 0 byte-symbol-value)
593 (byte-defop 75 0 byte-symbol-function) ; this was commented out
594 (byte-defop 76 -1 byte-set)
595 (byte-defop 77 -1 byte-fset) ; this was commented out
596 (byte-defop 78 -1 byte-get)
597 (byte-defop 79 -2 byte-substring)
598 (byte-defop 80 -1 byte-concat2)
599 (byte-defop 81 -2 byte-concat3)
600 (byte-defop 82 -3 byte-concat4)
601 (byte-defop 83 0 byte-sub1)
602 (byte-defop 84 0 byte-add1)
603 (byte-defop 85 -1 byte-eqlsign)
604 (byte-defop 86 -1 byte-gtr)
605 (byte-defop 87 -1 byte-lss)
606 (byte-defop 88 -1 byte-leq)
607 (byte-defop 89 -1 byte-geq)
608 (byte-defop 90 -1 byte-diff)
609 (byte-defop 91 0 byte-negate)
610 (byte-defop 92 -1 byte-plus)
611 (byte-defop 93 -1 byte-max)
612 (byte-defop 94 -1 byte-min)
613 (byte-defop 95 -1 byte-mult) ; v19 only
614 (byte-defop 96 1 byte-point)
615 (byte-defop 98 0 byte-goto-char)
616 (byte-defop 99 0 byte-insert)
617 (byte-defop 100 1 byte-point-max)
618 (byte-defop 101 1 byte-point-min)
619 (byte-defop 102 0 byte-char-after)
620 (byte-defop 103 1 byte-following-char)
621 (byte-defop 104 1 byte-preceding-char)
622 (byte-defop 105 1 byte-current-column)
623 (byte-defop 106 0 byte-indent-to)
624 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
625 (byte-defop 108 1 byte-eolp)
626 (byte-defop 109 1 byte-eobp)
627 (byte-defop 110 1 byte-bolp)
628 (byte-defop 111 1 byte-bobp)
629 (byte-defop 112 1 byte-current-buffer)
630 (byte-defop 113 0 byte-set-buffer)
631 (byte-defop 114 0 byte-save-current-buffer
632 "To make a binding to record the current buffer")
633 (byte-defop 115 0 byte-set-mark-OBSOLETE)
634 (byte-defop 116 1 byte-interactive-p-OBSOLETE)
636 ;; These ops are new to v19
637 (byte-defop 117 0 byte-forward-char)
638 (byte-defop 118 0 byte-forward-word)
639 (byte-defop 119 -1 byte-skip-chars-forward)
640 (byte-defop 120 -1 byte-skip-chars-backward)
641 (byte-defop 121 0 byte-forward-line)
642 (byte-defop 122 0 byte-char-syntax)
643 (byte-defop 123 -1 byte-buffer-substring)
644 (byte-defop 124 -1 byte-delete-region)
645 (byte-defop 125 -1 byte-narrow-to-region)
646 (byte-defop 126 1 byte-widen)
647 (byte-defop 127 0 byte-end-of-line)
649 ;; unused: 128
651 ;; These store their argument in the next two bytes
652 (byte-defop 129 1 byte-constant2
653 "for reference to a constant with vector index >= byte-constant-limit")
654 (byte-defop 130 0 byte-goto "for unconditional jump")
655 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
656 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
657 (byte-defop 133 -1 byte-goto-if-nil-else-pop
658 "to examine top-of-stack, jump and don't pop it if it's nil,
659 otherwise pop it")
660 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
661 "to examine top-of-stack, jump and don't pop it if it's non nil,
662 otherwise pop it")
664 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
665 (byte-defop 136 -1 byte-discard "to discard one value from stack")
666 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
668 (byte-defop 138 0 byte-save-excursion
669 "to make a binding to record the buffer, point and mark")
670 (byte-defop 139 0 byte-save-window-excursion-OBSOLETE
671 "to make a binding to record entire window configuration")
672 (byte-defop 140 0 byte-save-restriction
673 "to make a binding to record the current buffer clipping restrictions")
674 (byte-defop 141 -1 byte-catch
675 "for catch. Takes, on stack, the tag and an expression for the body")
676 (byte-defop 142 -1 byte-unwind-protect
677 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
679 ;; For condition-case. Takes, on stack, the variable to bind,
680 ;; an expression for the body, and a list of clauses.
681 (byte-defop 143 -2 byte-condition-case)
683 (byte-defop 144 0 byte-temp-output-buffer-setup-OBSOLETE)
684 (byte-defop 145 -1 byte-temp-output-buffer-show-OBSOLETE)
686 ;; these ops are new to v19
688 ;; To unbind back to the beginning of this frame.
689 ;; Not used yet, but will be needed for tail-recursion elimination.
690 (byte-defop 146 0 byte-unbind-all)
692 ;; these ops are new to v19
693 (byte-defop 147 -2 byte-set-marker)
694 (byte-defop 148 0 byte-match-beginning)
695 (byte-defop 149 0 byte-match-end)
696 (byte-defop 150 0 byte-upcase)
697 (byte-defop 151 0 byte-downcase)
698 (byte-defop 152 -1 byte-string=)
699 (byte-defop 153 -1 byte-string<)
700 (byte-defop 154 -1 byte-equal)
701 (byte-defop 155 -1 byte-nthcdr)
702 (byte-defop 156 -1 byte-elt)
703 (byte-defop 157 -1 byte-member)
704 (byte-defop 158 -1 byte-assq)
705 (byte-defop 159 0 byte-nreverse)
706 (byte-defop 160 -1 byte-setcar)
707 (byte-defop 161 -1 byte-setcdr)
708 (byte-defop 162 0 byte-car-safe)
709 (byte-defop 163 0 byte-cdr-safe)
710 (byte-defop 164 -1 byte-nconc)
711 (byte-defop 165 -1 byte-quo)
712 (byte-defop 166 -1 byte-rem)
713 (byte-defop 167 0 byte-numberp)
714 (byte-defop 168 0 byte-integerp)
716 ;; unused: 169-174
717 (byte-defop 175 nil byte-listN)
718 (byte-defop 176 nil byte-concatN)
719 (byte-defop 177 nil byte-insertN)
721 (byte-defop 178 -1 byte-stack-set) ; Stack offset in following one byte.
722 (byte-defop 179 -1 byte-stack-set2) ; Stack offset in following two bytes.
724 ;; If (following one byte & 0x80) == 0
725 ;; discard (following one byte & 0x7F) stack entries
726 ;; else
727 ;; discard (following one byte & 0x7F) stack entries _underneath_ TOS
728 ;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
729 (byte-defop 182 nil byte-discardN)
730 ;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
731 ;; `byte-discardN' with the high bit in the operand set (by
732 ;; `byte-compile-lapcode').
733 (defconst byte-discardN-preserve-tos byte-discardN)
735 ;; unused: 182-191
737 (byte-defop 192 1 byte-constant "for reference to a constant")
738 ;; codes 193-255 are consumed by byte-constant.
739 (defconst byte-constant-limit 64
740 "Exclusive maximum index usable in the `byte-constant' opcode.")
742 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
743 byte-goto-if-nil-else-pop
744 byte-goto-if-not-nil-else-pop
745 byte-pushcatch byte-pushconditioncase)
746 "List of byte-codes whose offset is a pc.")
748 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
750 (byte-extrude-byte-code-vectors)
752 ;;; lapcode generator
754 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
755 ;; source -> bytecode, because it's a lot easier to make optimizations
756 ;; on lapcode than on bytecode.
758 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
759 ;; where instruction is a symbol naming a byte-code instruction,
760 ;; and parameter is an argument to that instruction, if any.
762 ;; The instruction can be the pseudo-op TAG, which means that this position
763 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
764 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
765 ;; parameter for some goto op.
767 ;; If the operation is varbind, varref, varset or push-constant, then the
768 ;; parameter is (variable/constant . index_in_constant_vector).
770 ;; First, the source code is macroexpanded and optimized in various ways.
771 ;; Then the resultant code is compiled into lapcode. Another set of
772 ;; optimizations are then run over the lapcode. Then the variables and
773 ;; constants referenced by the lapcode are collected and placed in the
774 ;; constants-vector. (This happens now so that variables referenced by dead
775 ;; code don't consume space.) And finally, the lapcode is transformed into
776 ;; compacted byte-code.
778 ;; A distinction is made between variables and constants because the variable-
779 ;; referencing instructions are more sensitive to the variables being near the
780 ;; front of the constants-vector than the constant-referencing instructions.
781 ;; Also, this lets us notice references to free variables.
783 (defmacro byte-compile-push-bytecodes (&rest args)
784 "Push bytes onto BVAR, and increment CVAR by the number of bytes pushed.
785 BVAR and CVAR are variables which are updated after evaluating
786 all the arguments.
788 \(fn BYTE1 BYTE2 ... BYTEn BVAR CVAR)"
789 (let ((byte-exprs (butlast args 2))
790 (bytes-var (car (last args 2)))
791 (pc-var (car (last args))))
792 `(setq ,bytes-var ,(if (null (cdr byte-exprs))
793 `(progn (cl-assert (<= 0 ,(car byte-exprs)))
794 (cons ,@byte-exprs ,bytes-var))
795 `(nconc (list ,@(reverse byte-exprs)) ,bytes-var))
796 ,pc-var (+ ,(length byte-exprs) ,pc-var))))
798 (defmacro byte-compile-push-bytecode-const2 (opcode const2 bytes pc)
799 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
800 CONST2 may be evaluated multiple times."
801 `(byte-compile-push-bytecodes ,opcode (logand ,const2 255) (lsh ,const2 -8)
802 ,bytes ,pc))
804 (defun byte-compile-lapcode (lap)
805 "Turns lapcode into bytecode. The lapcode is destroyed."
806 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
807 (let ((pc 0) ; Program counter
808 op off ; Operation & offset
809 opcode ; numeric value of OP
810 (bytes '()) ; Put the output bytes here
811 (patchlist nil)) ; List of gotos to patch
812 (dolist (lap-entry lap)
813 (setq op (car lap-entry)
814 off (cdr lap-entry))
815 (cond
816 ((not (symbolp op))
817 (error "Non-symbolic opcode ‘%s’" op))
818 ((eq op 'TAG)
819 (setcar off pc))
821 (setq opcode
822 (if (eq op 'byte-discardN-preserve-tos)
823 ;; byte-discardN-preserve-tos is a pseudo op, which
824 ;; is actually the same as byte-discardN
825 ;; with a modified argument.
826 byte-discardN
827 (symbol-value op)))
828 (cond ((memq op byte-goto-ops)
829 ;; goto
830 (byte-compile-push-bytecodes opcode nil (cdr off) bytes pc)
831 (push bytes patchlist))
832 ((or (and (consp off)
833 ;; Variable or constant reference
834 (progn
835 (setq off (cdr off))
836 (eq op 'byte-constant)))
837 (and (eq op 'byte-constant)
838 (integerp off)))
839 ;; constant ref
840 (if (< off byte-constant-limit)
841 (byte-compile-push-bytecodes (+ byte-constant off)
842 bytes pc)
843 (byte-compile-push-bytecode-const2 byte-constant2 off
844 bytes pc)))
845 ((and (= opcode byte-stack-set)
846 (> off 255))
847 ;; Use the two-byte version of byte-stack-set if the
848 ;; offset is too large for the normal version.
849 (byte-compile-push-bytecode-const2 byte-stack-set2 off
850 bytes pc))
851 ((and (>= opcode byte-listN)
852 (< opcode byte-discardN))
853 ;; These insns all put their operand into one extra byte.
854 (byte-compile-push-bytecodes opcode off bytes pc))
855 ((= opcode byte-discardN)
856 ;; byte-discardN is weird in that it encodes a flag in the
857 ;; top bit of its one-byte argument. If the argument is
858 ;; too large to fit in 7 bits, the opcode can be repeated.
859 (let ((flag (if (eq op 'byte-discardN-preserve-tos) #x80 0)))
860 (while (> off #x7f)
861 (byte-compile-push-bytecodes opcode (logior #x7f flag)
862 bytes pc)
863 (setq off (- off #x7f)))
864 (byte-compile-push-bytecodes opcode (logior off flag)
865 bytes pc)))
866 ((null off)
867 ;; opcode that doesn't use OFF
868 (byte-compile-push-bytecodes opcode bytes pc))
869 ((and (eq opcode byte-stack-ref) (eq off 0))
870 ;; (stack-ref 0) is really just another name for `dup'.
871 (debug) ;FIXME: When would this happen?
872 (byte-compile-push-bytecodes byte-dup bytes pc))
873 ;; The following three cases are for the special
874 ;; insns that encode their operand into 0, 1, or 2
875 ;; extra bytes depending on its magnitude.
876 ((< off 6)
877 (byte-compile-push-bytecodes (+ opcode off) bytes pc))
878 ((< off 256)
879 (byte-compile-push-bytecodes (+ opcode 6) off bytes pc))
881 (byte-compile-push-bytecode-const2 (+ opcode 7) off
882 bytes pc))))))
883 ;;(if (not (= pc (length bytes)))
884 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
885 ;; Patch tag PCs into absolute jumps.
886 (dolist (bytes-tail patchlist)
887 (setq pc (caar bytes-tail)) ; Pick PC from goto's tag.
888 (setcar (cdr bytes-tail) (logand pc 255))
889 (setcar bytes-tail (lsh pc -8))
890 ;; FIXME: Replace this by some workaround.
891 (if (> (car bytes-tail) 255) (error "Bytecode overflow")))
893 (apply 'unibyte-string (nreverse bytes))))
896 ;;; compile-time evaluation
898 (defun byte-compile-cl-file-p (file)
899 "Return non-nil if FILE is one of the CL files."
900 (and (stringp file)
901 (string-match "^cl\\.el" (file-name-nondirectory file))))
903 (defun byte-compile-eval (form)
904 "Eval FORM and mark the functions defined therein.
905 Each function's symbol gets added to `byte-compile-noruntime-functions'."
906 (let ((hist-orig load-history)
907 (hist-nil-orig current-load-list))
908 (prog1 (eval form lexical-binding)
909 (when (byte-compile-warning-enabled-p 'noruntime)
910 (let ((hist-new load-history)
911 (hist-nil-new current-load-list))
912 ;; Go through load-history, look for newly loaded files
913 ;; and mark all the functions defined therein.
914 (while (and hist-new (not (eq hist-new hist-orig)))
915 (let ((xs (pop hist-new))
916 old-autoloads)
917 ;; Make sure the file was not already loaded before.
918 (unless (assoc (car xs) hist-orig)
919 (dolist (s xs)
920 (cond
921 ((and (consp s) (eq t (car s)))
922 (push (cdr s) old-autoloads))
923 ((and (consp s) (memq (car s) '(autoload defun)))
924 (unless (memq (cdr s) old-autoloads)
925 (push (cdr s) byte-compile-noruntime-functions))))))))
926 ;; Go through current-load-list for the locally defined funs.
927 (let (old-autoloads)
928 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
929 (let ((s (pop hist-nil-new)))
930 (when (and (symbolp s) (not (memq s old-autoloads)))
931 (push s byte-compile-noruntime-functions))
932 (when (and (consp s) (eq t (car s)))
933 (push (cdr s) old-autoloads)))))))
934 (when (byte-compile-warning-enabled-p 'cl-functions)
935 (let ((hist-new load-history))
936 ;; Go through load-history, looking for the cl files.
937 ;; Since new files are added at the start of load-history,
938 ;; we scan the new history until the tail matches the old.
939 (while (and (not byte-compile-cl-functions)
940 hist-new (not (eq hist-new hist-orig)))
941 ;; We used to check if the file had already been loaded,
942 ;; but it is better to check non-nil byte-compile-cl-functions.
943 (and (byte-compile-cl-file-p (car (pop hist-new)))
944 (byte-compile-find-cl-functions))))))))
946 (defun byte-compile-eval-before-compile (form)
947 "Evaluate FORM for `eval-and-compile'."
948 (let ((hist-nil-orig current-load-list))
949 (prog1 (eval form lexical-binding)
950 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
951 ;; FIXME Why does it do that - just as a hack?
952 ;; There are other ways to do this nowadays.
953 (let ((tem current-load-list))
954 (while (not (eq tem hist-nil-orig))
955 (when (equal (car tem) '(require . cl))
956 (byte-compile-disable-warning 'cl-functions))
957 (setq tem (cdr tem)))))))
959 ;;; byte compiler messages
961 (defvar byte-compile-current-form nil)
962 (defvar byte-compile-dest-file nil)
963 (defvar byte-compile-current-file nil)
964 (defvar byte-compile-current-group nil)
965 (defvar byte-compile-current-buffer nil)
967 ;; Log something that isn't a warning.
968 (defmacro byte-compile-log (format-string &rest args)
969 `(and
970 byte-optimize
971 (memq byte-optimize-log '(t source))
972 (let ((print-escape-newlines t)
973 (print-level 4)
974 (print-length 4))
975 (byte-compile-log-1
976 (format-message
977 ,format-string
978 ,@(mapcar
979 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
980 args))))))
982 ;; Log something that isn't a warning.
983 (defun byte-compile-log-1 (string)
984 (with-current-buffer byte-compile-log-buffer
985 (let ((inhibit-read-only t))
986 (goto-char (point-max))
987 (byte-compile-warning-prefix nil nil)
988 (cond (noninteractive
989 (message " %s" string))
991 (insert (format "%s\n" string)))))))
993 (defvar byte-compile-read-position nil
994 "Character position we began the last `read' from.")
995 (defvar byte-compile-last-position nil
996 "Last known character position in the input.")
998 ;; copied from gnus-util.el
999 (defsubst byte-compile-delete-first (elt list)
1000 (if (eq (car list) elt)
1001 (cdr list)
1002 (let ((total list))
1003 (while (and (cdr list)
1004 (not (eq (cadr list) elt)))
1005 (setq list (cdr list)))
1006 (when (cdr list)
1007 (setcdr list (cddr list)))
1008 total)))
1010 ;; The purpose of this function is to iterate through the
1011 ;; `read-symbol-positions-list'. Each time we process, say, a
1012 ;; function definition (`defun') we remove `defun' from
1013 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
1014 ;; to that symbol's character position. Similarly, if we encounter a
1015 ;; variable reference, like in (1+ foo), we remove `foo' from the
1016 ;; list. If our current position is after the symbol's position, we
1017 ;; assume we've already passed that point, and look for the next
1018 ;; occurrence of the symbol.
1020 ;; This function should not be called twice for the same occurrence of
1021 ;; a symbol, and it should not be called for symbols generated by the
1022 ;; byte compiler itself; because rather than just fail looking up the
1023 ;; symbol, we may find an occurrence of the symbol further ahead, and
1024 ;; then `byte-compile-last-position' as advanced too far.
1026 ;; So your're probably asking yourself: Isn't this function a
1027 ;; gross hack? And the answer, of course, would be yes.
1028 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
1029 (when byte-compile-read-position
1030 (let (last entry)
1031 (while (progn
1032 (setq last byte-compile-last-position
1033 entry (assq sym read-symbol-positions-list))
1034 (when entry
1035 (setq byte-compile-last-position
1036 (+ byte-compile-read-position (cdr entry))
1037 read-symbol-positions-list
1038 (byte-compile-delete-first
1039 entry read-symbol-positions-list)))
1040 (or (and allow-previous
1041 (not (= last byte-compile-last-position)))
1042 (> last byte-compile-last-position)))))))
1044 (defvar byte-compile-last-warned-form nil)
1045 (defvar byte-compile-last-logged-file nil)
1046 (defvar byte-compile-root-dir nil
1047 "Directory relative to which file names in error messages are written.")
1049 ;; FIXME: We should maybe extend abbreviate-file-name with an optional DIR
1050 ;; argument to try and use a relative file-name.
1051 (defun byte-compile-abbreviate-file (file &optional dir)
1052 (let ((f1 (abbreviate-file-name file))
1053 (f2 (file-relative-name file dir)))
1054 (if (< (length f2) (length f1)) f2 f1)))
1056 ;; This is used as warning-prefix for the compiler.
1057 ;; It is always called with the warnings buffer current.
1058 (defun byte-compile-warning-prefix (level entry)
1059 (let* ((inhibit-read-only t)
1060 (dir (or byte-compile-root-dir default-directory))
1061 (file (cond ((stringp byte-compile-current-file)
1062 (format "%s:" (byte-compile-abbreviate-file
1063 byte-compile-current-file dir)))
1064 ((bufferp byte-compile-current-file)
1065 (format "Buffer %s:"
1066 (buffer-name byte-compile-current-file)))
1067 ;; We might be simply loading a file that
1068 ;; contains explicit calls to byte-compile functions.
1069 ((stringp load-file-name)
1070 (format "%s:" (byte-compile-abbreviate-file
1071 load-file-name dir)))
1072 (t "")))
1073 (pos (if (and byte-compile-current-file
1074 (integerp byte-compile-read-position))
1075 (with-current-buffer byte-compile-current-buffer
1076 (format "%d:%d:"
1077 (save-excursion
1078 (goto-char byte-compile-last-position)
1079 (1+ (count-lines (point-min) (point-at-bol))))
1080 (save-excursion
1081 (goto-char byte-compile-last-position)
1082 (1+ (current-column)))))
1083 ""))
1084 (form (if (eq byte-compile-current-form :end) "end of data"
1085 (or byte-compile-current-form "toplevel form"))))
1086 (when (or (and byte-compile-current-file
1087 (not (equal byte-compile-current-file
1088 byte-compile-last-logged-file)))
1089 (and byte-compile-current-form
1090 (not (eq byte-compile-current-form
1091 byte-compile-last-warned-form))))
1092 (insert (format "\nIn %s:\n" form)))
1093 (when level
1094 (insert (format "%s%s" file pos))))
1095 (setq byte-compile-last-logged-file byte-compile-current-file
1096 byte-compile-last-warned-form byte-compile-current-form)
1097 entry)
1099 ;; This no-op function is used as the value of warning-series
1100 ;; to tell inner calls to displaying-byte-compile-warnings
1101 ;; not to bind warning-series.
1102 (defun byte-compile-warning-series (&rest _ignore)
1103 nil)
1105 ;; (compile-mode) will cause this to be loaded.
1106 (declare-function compilation-forget-errors "compile" ())
1108 ;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
1109 ;; Return the position of the start of the page in the log buffer.
1110 ;; But do nothing in batch mode.
1111 (defun byte-compile-log-file ()
1112 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1113 (not noninteractive)
1114 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1115 (goto-char (point-max))
1116 (let* ((inhibit-read-only t)
1117 (dir (and byte-compile-current-file
1118 (file-name-directory byte-compile-current-file)))
1119 (was-same (equal default-directory dir))
1121 (when dir
1122 (unless was-same
1123 (insert (format-message "Leaving directory ‘%s’\n"
1124 default-directory))))
1125 (unless (bolp)
1126 (insert "\n"))
1127 (setq pt (point-marker))
1128 (if byte-compile-current-file
1129 (insert "\f\nCompiling "
1130 (if (stringp byte-compile-current-file)
1131 (concat "file " byte-compile-current-file)
1132 (concat "buffer "
1133 (buffer-name byte-compile-current-file)))
1134 " at " (current-time-string) "\n")
1135 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1136 (when dir
1137 (setq default-directory dir)
1138 (unless was-same
1139 (insert (format-message "Entering directory ‘%s’\n"
1140 default-directory))))
1141 (setq byte-compile-last-logged-file byte-compile-current-file
1142 byte-compile-last-warned-form nil)
1143 ;; Do this after setting default-directory.
1144 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1145 (compilation-forget-errors)
1146 pt))))
1148 ;; Log a message STRING in `byte-compile-log-buffer'.
1149 ;; Also log the current function and file if not already done.
1150 (defun byte-compile-log-warning (string &optional fill level)
1151 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1152 (warning-type-format "")
1153 (warning-fill-prefix (if fill " ")))
1154 (display-warning 'bytecomp string level byte-compile-log-buffer)))
1156 (defun byte-compile-warn (format &rest args)
1157 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1158 (setq format (apply #'format-message format args))
1159 (if byte-compile-error-on-warn
1160 (error "%s" format) ; byte-compile-file catches and logs it
1161 (byte-compile-log-warning format t :warning)))
1163 (defun byte-compile-warn-obsolete (symbol)
1164 "Warn that SYMBOL (a variable or function) is obsolete."
1165 (when (byte-compile-warning-enabled-p 'obsolete)
1166 (let* ((funcp (get symbol 'byte-obsolete-info))
1167 (msg (macroexp--obsolete-warning
1168 symbol
1169 (or funcp (get symbol 'byte-obsolete-variable))
1170 (if funcp "function" "variable"))))
1171 (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
1172 (byte-compile-warn "%s" msg)))))
1174 (defun byte-compile-report-error (error-info)
1175 "Report Lisp error in compilation.
1176 ERROR-INFO is the error data, in the form of either (ERROR-SYMBOL . DATA)
1177 or STRING."
1178 (setq byte-compiler-error-flag t)
1179 (byte-compile-log-warning
1180 (if (stringp error-info) error-info
1181 (error-message-string error-info))
1182 nil :error))
1184 ;;; sanity-checking arglists
1186 (defun byte-compile-fdefinition (name macro-p)
1187 ;; If a function has an entry saying (FUNCTION . t).
1188 ;; that means we know it is defined but we don't know how.
1189 ;; If a function has an entry saying (FUNCTION . nil),
1190 ;; that means treat it as not defined.
1191 (let* ((list (if macro-p
1192 byte-compile-macro-environment
1193 byte-compile-function-environment))
1194 (env (cdr (assq name list))))
1195 (or env
1196 (let ((fn name))
1197 (while (and (symbolp fn)
1198 (fboundp fn)
1199 (or (symbolp (symbol-function fn))
1200 (consp (symbol-function fn))
1201 (and (not macro-p)
1202 (byte-code-function-p (symbol-function fn)))))
1203 (setq fn (symbol-function fn)))
1204 (let ((advertised (gethash (if (and (symbolp fn) (fboundp fn))
1205 ;; Could be a subr.
1206 (symbol-function fn)
1208 advertised-signature-table t)))
1209 (cond
1210 ((listp advertised)
1211 (if macro-p
1212 `(macro lambda ,advertised)
1213 `(lambda ,advertised)))
1214 ((and (not macro-p) (byte-code-function-p fn)) fn)
1215 ((not (consp fn)) nil)
1216 ((eq 'macro (car fn)) (cdr fn))
1217 (macro-p nil)
1218 ((eq 'autoload (car fn)) nil)
1219 (t fn)))))))
1221 (defun byte-compile-arglist-signature (arglist)
1222 (cond
1223 ;; New style byte-code arglist.
1224 ((integerp arglist)
1225 (cons (logand arglist 127) ;Mandatory.
1226 (if (zerop (logand arglist 128)) ;No &rest.
1227 (lsh arglist -8)))) ;Nonrest.
1228 ;; Old style byte-code, or interpreted function.
1229 ((listp arglist)
1230 (let ((args 0)
1231 opts
1232 restp)
1233 (while arglist
1234 (cond ((eq (car arglist) '&optional)
1235 (or opts (setq opts 0)))
1236 ((eq (car arglist) '&rest)
1237 (if (cdr arglist)
1238 (setq restp t
1239 arglist nil)))
1241 (if opts
1242 (setq opts (1+ opts))
1243 (setq args (1+ args)))))
1244 (setq arglist (cdr arglist)))
1245 (cons args (if restp nil (if opts (+ args opts) args)))))
1246 ;; Unknown arglist.
1247 (t '(0))))
1250 (defun byte-compile-arglist-signatures-congruent-p (old new)
1251 (not (or
1252 (> (car new) (car old)) ; requires more args now
1253 (and (null (cdr old)) ; took rest-args, doesn't any more
1254 (cdr new))
1255 (and (cdr new) (cdr old) ; can't take as many args now
1256 (< (cdr new) (cdr old)))
1259 (defun byte-compile-arglist-signature-string (signature)
1260 (cond ((null (cdr signature))
1261 (format "%d+" (car signature)))
1262 ((= (car signature) (cdr signature))
1263 (format "%d" (car signature)))
1264 (t (format "%d-%d" (car signature) (cdr signature)))))
1266 (defun byte-compile-function-warn (f nargs def)
1267 (when (get f 'byte-obsolete-info)
1268 (byte-compile-warn-obsolete f))
1270 ;; Check to see if the function will be available at runtime
1271 ;; and/or remember its arity if it's unknown.
1272 (or (and (or def (fboundp f)) ; might be a subr or autoload.
1273 (not (memq f byte-compile-noruntime-functions)))
1274 (eq f byte-compile-current-form) ; ## This doesn't work
1275 ; with recursion.
1276 ;; It's a currently-undefined function.
1277 ;; Remember number of args in call.
1278 (let ((cons (assq f byte-compile-unresolved-functions)))
1279 (if cons
1280 (or (memq nargs (cdr cons))
1281 (push nargs (cdr cons)))
1282 (push (list f nargs)
1283 byte-compile-unresolved-functions)))))
1285 ;; Warn if the form is calling a function with the wrong number of arguments.
1286 (defun byte-compile-callargs-warn (form)
1287 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1288 (byte-compile-fdefinition (car form) t)))
1289 (sig (if (and def (not (eq def t)))
1290 (progn
1291 (and (eq (car-safe def) 'macro)
1292 (eq (car-safe (cdr-safe def)) 'lambda)
1293 (setq def (cdr def)))
1294 (byte-compile-arglist-signature
1295 (if (memq (car-safe def) '(declared lambda))
1296 (nth 1 def)
1297 (if (byte-code-function-p def)
1298 (aref def 0)
1299 '(&rest def)))))
1300 (if (subrp (symbol-function (car form)))
1301 (subr-arity (symbol-function (car form))))))
1302 (ncall (length (cdr form))))
1303 ;; Check many or unevalled from subr-arity.
1304 (if (and (cdr-safe sig)
1305 (not (numberp (cdr sig))))
1306 (setcdr sig nil))
1307 (if sig
1308 (when (or (< ncall (car sig))
1309 (and (cdr sig) (> ncall (cdr sig))))
1310 (byte-compile-set-symbol-position (car form))
1311 (byte-compile-warn
1312 "%s called with %d argument%s, but %s %s"
1313 (car form) ncall
1314 (if (= 1 ncall) "" "s")
1315 (if (< ncall (car sig))
1316 "requires"
1317 "accepts only")
1318 (byte-compile-arglist-signature-string sig))))
1319 (byte-compile-format-warn form)
1320 (byte-compile-function-warn (car form) (length (cdr form)) def)))
1322 (defun byte-compile-format-warn (form)
1323 "Warn if FORM is `format'-like with inconsistent args.
1324 Applies if head of FORM is a symbol with non-nil property
1325 `byte-compile-format-like' and first arg is a constant string.
1326 Then check the number of format fields matches the number of
1327 extra args."
1328 (when (and (symbolp (car form))
1329 (stringp (nth 1 form))
1330 (get (car form) 'byte-compile-format-like))
1331 (let ((nfields (with-temp-buffer
1332 (insert (nth 1 form))
1333 (goto-char (point-min))
1334 (let ((n 0))
1335 (while (re-search-forward "%." nil t)
1336 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1337 (setq n (1+ n))))
1338 n)))
1339 (nargs (- (length form) 2)))
1340 (unless (= nargs nfields)
1341 (byte-compile-warn
1342 "‘%s’ called with %d args to fill %d format field(s)" (car form)
1343 nargs nfields)))))
1345 (dolist (elt '(format message error))
1346 (put elt 'byte-compile-format-like t))
1348 ;; Warn if a custom definition fails to specify :group.
1349 (defun byte-compile-nogroup-warn (form)
1350 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1351 byte-compile-current-group)
1352 ;; The group will be provided implicitly.
1354 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1355 (name (cadr form)))
1356 (or (not (eq (car-safe name) 'quote))
1357 (and (eq (car form) 'custom-declare-group)
1358 (equal name ''emacs))
1359 (plist-get keyword-args :group)
1360 (not (and (consp name) (eq (car name) 'quote)))
1361 (byte-compile-warn
1362 "%s for ‘%s’ fails to specify containing group"
1363 (cdr (assq (car form)
1364 '((custom-declare-group . defgroup)
1365 (custom-declare-face . defface)
1366 (custom-declare-variable . defcustom))))
1367 (cadr name)))
1368 ;; Update the current group, if needed.
1369 (if (and byte-compile-current-file ;Only when compiling a whole file.
1370 (eq (car form) 'custom-declare-group)
1371 (eq (car-safe name) 'quote))
1372 (setq byte-compile-current-group (cadr name))))))
1374 ;; Warn if the function or macro is being redefined with a different
1375 ;; number of arguments.
1376 (defun byte-compile-arglist-warn (name arglist macrop)
1377 ;; This is the first definition. See if previous calls are compatible.
1378 (let ((calls (assq name byte-compile-unresolved-functions))
1379 nums sig min max)
1380 (when (and calls macrop)
1381 (byte-compile-warn "macro ‘%s’ defined too late" name))
1382 (setq byte-compile-unresolved-functions
1383 (delq calls byte-compile-unresolved-functions))
1384 (setq calls (delq t calls)) ;Ignore higher-order uses of the function.
1385 (when (cdr calls)
1386 (when (and (symbolp name)
1387 (eq (function-get name 'byte-optimizer)
1388 'byte-compile-inline-expand))
1389 (byte-compile-warn "defsubst ‘%s’ was used before it was defined"
1390 name))
1391 (setq sig (byte-compile-arglist-signature arglist)
1392 nums (sort (copy-sequence (cdr calls)) (function <))
1393 min (car nums)
1394 max (car (nreverse nums)))
1395 (when (or (< min (car sig))
1396 (and (cdr sig) (> max (cdr sig))))
1397 (byte-compile-set-symbol-position name)
1398 (byte-compile-warn
1399 "%s being defined to take %s%s, but was previously called with %s"
1400 name
1401 (byte-compile-arglist-signature-string sig)
1402 (if (equal sig '(1 . 1)) " arg" " args")
1403 (byte-compile-arglist-signature-string (cons min max))))))
1404 (let* ((old (byte-compile-fdefinition name macrop))
1405 (initial (and macrop
1406 (cdr (assq name
1407 byte-compile-initial-macro-environment)))))
1408 ;; Assumes an element of b-c-i-macro-env that is a symbol points
1409 ;; to a defined function. (Bug#8646)
1410 (and initial (symbolp initial)
1411 (setq old (byte-compile-fdefinition initial nil)))
1412 (when (and old (not (eq old t)))
1413 (and (eq 'macro (car-safe old))
1414 (eq 'lambda (car-safe (cdr-safe old)))
1415 (setq old (cdr old)))
1416 (let ((sig1 (byte-compile-arglist-signature
1417 (pcase old
1418 (`(lambda ,args . ,_) args)
1419 (`(closure ,_ ,args . ,_) args)
1420 ((pred byte-code-function-p) (aref old 0))
1421 (_ '(&rest def)))))
1422 (sig2 (byte-compile-arglist-signature arglist)))
1423 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1424 (byte-compile-set-symbol-position name)
1425 (byte-compile-warn
1426 "%s %s used to take %s %s, now takes %s"
1427 (if macrop "macro" "function")
1428 name
1429 (byte-compile-arglist-signature-string sig1)
1430 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1431 (byte-compile-arglist-signature-string sig2)))))))
1433 (defvar byte-compile-cl-functions nil
1434 "List of functions defined in CL.")
1436 ;; Can't just add this to cl-load-hook, because that runs just before
1437 ;; the forms from cl.el get added to load-history.
1438 (defun byte-compile-find-cl-functions ()
1439 (unless byte-compile-cl-functions
1440 (dolist (elt load-history)
1441 (and (byte-compile-cl-file-p (car elt))
1442 (dolist (e (cdr elt))
1443 ;; Includes the cl-foo functions that cl autoloads.
1444 (when (memq (car-safe e) '(autoload defun))
1445 (push (cdr e) byte-compile-cl-functions)))))))
1447 (defun byte-compile-cl-warn (form)
1448 "Warn if FORM is a call of a function from the CL package."
1449 (let ((func (car-safe form)))
1450 (if (and byte-compile-cl-functions
1451 (memq func byte-compile-cl-functions)
1452 ;; Aliases which won't have been expanded at this point.
1453 ;; These aren't all aliases of subrs, so not trivial to
1454 ;; avoid hardwiring the list.
1455 (not (memq func
1456 '(cl--block-wrapper cl--block-throw
1457 multiple-value-call nth-value
1458 copy-seq first second rest endp cl-member
1459 ;; These are included in generated code
1460 ;; that can't be called except at compile time
1461 ;; or unless cl is loaded anyway.
1462 cl--defsubst-expand cl-struct-setf-expander
1463 ;; These would sometimes be warned about
1464 ;; but such warnings are never useful,
1465 ;; so don't warn about them.
1466 macroexpand
1467 cl--compiling-file))))
1468 (byte-compile-warn "function ‘%s’ from cl package called at runtime"
1469 func)))
1470 form)
1472 (defun byte-compile-print-syms (str1 strn syms)
1473 (when syms
1474 (byte-compile-set-symbol-position (car syms) t))
1475 (cond ((and (cdr syms) (not noninteractive))
1476 (let* ((str strn)
1477 (L (length str))
1479 (while syms
1480 (setq s (symbol-name (pop syms))
1481 L (+ L (length s) 2))
1482 (if (< L (1- fill-column))
1483 (setq str (concat str " " s (and syms ",")))
1484 (setq str (concat str "\n " s (and syms ","))
1485 L (+ (length s) 4))))
1486 (byte-compile-warn "%s" str)))
1487 ((cdr syms)
1488 (byte-compile-warn "%s %s"
1489 strn
1490 (mapconcat #'symbol-name syms ", ")))
1492 (syms
1493 (byte-compile-warn str1 (car syms)))))
1495 ;; If we have compiled any calls to functions which are not known to be
1496 ;; defined, issue a warning enumerating them.
1497 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1498 (defun byte-compile-warn-about-unresolved-functions ()
1499 (when (byte-compile-warning-enabled-p 'unresolved)
1500 (let ((byte-compile-current-form :end)
1501 (noruntime nil)
1502 (unresolved nil))
1503 ;; Separate the functions that will not be available at runtime
1504 ;; from the truly unresolved ones.
1505 (dolist (f byte-compile-unresolved-functions)
1506 (setq f (car f))
1507 (if (fboundp f) (push f noruntime) (push f unresolved)))
1508 ;; Complain about the no-run-time functions
1509 (byte-compile-print-syms
1510 "the function ‘%s’ might not be defined at runtime."
1511 "the following functions might not be defined at runtime:"
1512 noruntime)
1513 ;; Complain about the unresolved functions
1514 (byte-compile-print-syms
1515 "the function ‘%s’ is not known to be defined."
1516 "the following functions are not known to be defined:"
1517 unresolved)))
1518 nil)
1521 ;; Dynamically bound in byte-compile-from-buffer.
1522 ;; NB also used in cl.el and cl-macs.el.
1523 (defvar byte-compile--outbuffer)
1525 (defmacro byte-compile-close-variables (&rest body)
1526 (declare (debug t))
1527 `(let (;;
1528 ;; Close over these variables to encapsulate the
1529 ;; compilation state
1531 (byte-compile-macro-environment
1532 ;; Copy it because the compiler may patch into the
1533 ;; macroenvironment.
1534 (copy-alist byte-compile-initial-macro-environment))
1535 (byte-compile--outbuffer nil)
1536 (byte-compile-function-environment nil)
1537 (byte-compile-bound-variables nil)
1538 (byte-compile-lexical-variables nil)
1539 (byte-compile-const-variables nil)
1540 (byte-compile-free-references nil)
1541 (byte-compile-free-assignments nil)
1543 ;; Close over these variables so that `byte-compiler-options'
1544 ;; can change them on a per-file basis.
1546 (byte-compile-verbose byte-compile-verbose)
1547 (byte-optimize byte-optimize)
1548 (byte-compile-dynamic byte-compile-dynamic)
1549 (byte-compile-dynamic-docstrings
1550 byte-compile-dynamic-docstrings)
1551 ;; (byte-compile-generate-emacs19-bytecodes
1552 ;; byte-compile-generate-emacs19-bytecodes)
1553 (byte-compile-warnings byte-compile-warnings)
1555 ,@body))
1557 (defmacro displaying-byte-compile-warnings (&rest body)
1558 (declare (debug t))
1559 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1560 (warning-series-started
1561 (and (markerp warning-series)
1562 (eq (marker-buffer warning-series)
1563 (get-buffer byte-compile-log-buffer)))))
1564 (byte-compile-find-cl-functions)
1565 (if (or (eq warning-series 'byte-compile-warning-series)
1566 warning-series-started)
1567 ;; warning-series does come from compilation,
1568 ;; so don't bind it, but maybe do set it.
1569 (let (tem)
1570 ;; Log the file name. Record position of that text.
1571 (setq tem (byte-compile-log-file))
1572 (unless warning-series-started
1573 (setq warning-series (or tem 'byte-compile-warning-series)))
1574 (if byte-compile-debug
1575 (funcall --displaying-byte-compile-warnings-fn)
1576 (condition-case error-info
1577 (funcall --displaying-byte-compile-warnings-fn)
1578 (error (byte-compile-report-error error-info)))))
1579 ;; warning-series does not come from compilation, so bind it.
1580 (let ((warning-series
1581 ;; Log the file name. Record position of that text.
1582 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1583 (if byte-compile-debug
1584 (funcall --displaying-byte-compile-warnings-fn)
1585 (condition-case error-info
1586 (funcall --displaying-byte-compile-warnings-fn)
1587 (error (byte-compile-report-error error-info))))))))
1589 ;;;###autoload
1590 (defun byte-force-recompile (directory)
1591 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1592 Files in subdirectories of DIRECTORY are processed also."
1593 (interactive "DByte force recompile (directory): ")
1594 (byte-recompile-directory directory nil t))
1596 ;;;###autoload
1597 (defun byte-recompile-directory (directory &optional arg force)
1598 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1599 This happens when a `.elc' file exists but is older than the `.el' file.
1600 Files in subdirectories of DIRECTORY are processed also.
1602 If the `.elc' file does not exist, normally this function *does not*
1603 compile the corresponding `.el' file. However, if the prefix argument
1604 ARG is 0, that means do compile all those files. A nonzero
1605 ARG means ask the user, for each such `.el' file, whether to
1606 compile it. A nonzero ARG also means ask about each subdirectory
1607 before scanning it.
1609 If the third argument FORCE is non-nil, recompile every `.el' file
1610 that already has a `.elc' file."
1611 (interactive "DByte recompile directory: \nP")
1612 (if arg (setq arg (prefix-numeric-value arg)))
1613 (if noninteractive
1615 (save-some-buffers)
1616 (force-mode-line-update))
1617 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1618 (setq default-directory (expand-file-name directory))
1619 ;; compilation-mode copies value of default-directory.
1620 (unless (eq major-mode 'compilation-mode)
1621 (compilation-mode))
1622 (let ((directories (list default-directory))
1623 (default-directory default-directory)
1624 (skip-count 0)
1625 (fail-count 0)
1626 (file-count 0)
1627 (dir-count 0)
1628 last-dir)
1629 (displaying-byte-compile-warnings
1630 (while directories
1631 (setq directory (car directories))
1632 (message "Checking %s..." directory)
1633 (dolist (file (directory-files directory))
1634 (let ((source (expand-file-name file directory)))
1635 (if (file-directory-p source)
1636 (and (not (member file '("RCS" "CVS")))
1637 (not (eq ?\. (aref file 0)))
1638 (not (file-symlink-p source))
1639 ;; This file is a subdirectory. Handle them differently.
1640 (or (null arg) (eq 0 arg)
1641 (y-or-n-p (concat "Check " source "? ")))
1642 (setq directories (nconc directories (list source))))
1643 ;; It is an ordinary file. Decide whether to compile it.
1644 (if (and (string-match emacs-lisp-file-regexp source)
1645 ;; The next 2 tests avoid compiling lock files
1646 (file-readable-p source)
1647 (not (string-match "\\`\\.#" file))
1648 (not (auto-save-file-name-p source))
1649 (not (string-equal dir-locals-file
1650 (file-name-nondirectory source))))
1651 (progn (cl-incf
1652 (pcase (byte-recompile-file source force arg)
1653 (`no-byte-compile skip-count)
1654 (`t file-count)
1655 (_ fail-count)))
1656 (or noninteractive
1657 (message "Checking %s..." directory))
1658 (if (not (eq last-dir directory))
1659 (setq last-dir directory
1660 dir-count (1+ dir-count)))
1661 )))))
1662 (setq directories (cdr directories))))
1663 (message "Done (Total of %d file%s compiled%s%s%s)"
1664 file-count (if (= file-count 1) "" "s")
1665 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1666 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1667 (if (> dir-count 1)
1668 (format " in %d directories" dir-count) "")))))
1670 (defvar no-byte-compile nil
1671 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1672 This is normally set in local file variables at the end of the elisp file:
1674 \;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
1675 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1677 (defun byte-recompile-file (filename &optional force arg load)
1678 "Recompile FILENAME file if it needs recompilation.
1679 This happens when its `.elc' file is older than itself.
1681 If the `.elc' file exists and is up-to-date, normally this function
1682 *does not* compile FILENAME. If the prefix argument FORCE is non-nil,
1683 however, it compiles FILENAME even if the destination already
1684 exists and is up-to-date.
1686 If the `.elc' file does not exist, normally this function *does not*
1687 compile FILENAME. If optional argument ARG is 0, it compiles
1688 the input file even if the `.elc' file does not exist.
1689 Any other non-nil value of ARG means to ask the user.
1691 If optional argument LOAD is non-nil, loads the file after compiling.
1693 If compilation is needed, this functions returns the result of
1694 `byte-compile-file'; otherwise it returns 'no-byte-compile."
1695 (interactive
1696 (let ((file buffer-file-name)
1697 (file-name nil)
1698 (file-dir nil))
1699 (and file
1700 (derived-mode-p 'emacs-lisp-mode)
1701 (setq file-name (file-name-nondirectory file)
1702 file-dir (file-name-directory file)))
1703 (list (read-file-name (if current-prefix-arg
1704 "Byte compile file: "
1705 "Byte recompile file: ")
1706 file-dir file-name nil)
1707 current-prefix-arg)))
1708 (let ((dest (byte-compile-dest-file filename))
1709 ;; Expand now so we get the current buffer's defaults
1710 (filename (expand-file-name filename)))
1711 (if (if (file-exists-p dest)
1712 ;; File was already compiled
1713 ;; Compile if forced to, or filename newer
1714 (or force
1715 (file-newer-than-file-p filename dest))
1716 (and arg
1717 (or (eq 0 arg)
1718 (y-or-n-p (concat "Compile "
1719 filename "? ")))))
1720 (progn
1721 (if (and noninteractive (not byte-compile-verbose))
1722 (message "Compiling %s..." filename))
1723 (byte-compile-file filename load))
1724 (when load
1725 (load (if (file-exists-p dest) dest filename)))
1726 'no-byte-compile)))
1728 (defvar byte-compile-level 0 ; bug#13787
1729 "Depth of a recursive byte compilation.")
1731 ;;;###autoload
1732 (defun byte-compile-file (filename &optional load)
1733 "Compile a file of Lisp code named FILENAME into a file of byte code.
1734 The output file's name is generated by passing FILENAME to the
1735 function `byte-compile-dest-file' (which see).
1736 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1737 The value is non-nil if there were no errors, nil if errors."
1738 ;; (interactive "fByte compile file: \nP")
1739 (interactive
1740 (let ((file buffer-file-name)
1741 (file-dir nil))
1742 (and file
1743 (derived-mode-p 'emacs-lisp-mode)
1744 (setq file-dir (file-name-directory file)))
1745 (list (read-file-name (if current-prefix-arg
1746 "Byte compile and load file: "
1747 "Byte compile file: ")
1748 file-dir buffer-file-name nil)
1749 current-prefix-arg)))
1750 ;; Expand now so we get the current buffer's defaults
1751 (setq filename (expand-file-name filename))
1753 ;; If we're compiling a file that's in a buffer and is modified, offer
1754 ;; to save it first.
1755 (or noninteractive
1756 (let ((b (get-file-buffer (expand-file-name filename))))
1757 (if (and b (buffer-modified-p b)
1758 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1759 (with-current-buffer b (save-buffer)))))
1761 ;; Force logging of the file name for each file compiled.
1762 (setq byte-compile-last-logged-file nil)
1763 (let ((byte-compile-current-file filename)
1764 (byte-compile-current-group nil)
1765 (set-auto-coding-for-load t)
1766 target-file input-buffer output-buffer
1767 byte-compile-dest-file)
1768 (setq target-file (byte-compile-dest-file filename))
1769 (setq byte-compile-dest-file target-file)
1770 (with-current-buffer
1771 ;; It would be cleaner to use a temp buffer, but if there was
1772 ;; an error, we leave this buffer around for diagnostics.
1773 ;; Its name is documented in the lispref.
1774 (setq input-buffer (get-buffer-create
1775 (concat " *Compiler Input*"
1776 (if (zerop byte-compile-level) ""
1777 (format "-%s" byte-compile-level)))))
1778 (erase-buffer)
1779 (setq buffer-file-coding-system nil)
1780 ;; Always compile an Emacs Lisp file as multibyte
1781 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1782 (set-buffer-multibyte t)
1783 (insert-file-contents filename)
1784 ;; Mimic the way after-insert-file-set-coding can make the
1785 ;; buffer unibyte when visiting this file.
1786 (when (or (eq last-coding-system-used 'no-conversion)
1787 (eq (coding-system-type last-coding-system-used) 5))
1788 ;; For coding systems no-conversion and raw-text...,
1789 ;; edit the buffer as unibyte.
1790 (set-buffer-multibyte nil))
1791 ;; Run hooks including the uncompression hook.
1792 ;; If they change the file name, then change it for the output also.
1793 (let ((buffer-file-name filename)
1794 (dmm (default-value 'major-mode))
1795 ;; Ignore unsafe local variables.
1796 ;; We only care about a few of them for our purposes.
1797 (enable-local-variables :safe)
1798 (enable-local-eval nil))
1799 (unwind-protect
1800 (progn
1801 (setq-default major-mode 'emacs-lisp-mode)
1802 ;; Arg of t means don't alter enable-local-variables.
1803 (delay-mode-hooks (normal-mode t)))
1804 (setq-default major-mode dmm))
1805 ;; There may be a file local variable setting (bug#10419).
1806 (setq buffer-read-only nil
1807 filename buffer-file-name))
1808 ;; Don't inherit lexical-binding from caller (bug#12938).
1809 (unless (local-variable-p 'lexical-binding)
1810 (setq-local lexical-binding nil))
1811 ;; Set the default directory, in case an eval-when-compile uses it.
1812 (setq default-directory (file-name-directory filename)))
1813 ;; Check if the file's local variables explicitly specify not to
1814 ;; compile this file.
1815 (if (with-current-buffer input-buffer no-byte-compile)
1816 (progn
1817 ;; (message "%s not compiled because of ‘no-byte-compile: %s’"
1818 ;; (byte-compile-abbreviate-file filename)
1819 ;; (with-current-buffer input-buffer no-byte-compile))
1820 (when (file-exists-p target-file)
1821 (message "%s deleted because of ‘no-byte-compile: %s’"
1822 (byte-compile-abbreviate-file target-file)
1823 (buffer-local-value 'no-byte-compile input-buffer))
1824 (condition-case nil (delete-file target-file) (error nil)))
1825 ;; We successfully didn't compile this file.
1826 'no-byte-compile)
1827 (when byte-compile-verbose
1828 (message "Compiling %s..." filename))
1829 (setq byte-compiler-error-flag nil)
1830 ;; It is important that input-buffer not be current at this call,
1831 ;; so that the value of point set in input-buffer
1832 ;; within byte-compile-from-buffer lingers in that buffer.
1833 (setq output-buffer
1834 (save-current-buffer
1835 (let ((byte-compile-level (1+ byte-compile-level)))
1836 (byte-compile-from-buffer input-buffer))))
1837 (if byte-compiler-error-flag
1839 (when byte-compile-verbose
1840 (message "Compiling %s...done" filename))
1841 (kill-buffer input-buffer)
1842 (with-current-buffer output-buffer
1843 (goto-char (point-max))
1844 (insert "\n") ; aaah, unix.
1845 (if (file-writable-p target-file)
1846 ;; We must disable any code conversion here.
1847 (let* ((coding-system-for-write 'no-conversion)
1848 ;; Write to a tempfile so that if another Emacs
1849 ;; process is trying to load target-file (eg in a
1850 ;; parallel bootstrap), it does not risk getting a
1851 ;; half-finished file. (Bug#4196)
1852 (tempfile (make-temp-name target-file))
1853 (kill-emacs-hook
1854 (cons (lambda () (ignore-errors (delete-file tempfile)))
1855 kill-emacs-hook)))
1856 (write-region (point-min) (point-max) tempfile nil 1)
1857 ;; This has the intentional side effect that any
1858 ;; hard-links to target-file continue to
1859 ;; point to the old file (this makes it possible
1860 ;; for installed files to share disk space with
1861 ;; the build tree, without causing problems when
1862 ;; emacs-lisp files in the build tree are
1863 ;; recompiled). Previously this was accomplished by
1864 ;; deleting target-file before writing it.
1865 (rename-file tempfile target-file t)
1866 (or noninteractive (message "Wrote %s" target-file)))
1867 ;; This is just to give a better error message than write-region
1868 (signal 'file-error
1869 (list "Opening output file"
1870 (if (file-exists-p target-file)
1871 "Cannot overwrite file"
1872 "Directory not writable or nonexistent")
1873 target-file)))
1874 (kill-buffer (current-buffer)))
1875 (if (and byte-compile-generate-call-tree
1876 (or (eq t byte-compile-generate-call-tree)
1877 (y-or-n-p (format "Report call tree for %s? "
1878 filename))))
1879 (save-excursion
1880 (display-call-tree filename)))
1881 (if load
1882 (load target-file))
1883 t))))
1885 ;;; compiling a single function
1886 ;;;###autoload
1887 (defun compile-defun (&optional arg)
1888 "Compile and evaluate the current top-level form.
1889 Print the result in the echo area.
1890 With argument ARG, insert value in current buffer after the form."
1891 (interactive "P")
1892 (save-excursion
1893 (end-of-defun)
1894 (beginning-of-defun)
1895 (let* ((byte-compile-current-file nil)
1896 (byte-compile-current-buffer (current-buffer))
1897 (byte-compile-read-position (point))
1898 (byte-compile-last-position byte-compile-read-position)
1899 (byte-compile-last-warned-form 'nothing)
1900 (value (eval
1901 (let ((read-with-symbol-positions (current-buffer))
1902 (read-symbol-positions-list nil))
1903 (displaying-byte-compile-warnings
1904 (byte-compile-sexp (read (current-buffer)))))
1905 lexical-binding)))
1906 (cond (arg
1907 (message "Compiling from buffer... done.")
1908 (prin1 value (current-buffer))
1909 (insert "\n"))
1910 ((message "%s" (prin1-to-string value)))))))
1912 (defun byte-compile-from-buffer (inbuffer)
1913 (let ((byte-compile-current-buffer inbuffer)
1914 (byte-compile-read-position nil)
1915 (byte-compile-last-position nil)
1916 ;; Prevent truncation of flonums and lists as we read and print them
1917 (float-output-format nil)
1918 (case-fold-search nil)
1919 (print-length nil)
1920 (print-level nil)
1921 ;; Prevent edebug from interfering when we compile
1922 ;; and put the output into a file.
1923 ;; (edebug-all-defs nil)
1924 ;; (edebug-all-forms nil)
1925 ;; Simulate entry to byte-compile-top-level
1926 (byte-compile-constants nil)
1927 (byte-compile-variables nil)
1928 (byte-compile-tag-number 0)
1929 (byte-compile-depth 0)
1930 (byte-compile-maxdepth 0)
1931 (byte-compile-output nil)
1932 ;; This allows us to get the positions of symbols read; it's
1933 ;; new in Emacs 22.1.
1934 (read-with-symbol-positions inbuffer)
1935 (read-symbol-positions-list nil)
1936 ;; #### This is bound in b-c-close-variables.
1937 ;; (byte-compile-warnings byte-compile-warnings)
1939 (byte-compile-close-variables
1940 (with-current-buffer
1941 (setq byte-compile--outbuffer
1942 (get-buffer-create
1943 (concat " *Compiler Output*"
1944 (if (<= byte-compile-level 1) ""
1945 (format "-%s" (1- byte-compile-level))))))
1946 (set-buffer-multibyte t)
1947 (erase-buffer)
1948 ;; (emacs-lisp-mode)
1949 (setq case-fold-search nil))
1950 (displaying-byte-compile-warnings
1951 (with-current-buffer inbuffer
1952 (and byte-compile-current-file
1953 (byte-compile-insert-header byte-compile-current-file
1954 byte-compile--outbuffer))
1955 (goto-char (point-min))
1956 ;; Should we always do this? When calling multiple files, it
1957 ;; would be useful to delay this warning until all have been
1958 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1959 ;; previous byte-compile.
1960 (setq byte-compile-unresolved-functions nil)
1962 ;; Compile the forms from the input buffer.
1963 (while (progn
1964 (while (progn (skip-chars-forward " \t\n\^l")
1965 (looking-at ";"))
1966 (forward-line 1))
1967 (not (eobp)))
1968 (setq byte-compile-read-position (point)
1969 byte-compile-last-position byte-compile-read-position)
1970 (let* ((old-style-backquotes nil)
1971 (form (read inbuffer)))
1972 ;; Warn about the use of old-style backquotes.
1973 (when old-style-backquotes
1974 (byte-compile-warn "!! The file uses old-style backquotes !!
1975 This functionality has been obsolete for more than 10 years already
1976 and will be removed soon. See (elisp)Backquote in the manual."))
1977 (byte-compile-toplevel-file-form form)))
1978 ;; Compile pending forms at end of file.
1979 (byte-compile-flush-pending)
1980 ;; Make warnings about unresolved functions
1981 ;; give the end of the file as their position.
1982 (setq byte-compile-last-position (point-max))
1983 (byte-compile-warn-about-unresolved-functions))
1984 ;; Fix up the header at the front of the output
1985 ;; if the buffer contains multibyte characters.
1986 (and byte-compile-current-file
1987 (with-current-buffer byte-compile--outbuffer
1988 (byte-compile-fix-header byte-compile-current-file))))
1989 byte-compile--outbuffer)))
1991 (defun byte-compile-fix-header (_filename)
1992 "If the current buffer has any multibyte characters, insert a version test."
1993 (when (< (point-max) (position-bytes (point-max)))
1994 (goto-char (point-min))
1995 ;; Find the comment that describes the version condition.
1996 (search-forward "\n;;; This file uses")
1997 (narrow-to-region (line-beginning-position) (point-max))
1998 ;; Find the first line of ballast semicolons.
1999 (search-forward ";;;;;;;;;;")
2000 (beginning-of-line)
2001 (narrow-to-region (point-min) (point))
2002 (let ((old-header-end (point))
2003 (minimum-version "23")
2004 delta)
2005 (delete-region (point-min) (point-max))
2006 (insert
2007 ";;; This file contains utf-8 non-ASCII characters,\n"
2008 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
2009 ;; Have to check if emacs-version is bound so that this works
2010 ;; in files loaded early in loadup.el.
2011 "(and (boundp 'emacs-version)\n"
2012 ;; If there is a name at the end of emacs-version,
2013 ;; don't try to check the version number.
2014 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
2015 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
2016 ;; Because the header must fit in a fixed width, we cannot
2017 ;; insert arbitrary-length file names (Bug#11585).
2018 " (error \"'%s' was compiled for "
2019 (format "Emacs %s or later\" #$))\n\n" minimum-version))
2020 ;; Now compensate for any change in size, to make sure all
2021 ;; positions in the file remain valid.
2022 (setq delta (- (point-max) old-header-end))
2023 (goto-char (point-max))
2024 (widen)
2025 (delete-char delta))))
2027 (defun byte-compile-insert-header (_filename outbuffer)
2028 "Insert a header at the start of OUTBUFFER.
2029 Call from the source buffer."
2030 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
2031 (dynamic byte-compile-dynamic)
2032 (optimize byte-optimize))
2033 (with-current-buffer outbuffer
2034 (goto-char (point-min))
2035 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
2036 ;; that is the file-format version number (18, 19, 20, or 23) as a
2037 ;; byte, followed by some nulls. The primary motivation for doing
2038 ;; this is to get some binary characters up in the first line of
2039 ;; the file so that `diff' will simply say "Binary files differ"
2040 ;; instead of actually doing a diff of two .elc files. An extra
2041 ;; benefit is that you can add this to /etc/magic:
2042 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
2043 ;; >4 byte x version %d
2044 (insert
2045 ";ELC" 23 "\000\000\000\n"
2046 ";;; Compiled\n"
2047 ";;; in Emacs version " emacs-version "\n"
2048 ";;; with"
2049 (cond
2050 ((eq optimize 'source) " source-level optimization only")
2051 ((eq optimize 'byte) " byte-level optimization only")
2052 (optimize " all optimizations")
2053 (t "out optimization"))
2054 ".\n"
2055 (if dynamic ";;; Function definitions are lazy-loaded.\n"
2057 "\n;;; This file uses "
2058 (if dynamic-docstrings
2059 "dynamic docstrings, first added in Emacs 19.29"
2060 "opcodes that do not exist in Emacs 18")
2061 ".\n\n"
2062 ;; Note that byte-compile-fix-header may change this.
2063 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2064 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2065 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2066 ;; can delete them so as to keep the buffer positions
2067 ;; constant for the actual compiled code.
2068 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2069 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
2071 (defun byte-compile-output-file-form (form)
2072 ;; Write the given form to the output buffer, being careful of docstrings
2073 ;; in defvar, defvaralias, defconst, autoload and
2074 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2075 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2076 ;; it does not pay to first build the defalias in defmumble and then parse
2077 ;; it here.
2078 (let ((print-escape-newlines t)
2079 (print-length nil)
2080 (print-level nil)
2081 (print-quoted t)
2082 (print-gensym t)
2083 (print-circle ; Handle circular data structures.
2084 (not byte-compile-disable-print-circle)))
2085 (if (and (memq (car-safe form) '(defvar defvaralias defconst
2086 autoload custom-declare-variable))
2087 (stringp (nth 3 form)))
2088 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
2089 (memq (car form)
2090 '(defvaralias autoload
2091 custom-declare-variable)))
2092 (princ "\n" byte-compile--outbuffer)
2093 (prin1 form byte-compile--outbuffer)
2094 nil)))
2096 (defvar byte-compile--for-effect)
2098 (defun byte-compile-output-docform (preface name info form specindex quoted)
2099 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2100 If PREFACE and NAME are non-nil, print them too,
2101 before INFO and the FORM but after the doc string itself.
2102 If SPECINDEX is non-nil, it is the index in FORM
2103 of the function bytecode string. In that case,
2104 we output that argument and the following argument
2105 \(the constants vector) together, for lazy loading.
2106 QUOTED says that we have to put a quote before the
2107 list that represents a doc string reference.
2108 `defvaralias', `autoload' and `custom-declare-variable' need that."
2109 ;; We need to examine byte-compile-dynamic-docstrings
2110 ;; in the input buffer (now current), not in the output buffer.
2111 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2112 (with-current-buffer byte-compile--outbuffer
2113 (let (position)
2115 ;; Insert the doc string, and make it a comment with #@LENGTH.
2116 (and (>= (nth 1 info) 0)
2117 dynamic-docstrings
2118 (progn
2119 ;; Make the doc string start at beginning of line
2120 ;; for make-docfile's sake.
2121 (insert "\n")
2122 (setq position
2123 (byte-compile-output-as-comment
2124 (nth (nth 1 info) form) nil))
2125 ;; If the doc string starts with * (a user variable),
2126 ;; negate POSITION.
2127 (if (and (stringp (nth (nth 1 info) form))
2128 (> (length (nth (nth 1 info) form)) 0)
2129 (eq (aref (nth (nth 1 info) form) 0) ?*))
2130 (setq position (- position)))))
2132 (let ((print-continuous-numbering t)
2133 print-number-table
2134 (index 0)
2135 ;; FIXME: The bindings below are only needed for when we're
2136 ;; called from ...-defmumble.
2137 (print-escape-newlines t)
2138 (print-length nil)
2139 (print-level nil)
2140 (print-quoted t)
2141 (print-gensym t)
2142 (print-circle ; Handle circular data structures.
2143 (not byte-compile-disable-print-circle)))
2144 (if preface
2145 (progn
2146 ;; FIXME: We don't handle uninterned names correctly.
2147 ;; E.g. if cl-define-compiler-macro uses uninterned name we get:
2148 ;; (defalias '#1=#:foo--cmacro #[514 ...])
2149 ;; (put 'foo 'compiler-macro '#:foo--cmacro)
2150 (insert preface)
2151 (prin1 name byte-compile--outbuffer)))
2152 (insert (car info))
2153 (prin1 (car form) byte-compile--outbuffer)
2154 (while (setq form (cdr form))
2155 (setq index (1+ index))
2156 (insert " ")
2157 (cond ((and (numberp specindex) (= index specindex)
2158 ;; Don't handle the definition dynamically
2159 ;; if it refers (or might refer)
2160 ;; to objects already output
2161 ;; (for instance, gensyms in the arg list).
2162 (let (non-nil)
2163 (when (hash-table-p print-number-table)
2164 (maphash (lambda (_k v) (if v (setq non-nil t)))
2165 print-number-table))
2166 (not non-nil)))
2167 ;; Output the byte code and constants specially
2168 ;; for lazy dynamic loading.
2169 (let ((position
2170 (byte-compile-output-as-comment
2171 (cons (car form) (nth 1 form))
2172 t)))
2173 (princ (format "(#$ . %d) nil" position)
2174 byte-compile--outbuffer)
2175 (setq form (cdr form))
2176 (setq index (1+ index))))
2177 ((= index (nth 1 info))
2178 (if position
2179 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2180 position)
2181 byte-compile--outbuffer)
2182 (let ((print-escape-newlines nil))
2183 (goto-char (prog1 (1+ (point))
2184 (prin1 (car form)
2185 byte-compile--outbuffer)))
2186 (insert "\\\n")
2187 (goto-char (point-max)))))
2189 (prin1 (car form) byte-compile--outbuffer)))))
2190 (insert (nth 2 info)))))
2191 nil)
2193 (defun byte-compile-keep-pending (form &optional handler)
2194 (if (memq byte-optimize '(t source))
2195 (setq form (byte-optimize-form form t)))
2196 (if handler
2197 (let ((byte-compile--for-effect t))
2198 ;; To avoid consing up monstrously large forms at load time, we split
2199 ;; the output regularly.
2200 (and (memq (car-safe form) '(fset defalias))
2201 (nthcdr 300 byte-compile-output)
2202 (byte-compile-flush-pending))
2203 (funcall handler form)
2204 (if byte-compile--for-effect
2205 (byte-compile-discard)))
2206 (byte-compile-form form t))
2207 nil)
2209 (defun byte-compile-flush-pending ()
2210 (if byte-compile-output
2211 (let ((form (byte-compile-out-toplevel t 'file)))
2212 (cond ((eq (car-safe form) 'progn)
2213 (mapc 'byte-compile-output-file-form (cdr form)))
2214 (form
2215 (byte-compile-output-file-form form)))
2216 (setq byte-compile-constants nil
2217 byte-compile-variables nil
2218 byte-compile-depth 0
2219 byte-compile-maxdepth 0
2220 byte-compile-output nil))))
2222 (defvar byte-compile-force-lexical-warnings nil)
2224 (defun byte-compile-preprocess (form &optional _for-effect)
2225 (setq form (macroexpand-all form byte-compile-macro-environment))
2226 ;; FIXME: We should run byte-optimize-form here, but it currently does not
2227 ;; recurse through all the code, so we'd have to fix this first.
2228 ;; Maybe a good fix would be to merge byte-optimize-form into
2229 ;; macroexpand-all.
2230 ;; (if (memq byte-optimize '(t source))
2231 ;; (setq form (byte-optimize-form form for-effect)))
2232 (cond
2233 (lexical-binding (cconv-closure-convert form))
2234 (byte-compile-force-lexical-warnings (cconv-warnings-only form))
2235 (t form)))
2237 ;; byte-hunk-handlers cannot call this!
2238 (defun byte-compile-toplevel-file-form (top-level-form)
2239 (byte-compile-recurse-toplevel
2240 top-level-form
2241 (lambda (form)
2242 (let ((byte-compile-current-form nil)) ; close over this for warnings.
2243 (byte-compile-file-form (byte-compile-preprocess form t))))))
2245 ;; byte-hunk-handlers can call this.
2246 (defun byte-compile-file-form (form)
2247 (let (handler)
2248 (cond ((and (consp form)
2249 (symbolp (car form))
2250 (setq handler (get (car form) 'byte-hunk-handler)))
2251 (cond ((setq form (funcall handler form))
2252 (byte-compile-flush-pending)
2253 (byte-compile-output-file-form form))))
2255 (byte-compile-keep-pending form)))))
2257 ;; Functions and variables with doc strings must be output separately,
2258 ;; so make-docfile can recognize them. Most other things can be output
2259 ;; as byte-code.
2261 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2262 (defun byte-compile-file-form-autoload (form)
2263 (and (let ((form form))
2264 (while (if (setq form (cdr form)) (macroexp-const-p (car form))))
2265 (null form)) ;Constants only
2266 (memq (eval (nth 5 form)) '(t macro)) ;Macro
2267 (eval form)) ;Define the autoload.
2268 ;; Avoid undefined function warnings for the autoload.
2269 (pcase (nth 1 form)
2270 (`',(and (pred symbolp) funsym)
2271 ;; Don't add it if it's already defined. Otherwise, it might
2272 ;; hide the actual definition. However, do remove any entry from
2273 ;; byte-compile-noruntime-functions, in case we have an autoload
2274 ;; of foo-func following an (eval-when-compile (require 'foo)).
2275 (unless (fboundp funsym)
2276 (push (cons funsym (cons 'autoload (cdr (cdr form))))
2277 byte-compile-function-environment))
2278 ;; If an autoload occurs _before_ the first call to a function,
2279 ;; byte-compile-callargs-warn does not add an entry to
2280 ;; byte-compile-unresolved-functions. Here we mimic the logic
2281 ;; of byte-compile-callargs-warn so as not to warn if the
2282 ;; autoload comes _after_ the function call.
2283 ;; Alternatively, similar logic could go in
2284 ;; byte-compile-warn-about-unresolved-functions.
2285 (if (memq funsym byte-compile-noruntime-functions)
2286 (setq byte-compile-noruntime-functions
2287 (delq funsym byte-compile-noruntime-functions)
2288 byte-compile-noruntime-functions)
2289 (setq byte-compile-unresolved-functions
2290 (delq (assq funsym byte-compile-unresolved-functions)
2291 byte-compile-unresolved-functions)))))
2292 (if (stringp (nth 3 form))
2293 form
2294 ;; No doc string, so we can compile this as a normal form.
2295 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2297 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2298 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2300 (defun byte-compile--declare-var (sym)
2301 (when (and (symbolp sym)
2302 (not (string-match "[-*/:$]" (symbol-name sym)))
2303 (byte-compile-warning-enabled-p 'lexical))
2304 (byte-compile-warn "global/dynamic var ‘%s’ lacks a prefix"
2305 sym))
2306 (when (memq sym byte-compile-lexical-variables)
2307 (setq byte-compile-lexical-variables
2308 (delq sym byte-compile-lexical-variables))
2309 (byte-compile-warn "Variable ‘%S’ declared after its first use" sym))
2310 (push sym byte-compile-bound-variables))
2312 (defun byte-compile-file-form-defvar (form)
2313 (let ((sym (nth 1 form)))
2314 (byte-compile--declare-var sym)
2315 (if (eq (car form) 'defconst)
2316 (push sym byte-compile-const-variables)))
2317 (if (and (null (cddr form)) ;No `value' provided.
2318 (eq (car form) 'defvar)) ;Just a declaration.
2320 (cond ((consp (nth 2 form))
2321 (setq form (copy-sequence form))
2322 (setcar (cdr (cdr form))
2323 (byte-compile-top-level (nth 2 form) nil 'file))))
2324 form))
2326 (put 'define-abbrev-table 'byte-hunk-handler
2327 'byte-compile-file-form-defvar-function)
2328 (put 'defvaralias 'byte-hunk-handler 'byte-compile-file-form-defvar-function)
2330 (defun byte-compile-file-form-defvar-function (form)
2331 (pcase-let (((or `',name (let name nil)) (nth 1 form)))
2332 (if name (byte-compile--declare-var name)))
2333 (byte-compile-keep-pending form))
2335 (put 'custom-declare-variable 'byte-hunk-handler
2336 'byte-compile-file-form-custom-declare-variable)
2337 (defun byte-compile-file-form-custom-declare-variable (form)
2338 (when (byte-compile-warning-enabled-p 'callargs)
2339 (byte-compile-nogroup-warn form))
2340 (byte-compile-file-form-defvar-function form))
2342 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2343 (defun byte-compile-file-form-require (form)
2344 (let ((args (mapcar 'eval (cdr form)))
2345 (hist-orig load-history)
2346 hist-new)
2347 (apply 'require args)
2348 (when (byte-compile-warning-enabled-p 'cl-functions)
2349 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2350 (if (member (car args) '("cl" cl))
2351 (progn
2352 (byte-compile-warn "cl package required at runtime")
2353 (byte-compile-disable-warning 'cl-functions))
2354 ;; We may have required something that causes cl to be loaded, eg
2355 ;; the uncompiled version of a file that requires cl when compiling.
2356 (setq hist-new load-history)
2357 (while (and (not byte-compile-cl-functions)
2358 hist-new (not (eq hist-new hist-orig)))
2359 (and (byte-compile-cl-file-p (car (pop hist-new)))
2360 (byte-compile-find-cl-functions))))))
2361 (byte-compile-keep-pending form 'byte-compile-normal-call))
2363 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2364 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2365 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2366 (defun byte-compile-file-form-progn (form)
2367 (mapc 'byte-compile-file-form (cdr form))
2368 ;; Return nil so the forms are not output twice.
2369 nil)
2371 (put 'with-no-warnings 'byte-hunk-handler
2372 'byte-compile-file-form-with-no-warnings)
2373 (defun byte-compile-file-form-with-no-warnings (form)
2374 ;; cf byte-compile-file-form-progn.
2375 (let (byte-compile-warnings)
2376 (mapc 'byte-compile-file-form (cdr form))
2377 nil))
2379 ;; This handler is not necessary, but it makes the output from dont-compile
2380 ;; and similar macros cleaner.
2381 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2382 (defun byte-compile-file-form-eval (form)
2383 (if (eq (car-safe (nth 1 form)) 'quote)
2384 (nth 1 (nth 1 form))
2385 (byte-compile-keep-pending form)))
2387 (defun byte-compile-file-form-defmumble (name macro arglist body rest)
2388 "Process a `defalias' for NAME.
2389 If MACRO is non-nil, the definition is known to be a macro.
2390 ARGLIST is the list of arguments, if it was recognized or t otherwise.
2391 BODY of the definition, or t if not recognized.
2392 Return non-nil if everything went as planned, or nil to imply that it decided
2393 not to take responsibility for the actual compilation of the code."
2394 (let* ((this-kind (if macro 'byte-compile-macro-environment
2395 'byte-compile-function-environment))
2396 (that-kind (if macro 'byte-compile-function-environment
2397 'byte-compile-macro-environment))
2398 (this-one (assq name (symbol-value this-kind)))
2399 (that-one (assq name (symbol-value that-kind)))
2400 (byte-compile-current-form name)) ; For warnings.
2402 (byte-compile-set-symbol-position name)
2403 ;; When a function or macro is defined, add it to the call tree so that
2404 ;; we can tell when functions are not used.
2405 (if byte-compile-generate-call-tree
2406 (or (assq name byte-compile-call-tree)
2407 (setq byte-compile-call-tree
2408 (cons (list name nil nil) byte-compile-call-tree))))
2410 (if (byte-compile-warning-enabled-p 'redefine)
2411 (byte-compile-arglist-warn name arglist macro))
2413 (if byte-compile-verbose
2414 (message "Compiling %s... (%s)"
2415 (or byte-compile-current-file "") name))
2416 (cond ((not (or macro (listp body)))
2417 ;; We do not know positively if the definition is a macro
2418 ;; or a function, so we shouldn't emit warnings.
2419 ;; This also silences "multiple definition" warnings for defmethods.
2420 nil)
2421 (that-one
2422 (if (and (byte-compile-warning-enabled-p 'redefine)
2423 ;; Don't warn when compiling the stubs in byte-run...
2424 (not (assq name byte-compile-initial-macro-environment)))
2425 (byte-compile-warn
2426 "‘%s’ defined multiple times, as both function and macro"
2427 name))
2428 (setcdr that-one nil))
2429 (this-one
2430 (when (and (byte-compile-warning-enabled-p 'redefine)
2431 ;; Hack: Don't warn when compiling the magic internal
2432 ;; byte-compiler macros in byte-run.el...
2433 (not (assq name byte-compile-initial-macro-environment)))
2434 (byte-compile-warn "%s ‘%s’ defined multiple times in this file"
2435 (if macro "macro" "function")
2436 name)))
2437 ((eq (car-safe (symbol-function name))
2438 (if macro 'lambda 'macro))
2439 (when (byte-compile-warning-enabled-p 'redefine)
2440 (byte-compile-warn "%s ‘%s’ being redefined as a %s"
2441 (if macro "function" "macro")
2442 name
2443 (if macro "macro" "function")))
2444 ;; Shadow existing definition.
2445 (set this-kind
2446 (cons (cons name nil)
2447 (symbol-value this-kind))))
2450 (when (and (listp body)
2451 (stringp (car body))
2452 (symbolp (car-safe (cdr-safe body)))
2453 (car-safe (cdr-safe body))
2454 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2455 ;; FIXME: We've done that already just above, so this looks wrong!
2456 ;;(byte-compile-set-symbol-position name)
2457 (byte-compile-warn "probable ‘\"’ without ‘\\’ in doc string of %s"
2458 name))
2460 (if (not (listp body))
2461 ;; The precise definition requires evaluation to find out, so it
2462 ;; will only be known at runtime.
2463 ;; For a macro, that means we can't use that macro in the same file.
2464 (progn
2465 (unless macro
2466 (push (cons name (if (listp arglist) `(declared ,arglist) t))
2467 byte-compile-function-environment))
2468 ;; Tell the caller that we didn't compile it yet.
2469 nil)
2471 (let* ((code (byte-compile-lambda (cons arglist body) t)))
2472 (if this-one
2473 ;; A definition in b-c-initial-m-e should always take precedence
2474 ;; during compilation, so don't let it be redefined. (Bug#8647)
2475 (or (and macro
2476 (assq name byte-compile-initial-macro-environment))
2477 (setcdr this-one code))
2478 (set this-kind
2479 (cons (cons name code)
2480 (symbol-value this-kind))))
2482 (if rest
2483 ;; There are additional args to `defalias' (like maybe a docstring)
2484 ;; that the code below can't handle: punt!
2486 ;; Otherwise, we have a bona-fide defun/defmacro definition, and use
2487 ;; special code to allow dynamic docstrings and byte-code.
2488 (byte-compile-flush-pending)
2489 (let ((index
2490 ;; If there's no doc string, provide -1 as the "doc string
2491 ;; index" so that no element will be treated as a doc string.
2492 (if (not (stringp (car body))) -1 4)))
2493 ;; Output the form by hand, that's much simpler than having
2494 ;; b-c-output-file-form analyze the defalias.
2495 (byte-compile-output-docform
2496 "\n(defalias '"
2497 name
2498 (if macro `(" '(macro . #[" ,index "])") `(" #[" ,index "]"))
2499 (append code nil) ; Turn byte-code-function-p into list.
2500 (and (atom code) byte-compile-dynamic
2502 nil))
2503 (princ ")" byte-compile--outbuffer)
2504 t)))))
2506 (defun byte-compile-output-as-comment (exp quoted)
2507 "Print Lisp object EXP in the output file, inside a comment,
2508 and return the file (byte) position it will have.
2509 If QUOTED is non-nil, print with quoting; otherwise, print without quoting."
2510 (with-current-buffer byte-compile--outbuffer
2511 (let ((position (point)))
2513 ;; Insert EXP, and make it a comment with #@LENGTH.
2514 (insert " ")
2515 (if quoted
2516 (prin1 exp byte-compile--outbuffer)
2517 (princ exp byte-compile--outbuffer))
2518 (goto-char position)
2519 ;; Quote certain special characters as needed.
2520 ;; get_doc_string in doc.c does the unquoting.
2521 (while (search-forward "\^A" nil t)
2522 (replace-match "\^A\^A" t t))
2523 (goto-char position)
2524 (while (search-forward "\000" nil t)
2525 (replace-match "\^A0" t t))
2526 (goto-char position)
2527 (while (search-forward "\037" nil t)
2528 (replace-match "\^A_" t t))
2529 (goto-char (point-max))
2530 (insert "\037")
2531 (goto-char position)
2532 (insert "#@" (format "%d" (- (position-bytes (point-max))
2533 (position-bytes position))))
2535 ;; Save the file position of the object.
2536 ;; Note we add 1 to skip the space that we inserted before the actual doc
2537 ;; string, and subtract point-min to convert from an 1-origin Emacs
2538 ;; position to a file position.
2539 (prog1
2540 (- (position-bytes (point)) (point-min) -1)
2541 (goto-char (point-max))))))
2543 (defun byte-compile--reify-function (fun)
2544 "Return an expression which will evaluate to a function value FUN.
2545 FUN should be either a `lambda' value or a `closure' value."
2546 (pcase-let* (((or (and `(lambda ,args . ,body) (let env nil))
2547 `(closure ,env ,args . ,body))
2548 fun)
2549 (renv ()))
2550 ;; Turn the function's closed vars (if any) into local let bindings.
2551 (dolist (binding env)
2552 (cond
2553 ((consp binding)
2554 ;; We check shadowing by the args, so that the `let' can be moved
2555 ;; within the lambda, which can then be unfolded. FIXME: Some of those
2556 ;; bindings might be unused in `body'.
2557 (unless (memq (car binding) args) ;Shadowed.
2558 (push `(,(car binding) ',(cdr binding)) renv)))
2559 ((eq binding t))
2560 (t (push `(defvar ,binding) body))))
2561 (if (null renv)
2562 `(lambda ,args ,@body)
2563 `(lambda ,args (let ,(nreverse renv) ,@body)))))
2565 ;;;###autoload
2566 (defun byte-compile (form)
2567 "If FORM is a symbol, byte-compile its function definition.
2568 If FORM is a lambda or a macro, byte-compile it as a function."
2569 (displaying-byte-compile-warnings
2570 (byte-compile-close-variables
2571 (let* ((lexical-binding lexical-binding)
2572 (fun (if (symbolp form)
2573 (symbol-function form)
2574 form))
2575 (macro (eq (car-safe fun) 'macro)))
2576 (if macro
2577 (setq fun (cdr fun)))
2578 (cond
2579 ;; Up until Emacs-24.1, byte-compile silently did nothing when asked to
2580 ;; compile something invalid. So let's tune down the complaint from an
2581 ;; error to a simple message for the known case where signaling an error
2582 ;; causes problems.
2583 ((byte-code-function-p fun)
2584 (message "Function %s is already compiled"
2585 (if (symbolp form) form "provided"))
2586 fun)
2588 (when (symbolp form)
2589 (setq lexical-binding (eq (car fun) 'closure))
2590 (setq fun (byte-compile--reify-function fun)))
2591 ;; Expand macros.
2592 (setq fun (byte-compile-preprocess fun))
2593 (setq fun (byte-compile-top-level fun nil 'eval))
2594 (if macro (push 'macro fun))
2595 (if (symbolp form)
2596 (fset form fun)
2597 fun)))))))
2599 (defun byte-compile-sexp (sexp)
2600 "Compile and return SEXP."
2601 (displaying-byte-compile-warnings
2602 (byte-compile-close-variables
2603 (byte-compile-top-level (byte-compile-preprocess sexp)))))
2605 (defun byte-compile-check-lambda-list (list)
2606 "Check lambda-list LIST for errors."
2607 (let (vars)
2608 (while list
2609 (let ((arg (car list)))
2610 (when (symbolp arg)
2611 (byte-compile-set-symbol-position arg))
2612 (cond ((or (not (symbolp arg))
2613 (macroexp--const-symbol-p arg t))
2614 (error "Invalid lambda variable %s" arg))
2615 ((eq arg '&rest)
2616 (unless (cdr list)
2617 (error "&rest without variable name"))
2618 (when (cddr list)
2619 (error "Garbage following &rest VAR in lambda-list")))
2620 ((eq arg '&optional)
2621 (unless (cdr list)
2622 (error "Variable name missing after &optional")))
2623 ((memq arg vars)
2624 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2626 (push arg vars))))
2627 (setq list (cdr list)))))
2630 (defun byte-compile-arglist-vars (arglist)
2631 "Return a list of the variables in the lambda argument list ARGLIST."
2632 (remq '&rest (remq '&optional arglist)))
2634 (defun byte-compile-make-lambda-lexenv (args)
2635 "Return a new lexical environment for a lambda expression FORM."
2636 (let* ((lexenv nil)
2637 (stackpos 0))
2638 ;; Add entries for each argument.
2639 (dolist (arg args)
2640 (push (cons arg stackpos) lexenv)
2641 (setq stackpos (1+ stackpos)))
2642 ;; Return the new lexical environment.
2643 lexenv))
2645 (defun byte-compile-make-args-desc (arglist)
2646 (let ((mandatory 0)
2647 nonrest (rest 0))
2648 (while (and arglist (not (memq (car arglist) '(&optional &rest))))
2649 (setq mandatory (1+ mandatory))
2650 (setq arglist (cdr arglist)))
2651 (setq nonrest mandatory)
2652 (when (eq (car arglist) '&optional)
2653 (setq arglist (cdr arglist))
2654 (while (and arglist (not (eq (car arglist) '&rest)))
2655 (setq nonrest (1+ nonrest))
2656 (setq arglist (cdr arglist))))
2657 (when arglist
2658 (setq rest 1))
2659 (if (> mandatory 127)
2660 (byte-compile-report-error "Too many (>127) mandatory arguments")
2661 (logior mandatory
2662 (lsh nonrest 8)
2663 (lsh rest 7)))))
2666 (defun byte-compile-lambda (fun &optional add-lambda reserved-csts)
2667 "Byte-compile a lambda-expression and return a valid function.
2668 The value is usually a compiled function but may be the original
2669 lambda-expression.
2670 When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2671 of the list FUN and `byte-compile-set-symbol-position' is not called.
2672 Use this feature to avoid calling `byte-compile-set-symbol-position'
2673 for symbols generated by the byte compiler itself."
2674 (if add-lambda
2675 (setq fun (cons 'lambda fun))
2676 (unless (eq 'lambda (car-safe fun))
2677 (error "Not a lambda list: %S" fun))
2678 (byte-compile-set-symbol-position 'lambda))
2679 (byte-compile-check-lambda-list (nth 1 fun))
2680 (let* ((arglist (nth 1 fun))
2681 (arglistvars (byte-compile-arglist-vars arglist))
2682 (byte-compile-bound-variables
2683 (append (if (not lexical-binding) arglistvars)
2684 byte-compile-bound-variables))
2685 (body (cdr (cdr fun)))
2686 (doc (if (stringp (car body))
2687 (prog1 (car body)
2688 ;; Discard the doc string
2689 ;; unless it is the last element of the body.
2690 (if (cdr body)
2691 (setq body (cdr body))))))
2692 (int (assq 'interactive body)))
2693 ;; Process the interactive spec.
2694 (when int
2695 (byte-compile-set-symbol-position 'interactive)
2696 ;; Skip (interactive) if it is in front (the most usual location).
2697 (if (eq int (car body))
2698 (setq body (cdr body)))
2699 (cond ((consp (cdr int))
2700 (if (cdr (cdr int))
2701 (byte-compile-warn "malformed interactive spec: %s"
2702 (prin1-to-string int)))
2703 ;; If the interactive spec is a call to `list', don't
2704 ;; compile it, because `call-interactively' looks at the
2705 ;; args of `list'. Actually, compile it to get warnings,
2706 ;; but don't use the result.
2707 (let* ((form (nth 1 int))
2708 (newform (byte-compile-top-level form)))
2709 (while (memq (car-safe form) '(let let* progn save-excursion))
2710 (while (consp (cdr form))
2711 (setq form (cdr form)))
2712 (setq form (car form)))
2713 (if (and (eq (car-safe form) 'list)
2714 ;; The spec is evalled in callint.c in dynamic-scoping
2715 ;; mode, so just leaving the form unchanged would mean
2716 ;; it won't be eval'd in the right mode.
2717 (not lexical-binding))
2719 (setq int `(interactive ,newform)))))
2720 ((cdr int)
2721 (byte-compile-warn "malformed interactive spec: %s"
2722 (prin1-to-string int)))))
2723 ;; Process the body.
2724 (let ((compiled
2725 (byte-compile-top-level (cons 'progn body) nil 'lambda
2726 ;; If doing lexical binding, push a new
2727 ;; lexical environment containing just the
2728 ;; args (since lambda expressions should be
2729 ;; closed by now).
2730 (and lexical-binding
2731 (byte-compile-make-lambda-lexenv
2732 arglistvars))
2733 reserved-csts)))
2734 ;; Build the actual byte-coded function.
2735 (cl-assert (eq 'byte-code (car-safe compiled)))
2736 (apply #'make-byte-code
2737 (if lexical-binding
2738 (byte-compile-make-args-desc arglist)
2739 arglist)
2740 (append
2741 ;; byte-string, constants-vector, stack depth
2742 (cdr compiled)
2743 ;; optionally, the doc string.
2744 (cond ((and lexical-binding arglist)
2745 ;; byte-compile-make-args-desc lost the args's names,
2746 ;; so preserve them in the docstring.
2747 (list (help-add-fundoc-usage doc arglist)))
2748 ((or doc int)
2749 (list doc)))
2750 ;; optionally, the interactive spec.
2751 (if int
2752 (list (nth 1 int))))))))
2754 (defvar byte-compile-reserved-constants 0)
2756 (defun byte-compile-constants-vector ()
2757 ;; Builds the constants-vector from the current variables and constants.
2758 ;; This modifies the constants from (const . nil) to (const . offset).
2759 ;; To keep the byte-codes to look up the vector as short as possible:
2760 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2761 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2762 ;; Next variables again, to get 2-byte codes for variable lookup.
2763 ;; The rest of the constants and variables need 3-byte byte-codes.
2764 (let* ((i (1- byte-compile-reserved-constants))
2765 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2766 (other (nreverse byte-compile-constants)) ; vars often are used most.
2767 ret tmp
2768 (limits '(5 ; Use the 1-byte varref codes,
2769 63 ; 1-constlim ; 1-byte byte-constant codes,
2770 255 ; 2-byte varref codes,
2771 65535 ; 3-byte codes for the rest.
2772 65535)) ; twice since we step when we swap.
2773 limit)
2774 (while (or rest other)
2775 (setq limit (car limits))
2776 (while (and rest (< i limit))
2777 (cond
2778 ((numberp (car rest))
2779 (cl-assert (< (car rest) byte-compile-reserved-constants)))
2780 ((setq tmp (assq (car (car rest)) ret))
2781 (setcdr (car rest) (cdr tmp)))
2783 (setcdr (car rest) (setq i (1+ i)))
2784 (setq ret (cons (car rest) ret))))
2785 (setq rest (cdr rest)))
2786 (setq limits (cdr limits) ;Step
2787 rest (prog1 other ;&Swap.
2788 (setq other rest))))
2789 (apply 'vector (nreverse (mapcar 'car ret)))))
2791 ;; Given an expression FORM, compile it and return an equivalent byte-code
2792 ;; expression (a call to the function byte-code).
2793 (defun byte-compile-top-level (form &optional for-effect output-type
2794 lexenv reserved-csts)
2795 ;; OUTPUT-TYPE advises about how form is expected to be used:
2796 ;; 'eval or nil -> a single form,
2797 ;; 'progn or t -> a list of forms,
2798 ;; 'lambda -> body of a lambda,
2799 ;; 'file -> used at file-level.
2800 (let ((byte-compile--for-effect for-effect)
2801 (byte-compile-constants nil)
2802 (byte-compile-variables nil)
2803 (byte-compile-tag-number 0)
2804 (byte-compile-depth 0)
2805 (byte-compile-maxdepth 0)
2806 (byte-compile--lexical-environment lexenv)
2807 (byte-compile-reserved-constants (or reserved-csts 0))
2808 (byte-compile-output nil))
2809 (if (memq byte-optimize '(t source))
2810 (setq form (byte-optimize-form form byte-compile--for-effect)))
2811 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2812 (setq form (nth 1 form)))
2813 ;; Set up things for a lexically-bound function.
2814 (when (and lexical-binding (eq output-type 'lambda))
2815 ;; See how many arguments there are, and set the current stack depth
2816 ;; accordingly.
2817 (setq byte-compile-depth (length byte-compile--lexical-environment))
2818 ;; If there are args, output a tag to record the initial
2819 ;; stack-depth for the optimizer.
2820 (when (> byte-compile-depth 0)
2821 (byte-compile-out-tag (byte-compile-make-tag))))
2822 ;; Now compile FORM
2823 (byte-compile-form form byte-compile--for-effect)
2824 (byte-compile-out-toplevel byte-compile--for-effect output-type)))
2826 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2827 (if for-effect
2828 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2829 (if (eq (car (car byte-compile-output)) 'byte-discard)
2830 (setq byte-compile-output (cdr byte-compile-output))
2831 (byte-compile-push-constant
2832 ;; Push any constant - preferably one which already is used, and
2833 ;; a number or symbol - ie not some big sequence. The return value
2834 ;; isn't returned, but it would be a shame if some textually large
2835 ;; constant was not optimized away because we chose to return it.
2836 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2837 (let ((tmp (reverse byte-compile-constants)))
2838 (while (and tmp (not (or (symbolp (caar tmp))
2839 (numberp (caar tmp)))))
2840 (setq tmp (cdr tmp)))
2841 (caar tmp))))))
2842 (byte-compile-out 'byte-return 0)
2843 (setq byte-compile-output (nreverse byte-compile-output))
2844 (if (memq byte-optimize '(t byte))
2845 (setq byte-compile-output
2846 (byte-optimize-lapcode byte-compile-output)))
2848 ;; Decompile trivial functions:
2849 ;; only constants and variables, or a single funcall except in lambdas.
2850 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2851 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2852 ;; Note that even (quote foo) must be parsed just as any subr by the
2853 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2854 ;; What to leave uncompiled:
2855 ;; lambda -> never. we used to leave it uncompiled if the body was
2856 ;; a single atom, but that causes confusion if the docstring
2857 ;; uses the (file . pos) syntax. Besides, now that we have
2858 ;; the Lisp_Compiled type, the compiled form is faster.
2859 ;; eval -> atom, quote or (function atom atom atom)
2860 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2861 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2862 (let (rest
2863 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2864 tmp body)
2865 (cond
2866 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2867 ((or (eq output-type 'lambda)
2868 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2869 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2870 (not (setq tmp (assq 'byte-return byte-compile-output)))
2871 (progn
2872 (setq rest (nreverse
2873 (cdr (memq tmp (reverse byte-compile-output)))))
2874 (while
2875 (cond
2876 ((memq (car (car rest)) '(byte-varref byte-constant))
2877 (setq tmp (car (cdr (car rest))))
2878 (if (if (eq (car (car rest)) 'byte-constant)
2879 (or (consp tmp)
2880 (and (symbolp tmp)
2881 (not (macroexp--const-symbol-p tmp)))))
2882 (if maycall
2883 (setq body (cons (list 'quote tmp) body)))
2884 (setq body (cons tmp body))))
2885 ((and maycall
2886 ;; Allow a funcall if at most one atom follows it.
2887 (null (nthcdr 3 rest))
2888 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2889 (or (null (cdr rest))
2890 (and (memq output-type '(file progn t))
2891 (cdr (cdr rest))
2892 (eq (car (nth 1 rest)) 'byte-discard)
2893 (progn (setq rest (cdr rest)) t))))
2894 (setq maycall nil) ; Only allow one real function call.
2895 (setq body (nreverse body))
2896 (setq body (list
2897 (if (and (eq tmp 'funcall)
2898 (eq (car-safe (car body)) 'quote)
2899 (symbolp (nth 1 (car body))))
2900 (cons (nth 1 (car body)) (cdr body))
2901 (cons tmp body))))
2902 (or (eq output-type 'file)
2903 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2904 (setq rest (cdr rest)))
2905 rest))
2906 (let ((byte-compile-vector (byte-compile-constants-vector)))
2907 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2908 byte-compile-vector byte-compile-maxdepth)))
2909 ;; it's a trivial function
2910 ((cdr body) (cons 'progn (nreverse body)))
2911 ((car body)))))
2913 ;; Given BODY, compile it and return a new body.
2914 (defun byte-compile-top-level-body (body &optional for-effect)
2915 (setq body
2916 (byte-compile-top-level (cons 'progn body) for-effect t))
2917 (cond ((eq (car-safe body) 'progn)
2918 (cdr body))
2919 (body
2920 (list body))))
2922 ;; Special macro-expander used during byte-compilation.
2923 (defun byte-compile-macroexpand-declare-function (fn file &rest args)
2924 (let ((gotargs (and (consp args) (listp (car args))))
2925 (unresolved (assq fn byte-compile-unresolved-functions)))
2926 (when unresolved ; function was called before declaration
2927 (if (and gotargs (byte-compile-warning-enabled-p 'callargs))
2928 (byte-compile-arglist-warn fn (car args) nil)
2929 (setq byte-compile-unresolved-functions
2930 (delq unresolved byte-compile-unresolved-functions))))
2931 (push (cons fn (if gotargs
2932 (list 'declared (car args))
2933 t)) ; Arglist not specified.
2934 byte-compile-function-environment))
2935 ;; We are stating that it _will_ be defined at runtime.
2936 (setq byte-compile-noruntime-functions
2937 (delq fn byte-compile-noruntime-functions))
2938 ;; Delegate the rest to the normal macro definition.
2939 (macroexpand `(declare-function ,fn ,file ,@args)))
2942 ;; This is the recursive entry point for compiling each subform of an
2943 ;; expression.
2944 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2945 ;; before terminating (ie no value will be left on the stack).
2946 ;; A byte-compile handler may, when byte-compile--for-effect is non-nil, choose
2947 ;; output code which does not leave a value on the stack, and then set
2948 ;; byte-compile--for-effect to nil (to prevent byte-compile-form from
2949 ;; outputting the byte-discard).
2950 ;; If a handler wants to call another handler, it should do so via
2951 ;; byte-compile-form, or take extreme care to handle byte-compile--for-effect
2952 ;; correctly. (Use byte-compile-form-do-effect to reset the
2953 ;; byte-compile--for-effect flag too.)
2955 (defun byte-compile-form (form &optional for-effect)
2956 (let ((byte-compile--for-effect for-effect))
2957 (cond
2958 ((not (consp form))
2959 (cond ((or (not (symbolp form)) (macroexp--const-symbol-p form))
2960 (when (symbolp form)
2961 (byte-compile-set-symbol-position form))
2962 (byte-compile-constant form))
2963 ((and byte-compile--for-effect byte-compile-delete-errors)
2964 (when (symbolp form)
2965 (byte-compile-set-symbol-position form))
2966 (setq byte-compile--for-effect nil))
2968 (byte-compile-variable-ref form))))
2969 ((symbolp (car form))
2970 (let* ((fn (car form))
2971 (handler (get fn 'byte-compile))
2972 (interactive-only
2973 (or (get fn 'interactive-only)
2974 (memq fn byte-compile-interactive-only-functions))))
2975 (when (memq fn '(set symbol-value run-hooks ;; add-to-list
2976 add-hook remove-hook run-hook-with-args
2977 run-hook-with-args-until-success
2978 run-hook-with-args-until-failure))
2979 (pcase (cdr form)
2980 (`(',var . ,_)
2981 (when (assq var byte-compile-lexical-variables)
2982 (byte-compile-log-warning
2983 (format-message "%s cannot use lexical var ‘%s’" fn var)
2984 nil :error)))))
2985 (when (macroexp--const-symbol-p fn)
2986 (byte-compile-warn "‘%s’ called as a function" fn))
2987 (when (and (byte-compile-warning-enabled-p 'interactive-only)
2988 interactive-only)
2989 (byte-compile-warn "‘%s’ is for interactive use only%s"
2991 (cond ((stringp interactive-only)
2992 (format "; %s" interactive-only))
2993 ((and (symbolp 'interactive-only)
2994 (not (eq interactive-only t)))
2995 (format-message "; use ‘%s’ instead."
2996 interactive-only))
2997 (t "."))))
2998 (if (eq (car-safe (symbol-function (car form))) 'macro)
2999 (byte-compile-log-warning
3000 (format "Forgot to expand macro %s in %S" (car form) form)
3001 nil :error))
3002 (if (and handler
3003 ;; Make sure that function exists.
3004 (and (functionp handler)
3005 ;; Ignore obsolete byte-compile function used by former
3006 ;; CL code to handle compiler macros (we do it
3007 ;; differently now).
3008 (not (eq handler 'cl-byte-compile-compiler-macro))))
3009 (funcall handler form)
3010 (byte-compile-normal-call form))
3011 (if (byte-compile-warning-enabled-p 'cl-functions)
3012 (byte-compile-cl-warn form))))
3013 ((and (byte-code-function-p (car form))
3014 (memq byte-optimize '(t lap)))
3015 (byte-compile-unfold-bcf form))
3016 ((and (eq (car-safe (car form)) 'lambda)
3017 ;; if the form comes out the same way it went in, that's
3018 ;; because it was malformed, and we couldn't unfold it.
3019 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
3020 (byte-compile-form form byte-compile--for-effect)
3021 (setq byte-compile--for-effect nil))
3022 ((byte-compile-normal-call form)))
3023 (if byte-compile--for-effect
3024 (byte-compile-discard))))
3026 (defun byte-compile-normal-call (form)
3027 (when (and (byte-compile-warning-enabled-p 'callargs)
3028 (symbolp (car form)))
3029 (if (memq (car form)
3030 '(custom-declare-group custom-declare-variable
3031 custom-declare-face))
3032 (byte-compile-nogroup-warn form))
3033 (byte-compile-callargs-warn form))
3034 (if byte-compile-generate-call-tree
3035 (byte-compile-annotate-call-tree form))
3036 (when (and byte-compile--for-effect (eq (car form) 'mapcar)
3037 (byte-compile-warning-enabled-p 'mapcar))
3038 (byte-compile-set-symbol-position 'mapcar)
3039 (byte-compile-warn
3040 "‘mapcar’ called for effect; use ‘mapc’ or ‘dolist’ instead"))
3041 (byte-compile-push-constant (car form))
3042 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
3043 (byte-compile-out 'byte-call (length (cdr form))))
3046 ;; Splice the given lap code into the current instruction stream.
3047 ;; If it has any labels in it, you're responsible for making sure there
3048 ;; are no collisions, and that byte-compile-tag-number is reasonable
3049 ;; after this is spliced in. The provided list is destroyed.
3050 (defun byte-compile-inline-lapcode (lap end-depth)
3051 ;; "Replay" the operations: we used to just do
3052 ;; (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))
3053 ;; but that fails to update byte-compile-depth, so we had to assume
3054 ;; that `lap' ends up adding exactly 1 element to the stack. This
3055 ;; happens to be true for byte-code generated by bytecomp.el without
3056 ;; lexical-binding, but it's not true in general, and it's not true for
3057 ;; code output by bytecomp.el with lexical-binding.
3058 (let ((endtag (byte-compile-make-tag)))
3059 (dolist (op lap)
3060 (cond
3061 ((eq (car op) 'TAG) (byte-compile-out-tag op))
3062 ((memq (car op) byte-goto-ops) (byte-compile-goto (car op) (cdr op)))
3063 ((eq (car op) 'byte-return)
3064 (byte-compile-discard (- byte-compile-depth end-depth) t)
3065 (byte-compile-goto 'byte-goto endtag))
3066 (t (byte-compile-out (car op) (cdr op)))))
3067 (byte-compile-out-tag endtag)))
3069 (defun byte-compile-unfold-bcf (form)
3070 "Inline call to byte-code-functions."
3071 (let* ((byte-compile-bound-variables byte-compile-bound-variables)
3072 (fun (car form))
3073 (fargs (aref fun 0))
3074 (start-depth byte-compile-depth)
3075 (fmax2 (if (numberp fargs) (lsh fargs -7))) ;2*max+rest.
3076 ;; (fmin (if (numberp fargs) (logand fargs 127)))
3077 (alen (length (cdr form)))
3078 (dynbinds ()))
3079 (fetch-bytecode fun)
3080 (mapc 'byte-compile-form (cdr form))
3081 (unless fmax2
3082 ;; Old-style byte-code.
3083 (cl-assert (listp fargs))
3084 (while fargs
3085 (pcase (car fargs)
3086 (`&optional (setq fargs (cdr fargs)))
3087 (`&rest (setq fmax2 (+ (* 2 (length dynbinds)) 1))
3088 (push (cadr fargs) dynbinds)
3089 (setq fargs nil))
3090 (_ (push (pop fargs) dynbinds))))
3091 (unless fmax2 (setq fmax2 (* 2 (length dynbinds)))))
3092 (cond
3093 ((<= (+ alen alen) fmax2)
3094 ;; Add missing &optional (or &rest) arguments.
3095 (dotimes (_ (- (/ (1+ fmax2) 2) alen))
3096 (byte-compile-push-constant nil)))
3097 ((zerop (logand fmax2 1))
3098 (byte-compile-log-warning
3099 (format "Too many arguments for inlined function %S" form)
3100 nil :error)
3101 (byte-compile-discard (- alen (/ fmax2 2))))
3103 ;; Turn &rest args into a list.
3104 (let ((n (- alen (/ (1- fmax2) 2))))
3105 (cl-assert (> n 0) nil "problem: fmax2=%S alen=%S n=%S" fmax2 alen n)
3106 (if (< n 5)
3107 (byte-compile-out
3108 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- n))
3110 (byte-compile-out 'byte-listN n)))))
3111 (mapc #'byte-compile-dynamic-variable-bind dynbinds)
3112 (byte-compile-inline-lapcode
3113 (byte-decompile-bytecode-1 (aref fun 1) (aref fun 2) t)
3114 (1+ start-depth))
3115 ;; Unbind dynamic variables.
3116 (when dynbinds
3117 (byte-compile-out 'byte-unbind (length dynbinds)))
3118 (cl-assert (eq byte-compile-depth (1+ start-depth))
3119 nil "Wrong depth start=%s end=%s" start-depth byte-compile-depth)))
3121 (defun byte-compile-check-variable (var access-type)
3122 "Do various error checks before a use of the variable VAR."
3123 (when (symbolp var)
3124 (byte-compile-set-symbol-position var))
3125 (cond ((or (not (symbolp var)) (macroexp--const-symbol-p var))
3126 (when (byte-compile-warning-enabled-p 'constants)
3127 (byte-compile-warn (if (eq access-type 'let-bind)
3128 "attempt to let-bind %s ‘%s’"
3129 "variable reference to %s ‘%s’")
3130 (if (symbolp var) "constant" "nonvariable")
3131 (prin1-to-string var))))
3132 ((let ((od (get var 'byte-obsolete-variable)))
3133 (and od
3134 (not (memq var byte-compile-not-obsolete-vars))
3135 (not (memq var byte-compile-global-not-obsolete-vars))
3136 (or (pcase (nth 1 od)
3137 (`set (not (eq access-type 'reference)))
3138 (`get (eq access-type 'reference))
3139 (_ t)))))
3140 (byte-compile-warn-obsolete var))))
3142 (defsubst byte-compile-dynamic-variable-op (base-op var)
3143 (let ((tmp (assq var byte-compile-variables)))
3144 (unless tmp
3145 (setq tmp (list var))
3146 (push tmp byte-compile-variables))
3147 (byte-compile-out base-op tmp)))
3149 (defun byte-compile-dynamic-variable-bind (var)
3150 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3151 (byte-compile-check-variable var 'let-bind)
3152 (push var byte-compile-bound-variables)
3153 (byte-compile-dynamic-variable-op 'byte-varbind var))
3155 (defun byte-compile-variable-ref (var)
3156 "Generate code to push the value of the variable VAR on the stack."
3157 (byte-compile-check-variable var 'reference)
3158 (let ((lex-binding (assq var byte-compile--lexical-environment)))
3159 (if lex-binding
3160 ;; VAR is lexically bound
3161 (byte-compile-stack-ref (cdr lex-binding))
3162 ;; VAR is dynamically bound
3163 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3164 (boundp var)
3165 (memq var byte-compile-bound-variables)
3166 (memq var byte-compile-free-references))
3167 (byte-compile-warn "reference to free variable ‘%S’" var)
3168 (push var byte-compile-free-references))
3169 (byte-compile-dynamic-variable-op 'byte-varref var))))
3171 (defun byte-compile-variable-set (var)
3172 "Generate code to set the variable VAR from the top-of-stack value."
3173 (byte-compile-check-variable var 'assign)
3174 (let ((lex-binding (assq var byte-compile--lexical-environment)))
3175 (if lex-binding
3176 ;; VAR is lexically bound.
3177 (byte-compile-stack-set (cdr lex-binding))
3178 ;; VAR is dynamically bound.
3179 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3180 (boundp var)
3181 (memq var byte-compile-bound-variables)
3182 (memq var byte-compile-free-assignments))
3183 (byte-compile-warn "assignment to free variable ‘%s’" var)
3184 (push var byte-compile-free-assignments))
3185 (byte-compile-dynamic-variable-op 'byte-varset var))))
3187 (defmacro byte-compile-get-constant (const)
3188 `(or (if (stringp ,const)
3189 ;; In a string constant, treat properties as significant.
3190 (let (result)
3191 (dolist (elt byte-compile-constants)
3192 (if (equal-including-properties (car elt) ,const)
3193 (setq result elt)))
3194 result)
3195 (assq ,const byte-compile-constants))
3196 (car (setq byte-compile-constants
3197 (cons (list ,const) byte-compile-constants)))))
3199 ;; Use this when the value of a form is a constant.
3200 ;; This obeys byte-compile--for-effect.
3201 (defun byte-compile-constant (const)
3202 (if byte-compile--for-effect
3203 (setq byte-compile--for-effect nil)
3204 (when (symbolp const)
3205 (byte-compile-set-symbol-position const))
3206 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
3208 ;; Use this for a constant that is not the value of its containing form.
3209 ;; This ignores byte-compile--for-effect.
3210 (defun byte-compile-push-constant (const)
3211 (let ((byte-compile--for-effect nil))
3212 (inline (byte-compile-constant const))))
3214 ;; Compile those primitive ordinary functions
3215 ;; which have special byte codes just for speed.
3217 (defmacro byte-defop-compiler (function &optional compile-handler)
3218 "Add a compiler-form for FUNCTION.
3219 If function is a symbol, then the variable \"byte-SYMBOL\" must name
3220 the opcode to be used. If function is a list, the first element
3221 is the function and the second element is the bytecode-symbol.
3222 The second element may be nil, meaning there is no opcode.
3223 COMPILE-HANDLER is the function to use to compile this byte-op, or
3224 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3225 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
3226 (let (opcode)
3227 (if (symbolp function)
3228 (setq opcode (intern (concat "byte-" (symbol-name function))))
3229 (setq opcode (car (cdr function))
3230 function (car function)))
3231 (let ((fnform
3232 (list 'put (list 'quote function) ''byte-compile
3233 (list 'quote
3234 (or (cdr (assq compile-handler
3235 '((0 . byte-compile-no-args)
3236 (1 . byte-compile-one-arg)
3237 (2 . byte-compile-two-args)
3238 (2-and . byte-compile-and-folded)
3239 (3 . byte-compile-three-args)
3240 (0-1 . byte-compile-zero-or-one-arg)
3241 (1-2 . byte-compile-one-or-two-args)
3242 (2-3 . byte-compile-two-or-three-args)
3244 compile-handler
3245 (intern (concat "byte-compile-"
3246 (symbol-name function))))))))
3247 (if opcode
3248 (list 'progn fnform
3249 (list 'put (list 'quote function)
3250 ''byte-opcode (list 'quote opcode))
3251 (list 'put (list 'quote opcode)
3252 ''byte-opcode-invert (list 'quote function)))
3253 fnform))))
3255 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
3256 (list 'byte-defop-compiler (list function nil) compile-handler))
3259 (put 'byte-call 'byte-opcode-invert 'funcall)
3260 (put 'byte-list1 'byte-opcode-invert 'list)
3261 (put 'byte-list2 'byte-opcode-invert 'list)
3262 (put 'byte-list3 'byte-opcode-invert 'list)
3263 (put 'byte-list4 'byte-opcode-invert 'list)
3264 (put 'byte-listN 'byte-opcode-invert 'list)
3265 (put 'byte-concat2 'byte-opcode-invert 'concat)
3266 (put 'byte-concat3 'byte-opcode-invert 'concat)
3267 (put 'byte-concat4 'byte-opcode-invert 'concat)
3268 (put 'byte-concatN 'byte-opcode-invert 'concat)
3269 (put 'byte-insertN 'byte-opcode-invert 'insert)
3271 (byte-defop-compiler point 0)
3272 ;;(byte-defop-compiler mark 0) ;; obsolete
3273 (byte-defop-compiler point-max 0)
3274 (byte-defop-compiler point-min 0)
3275 (byte-defop-compiler following-char 0)
3276 (byte-defop-compiler preceding-char 0)
3277 (byte-defop-compiler current-column 0)
3278 (byte-defop-compiler eolp 0)
3279 (byte-defop-compiler eobp 0)
3280 (byte-defop-compiler bolp 0)
3281 (byte-defop-compiler bobp 0)
3282 (byte-defop-compiler current-buffer 0)
3283 ;;(byte-defop-compiler read-char 0) ;; obsolete
3284 ;; (byte-defop-compiler interactive-p 0) ;; Obsolete.
3285 (byte-defop-compiler widen 0)
3286 (byte-defop-compiler end-of-line 0-1)
3287 (byte-defop-compiler forward-char 0-1)
3288 (byte-defop-compiler forward-line 0-1)
3289 (byte-defop-compiler symbolp 1)
3290 (byte-defop-compiler consp 1)
3291 (byte-defop-compiler stringp 1)
3292 (byte-defop-compiler listp 1)
3293 (byte-defop-compiler not 1)
3294 (byte-defop-compiler (null byte-not) 1)
3295 (byte-defop-compiler car 1)
3296 (byte-defop-compiler cdr 1)
3297 (byte-defop-compiler length 1)
3298 (byte-defop-compiler symbol-value 1)
3299 (byte-defop-compiler symbol-function 1)
3300 (byte-defop-compiler (1+ byte-add1) 1)
3301 (byte-defop-compiler (1- byte-sub1) 1)
3302 (byte-defop-compiler goto-char 1)
3303 (byte-defop-compiler char-after 0-1)
3304 (byte-defop-compiler set-buffer 1)
3305 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3306 (byte-defop-compiler forward-word 0-1)
3307 (byte-defop-compiler char-syntax 1)
3308 (byte-defop-compiler nreverse 1)
3309 (byte-defop-compiler car-safe 1)
3310 (byte-defop-compiler cdr-safe 1)
3311 (byte-defop-compiler numberp 1)
3312 (byte-defop-compiler integerp 1)
3313 (byte-defop-compiler skip-chars-forward 1-2)
3314 (byte-defop-compiler skip-chars-backward 1-2)
3315 (byte-defop-compiler eq 2)
3316 (byte-defop-compiler memq 2)
3317 (byte-defop-compiler cons 2)
3318 (byte-defop-compiler aref 2)
3319 (byte-defop-compiler set 2)
3320 (byte-defop-compiler (= byte-eqlsign) 2-and)
3321 (byte-defop-compiler (< byte-lss) 2-and)
3322 (byte-defop-compiler (> byte-gtr) 2-and)
3323 (byte-defop-compiler (<= byte-leq) 2-and)
3324 (byte-defop-compiler (>= byte-geq) 2-and)
3325 (byte-defop-compiler get 2)
3326 (byte-defop-compiler nth 2)
3327 (byte-defop-compiler substring 2-3)
3328 (byte-defop-compiler (move-marker byte-set-marker) 2-3)
3329 (byte-defop-compiler set-marker 2-3)
3330 (byte-defop-compiler match-beginning 1)
3331 (byte-defop-compiler match-end 1)
3332 (byte-defop-compiler upcase 1)
3333 (byte-defop-compiler downcase 1)
3334 (byte-defop-compiler string= 2)
3335 (byte-defop-compiler string< 2)
3336 (byte-defop-compiler (string-equal byte-string=) 2)
3337 (byte-defop-compiler (string-lessp byte-string<) 2)
3338 (byte-defop-compiler equal 2)
3339 (byte-defop-compiler nthcdr 2)
3340 (byte-defop-compiler elt 2)
3341 (byte-defop-compiler member 2)
3342 (byte-defop-compiler assq 2)
3343 (byte-defop-compiler (rplaca byte-setcar) 2)
3344 (byte-defop-compiler (rplacd byte-setcdr) 2)
3345 (byte-defop-compiler setcar 2)
3346 (byte-defop-compiler setcdr 2)
3347 (byte-defop-compiler buffer-substring 2)
3348 (byte-defop-compiler delete-region 2)
3349 (byte-defop-compiler narrow-to-region 2)
3350 (byte-defop-compiler (% byte-rem) 2)
3351 (byte-defop-compiler aset 3)
3353 (byte-defop-compiler max byte-compile-associative)
3354 (byte-defop-compiler min byte-compile-associative)
3355 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3356 (byte-defop-compiler (* byte-mult) byte-compile-associative)
3358 ;;####(byte-defop-compiler move-to-column 1)
3359 (byte-defop-compiler-1 interactive byte-compile-noop)
3362 (defun byte-compile-subr-wrong-args (form n)
3363 (byte-compile-set-symbol-position (car form))
3364 (byte-compile-warn "‘%s’ called with %d arg%s, but requires %s"
3365 (car form) (length (cdr form))
3366 (if (= 1 (length (cdr form))) "" "s") n)
3367 ;; Get run-time wrong-number-of-args error.
3368 (byte-compile-normal-call form))
3370 (defun byte-compile-no-args (form)
3371 (if (not (= (length form) 1))
3372 (byte-compile-subr-wrong-args form "none")
3373 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3375 (defun byte-compile-one-arg (form)
3376 (if (not (= (length form) 2))
3377 (byte-compile-subr-wrong-args form 1)
3378 (byte-compile-form (car (cdr form))) ;; Push the argument
3379 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3381 (defun byte-compile-two-args (form)
3382 (if (not (= (length form) 3))
3383 (byte-compile-subr-wrong-args form 2)
3384 (byte-compile-form (car (cdr form))) ;; Push the arguments
3385 (byte-compile-form (nth 2 form))
3386 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3388 (defun byte-compile-and-folded (form)
3389 "Compile calls to functions like `<='.
3390 These implicitly `and' together a bunch of two-arg bytecodes."
3391 (let ((l (length form)))
3392 (cond
3393 ((< l 3) (byte-compile-form `(progn ,(nth 1 form) t)))
3394 ((= l 3) (byte-compile-two-args form))
3395 ((cl-every #'macroexp-copyable-p (nthcdr 2 form))
3396 (byte-compile-form `(and (,(car form) ,(nth 1 form) ,(nth 2 form))
3397 (,(car form) ,@(nthcdr 2 form)))))
3398 (t (byte-compile-normal-call form)))))
3400 (defun byte-compile-three-args (form)
3401 (if (not (= (length form) 4))
3402 (byte-compile-subr-wrong-args form 3)
3403 (byte-compile-form (car (cdr form))) ;; Push the arguments
3404 (byte-compile-form (nth 2 form))
3405 (byte-compile-form (nth 3 form))
3406 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3408 (defun byte-compile-zero-or-one-arg (form)
3409 (let ((len (length form)))
3410 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3411 ((= len 2) (byte-compile-one-arg form))
3412 (t (byte-compile-subr-wrong-args form "0-1")))))
3414 (defun byte-compile-one-or-two-args (form)
3415 (let ((len (length form)))
3416 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3417 ((= len 3) (byte-compile-two-args form))
3418 (t (byte-compile-subr-wrong-args form "1-2")))))
3420 (defun byte-compile-two-or-three-args (form)
3421 (let ((len (length form)))
3422 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3423 ((= len 4) (byte-compile-three-args form))
3424 (t (byte-compile-subr-wrong-args form "2-3")))))
3426 (defun byte-compile-noop (_form)
3427 (byte-compile-constant nil))
3429 (defun byte-compile-discard (&optional num preserve-tos)
3430 "Output byte codes to discard the NUM entries at the top of the stack.
3431 NUM defaults to 1.
3432 If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3433 popped before discarding the num values, and then pushed back again after
3434 discarding."
3435 (if (and (null num) (not preserve-tos))
3436 ;; common case
3437 (byte-compile-out 'byte-discard)
3438 ;; general case
3439 (unless num
3440 (setq num 1))
3441 (when (and preserve-tos (> num 0))
3442 ;; Preserve the top-of-stack value by writing it directly to the stack
3443 ;; location which will be at the top-of-stack after popping.
3444 (byte-compile-stack-set (1- (- byte-compile-depth num)))
3445 ;; Now we actually discard one less value, since we want to keep
3446 ;; the eventual TOS
3447 (setq num (1- num)))
3448 (while (> num 0)
3449 (byte-compile-out 'byte-discard)
3450 (setq num (1- num)))))
3452 (defun byte-compile-stack-ref (stack-pos)
3453 "Output byte codes to push the value at stack position STACK-POS."
3454 (let ((dist (- byte-compile-depth (1+ stack-pos))))
3455 (if (zerop dist)
3456 ;; A simple optimization
3457 (byte-compile-out 'byte-dup)
3458 ;; normal case
3459 (byte-compile-out 'byte-stack-ref dist))))
3461 (defun byte-compile-stack-set (stack-pos)
3462 "Output byte codes to store the TOS value at stack position STACK-POS."
3463 (byte-compile-out 'byte-stack-set (- byte-compile-depth (1+ stack-pos))))
3465 (byte-defop-compiler-1 internal-make-closure byte-compile-make-closure)
3466 (byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var)
3468 (defun byte-compile-make-closure (form)
3469 "Byte-compile the special `internal-make-closure' form."
3470 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
3471 (let* ((vars (nth 1 form))
3472 (env (nth 2 form))
3473 (docstring-exp (nth 3 form))
3474 (body (nthcdr 4 form))
3475 (fun
3476 (byte-compile-lambda `(lambda ,vars . ,body) nil (length env))))
3477 (cl-assert (or (> (length env) 0)
3478 docstring-exp)) ;Otherwise, we don't need a closure.
3479 (cl-assert (byte-code-function-p fun))
3480 (byte-compile-form `(make-byte-code
3481 ',(aref fun 0) ',(aref fun 1)
3482 (vconcat (vector . ,env) ',(aref fun 2))
3483 ,@(let ((rest (nthcdr 3 (mapcar (lambda (x) `',x) fun))))
3484 (if docstring-exp
3485 `(,(car rest)
3486 ,docstring-exp
3487 ,@(cddr rest))
3488 rest)))))))
3490 (defun byte-compile-get-closed-var (form)
3491 "Byte-compile the special `internal-get-closed-var' form."
3492 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
3493 (byte-compile-out 'byte-constant (nth 1 form))))
3495 ;; Compile a function that accepts one or more args and is right-associative.
3496 ;; We do it by left-associativity so that the operations
3497 ;; are done in the same order as in interpreted code.
3498 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3499 ;; in order to convert markers to numbers, and trigger expected errors.
3500 (defun byte-compile-associative (form)
3501 (if (cdr form)
3502 (let ((opcode (get (car form) 'byte-opcode))
3503 args)
3504 (if (and (< 3 (length form))
3505 (memq opcode (list (get '+ 'byte-opcode)
3506 (get '* 'byte-opcode))))
3507 ;; Don't use binary operations for > 2 operands, as that
3508 ;; may cause overflow/truncation in float operations.
3509 (byte-compile-normal-call form)
3510 (setq args (copy-sequence (cdr form)))
3511 (byte-compile-form (car args))
3512 (setq args (cdr args))
3513 (or args (setq args '(0)
3514 opcode (get '+ 'byte-opcode)))
3515 (dolist (arg args)
3516 (byte-compile-form arg)
3517 (byte-compile-out opcode 0))))
3518 (byte-compile-constant (eval form))))
3521 ;; more complicated compiler macros
3523 (byte-defop-compiler char-before)
3524 (byte-defop-compiler backward-char)
3525 (byte-defop-compiler backward-word)
3526 (byte-defop-compiler list)
3527 (byte-defop-compiler concat)
3528 (byte-defop-compiler fset)
3529 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3530 (byte-defop-compiler indent-to)
3531 (byte-defop-compiler insert)
3532 (byte-defop-compiler-1 function byte-compile-function-form)
3533 (byte-defop-compiler-1 - byte-compile-minus)
3534 (byte-defop-compiler (/ byte-quo) byte-compile-quo)
3535 (byte-defop-compiler nconc)
3537 ;; Is this worth it? Both -before and -after are written in C.
3538 (defun byte-compile-char-before (form)
3539 (cond ((or (= 1 (length form))
3540 (and (= 2 (length form)) (not (nth 1 form))))
3541 (byte-compile-form '(char-after (1- (point)))))
3542 ((= 2 (length form))
3543 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3544 (1- (nth 1 form))
3545 `(1- (or ,(nth 1 form)
3546 (point)))))))
3547 (t (byte-compile-subr-wrong-args form "0-1"))))
3549 ;; backward-... ==> forward-... with negated argument.
3550 ;; Is this worth it? Both -backward and -forward are written in C.
3551 (defun byte-compile-backward-char (form)
3552 (cond ((or (= 1 (length form))
3553 (and (= 2 (length form)) (not (nth 1 form))))
3554 (byte-compile-form '(forward-char -1)))
3555 ((= 2 (length form))
3556 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3557 (- (nth 1 form))
3558 `(- (or ,(nth 1 form) 1))))))
3559 (t (byte-compile-subr-wrong-args form "0-1"))))
3561 (defun byte-compile-backward-word (form)
3562 (cond ((or (= 1 (length form))
3563 (and (= 2 (length form)) (not (nth 1 form))))
3564 (byte-compile-form '(forward-word -1)))
3565 ((= 2 (length form))
3566 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3567 (- (nth 1 form))
3568 `(- (or ,(nth 1 form) 1))))))
3569 (t (byte-compile-subr-wrong-args form "0-1"))))
3571 (defun byte-compile-list (form)
3572 (let ((count (length (cdr form))))
3573 (cond ((= count 0)
3574 (byte-compile-constant nil))
3575 ((< count 5)
3576 (mapc 'byte-compile-form (cdr form))
3577 (byte-compile-out
3578 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3579 ((< count 256)
3580 (mapc 'byte-compile-form (cdr form))
3581 (byte-compile-out 'byte-listN count))
3582 (t (byte-compile-normal-call form)))))
3584 (defun byte-compile-concat (form)
3585 (let ((count (length (cdr form))))
3586 (cond ((and (< 1 count) (< count 5))
3587 (mapc 'byte-compile-form (cdr form))
3588 (byte-compile-out
3589 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3591 ;; Concat of one arg is not a no-op if arg is not a string.
3592 ((= count 0)
3593 (byte-compile-form ""))
3594 ((< count 256)
3595 (mapc 'byte-compile-form (cdr form))
3596 (byte-compile-out 'byte-concatN count))
3597 ((byte-compile-normal-call form)))))
3599 (defun byte-compile-minus (form)
3600 (let ((len (length form)))
3601 (cond
3602 ((= 1 len) (byte-compile-constant 0))
3603 ((= 2 len)
3604 (byte-compile-form (cadr form))
3605 (byte-compile-out 'byte-negate 0))
3606 ((= 3 len)
3607 (byte-compile-form (nth 1 form))
3608 (byte-compile-form (nth 2 form))
3609 (byte-compile-out 'byte-diff 0))
3610 ;; Don't use binary operations for > 2 operands, as that may
3611 ;; cause overflow/truncation in float operations.
3612 (t (byte-compile-normal-call form)))))
3614 (defun byte-compile-quo (form)
3615 (let ((len (length form)))
3616 (cond ((<= len 2)
3617 (byte-compile-subr-wrong-args form "2 or more"))
3618 ((= len 3)
3619 (byte-compile-two-args form))
3621 ;; Don't use binary operations for > 2 operands, as that
3622 ;; may cause overflow/truncation in float operations.
3623 (byte-compile-normal-call form)))))
3625 (defun byte-compile-nconc (form)
3626 (let ((len (length form)))
3627 (cond ((= len 1)
3628 (byte-compile-constant nil))
3629 ((= len 2)
3630 ;; nconc of one arg is a noop, even if that arg isn't a list.
3631 (byte-compile-form (nth 1 form)))
3633 (byte-compile-form (car (setq form (cdr form))))
3634 (while (setq form (cdr form))
3635 (byte-compile-form (car form))
3636 (byte-compile-out 'byte-nconc 0))))))
3638 (defun byte-compile-fset (form)
3639 ;; warn about forms like (fset 'foo '(lambda () ...))
3640 ;; (where the lambda expression is non-trivial...)
3641 (let ((fn (nth 2 form))
3642 body)
3643 (if (and (eq (car-safe fn) 'quote)
3644 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3645 (progn
3646 (setq body (cdr (cdr fn)))
3647 (if (stringp (car body)) (setq body (cdr body)))
3648 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3649 (if (and (consp (car body))
3650 (not (eq 'byte-code (car (car body)))))
3651 (byte-compile-warn
3652 "A quoted lambda form is the second argument of `fset'. This is probably
3653 not what you want, as that lambda cannot be compiled. Consider using
3654 the syntax #'(lambda (...) ...) instead.")))))
3655 (byte-compile-two-args form))
3657 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3658 ;; Otherwise it will be incompatible with the interpreter,
3659 ;; and (funcall (function foo)) will lose with autoloads.
3661 (defun byte-compile-function-form (form)
3662 (let ((f (nth 1 form)))
3663 (when (and (symbolp f)
3664 (byte-compile-warning-enabled-p 'callargs))
3665 (byte-compile-function-warn f t (byte-compile-fdefinition f nil)))
3667 (byte-compile-constant (if (eq 'lambda (car-safe f))
3668 (byte-compile-lambda f)
3669 f))))
3671 (defun byte-compile-indent-to (form)
3672 (let ((len (length form)))
3673 (cond ((= len 2)
3674 (byte-compile-form (car (cdr form)))
3675 (byte-compile-out 'byte-indent-to 0))
3676 ((= len 3)
3677 ;; no opcode for 2-arg case.
3678 (byte-compile-normal-call form))
3680 (byte-compile-subr-wrong-args form "1-2")))))
3682 (defun byte-compile-insert (form)
3683 (cond ((null (cdr form))
3684 (byte-compile-constant nil))
3685 ((<= (length form) 256)
3686 (mapc 'byte-compile-form (cdr form))
3687 (if (cdr (cdr form))
3688 (byte-compile-out 'byte-insertN (length (cdr form)))
3689 (byte-compile-out 'byte-insert 0)))
3690 ((memq t (mapcar 'consp (cdr (cdr form))))
3691 (byte-compile-normal-call form))
3692 ;; We can split it; there is no function call after inserting 1st arg.
3694 (while (setq form (cdr form))
3695 (byte-compile-form (car form))
3696 (byte-compile-out 'byte-insert 0)
3697 (if (cdr form)
3698 (byte-compile-discard))))))
3701 (byte-defop-compiler-1 setq)
3702 (byte-defop-compiler-1 setq-default)
3703 (byte-defop-compiler-1 quote)
3705 (defun byte-compile-setq (form)
3706 (let ((args (cdr form)))
3707 (if args
3708 (while args
3709 (byte-compile-form (car (cdr args)))
3710 (or byte-compile--for-effect (cdr (cdr args))
3711 (byte-compile-out 'byte-dup 0))
3712 (byte-compile-variable-set (car args))
3713 (setq args (cdr (cdr args))))
3714 ;; (setq), with no arguments.
3715 (byte-compile-form nil byte-compile--for-effect))
3716 (setq byte-compile--for-effect nil)))
3718 (defun byte-compile-setq-default (form)
3719 (setq form (cdr form))
3720 (if (null form) ; (setq-default), with no arguments
3721 (byte-compile-form nil byte-compile--for-effect)
3722 (if (> (length form) 2)
3723 (let ((setters ()))
3724 (while (consp form)
3725 (push `(setq-default ,(pop form) ,(pop form)) setters))
3726 (byte-compile-form (cons 'progn (nreverse setters))))
3727 (let ((var (car form)))
3728 (and (or (not (symbolp var))
3729 (macroexp--const-symbol-p var t))
3730 (byte-compile-warning-enabled-p 'constants)
3731 (byte-compile-warn
3732 "variable assignment to %s ‘%s’"
3733 (if (symbolp var) "constant" "nonvariable")
3734 (prin1-to-string var)))
3735 (byte-compile-normal-call `(set-default ',var ,@(cdr form)))))))
3737 (byte-defop-compiler-1 set-default)
3738 (defun byte-compile-set-default (form)
3739 (let ((varexp (car-safe (cdr-safe form))))
3740 (if (eq (car-safe varexp) 'quote)
3741 ;; If the varexp is constant, compile it as a setq-default
3742 ;; so we get more warnings.
3743 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3744 ,@(cddr form)))
3745 (byte-compile-normal-call form))))
3747 (defun byte-compile-quote (form)
3748 (byte-compile-constant (car (cdr form))))
3750 ;;; control structures
3752 (defun byte-compile-body (body &optional for-effect)
3753 (while (cdr body)
3754 (byte-compile-form (car body) t)
3755 (setq body (cdr body)))
3756 (byte-compile-form (car body) for-effect))
3758 (defsubst byte-compile-body-do-effect (body)
3759 (byte-compile-body body byte-compile--for-effect)
3760 (setq byte-compile--for-effect nil))
3762 (defsubst byte-compile-form-do-effect (form)
3763 (byte-compile-form form byte-compile--for-effect)
3764 (setq byte-compile--for-effect nil))
3766 (byte-defop-compiler-1 inline byte-compile-progn)
3767 (byte-defop-compiler-1 progn)
3768 (byte-defop-compiler-1 prog1)
3769 (byte-defop-compiler-1 prog2)
3770 (byte-defop-compiler-1 if)
3771 (byte-defop-compiler-1 cond)
3772 (byte-defop-compiler-1 and)
3773 (byte-defop-compiler-1 or)
3774 (byte-defop-compiler-1 while)
3775 (byte-defop-compiler-1 funcall)
3776 (byte-defop-compiler-1 let)
3777 (byte-defop-compiler-1 let* byte-compile-let)
3779 (defun byte-compile-progn (form)
3780 (byte-compile-body-do-effect (cdr form)))
3782 (defun byte-compile-prog1 (form)
3783 (byte-compile-form-do-effect (car (cdr form)))
3784 (byte-compile-body (cdr (cdr form)) t))
3786 (defun byte-compile-prog2 (form)
3787 (byte-compile-form (nth 1 form) t)
3788 (byte-compile-form-do-effect (nth 2 form))
3789 (byte-compile-body (cdr (cdr (cdr form))) t))
3791 (defmacro byte-compile-goto-if (cond discard tag)
3792 `(byte-compile-goto
3793 (if ,cond
3794 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3795 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3796 ,tag))
3798 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3799 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3800 (defun byte-compile-find-bound-condition (condition-param
3801 pred-list
3802 &optional only-if-not-present)
3803 (let ((result nil)
3804 (nth-one nil)
3805 (cond-list
3806 (if (memq (car-safe condition-param) pred-list)
3807 ;; The condition appears by itself.
3808 (list condition-param)
3809 ;; If the condition is an `and', look for matches among the
3810 ;; `and' arguments.
3811 (when (eq 'and (car-safe condition-param))
3812 (cdr condition-param)))))
3814 (dolist (crt cond-list)
3815 (when (and (memq (car-safe crt) pred-list)
3816 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3817 ;; Ignore if the symbol is already on the unresolved
3818 ;; list.
3819 (not (assq (nth 1 nth-one) ; the relevant symbol
3820 only-if-not-present)))
3821 (push (nth 1 (nth 1 crt)) result)))
3822 result))
3824 (defmacro byte-compile-maybe-guarded (condition &rest body)
3825 "Execute forms in BODY, potentially guarded by CONDITION.
3826 CONDITION is a variable whose value is a test in an `if' or `cond'.
3827 BODY is the code to compile in the first arm of the if or the body of
3828 the cond clause. If CONDITION's value is of the form (fboundp \\='foo)
3829 or (boundp \\='foo), the relevant warnings from BODY about foo's
3830 being undefined (or obsolete) will be suppressed.
3832 If CONDITION's value is (not (featurep \\='emacs)) or (featurep \\='xemacs),
3833 that suppresses all warnings during execution of BODY."
3834 (declare (indent 1) (debug t))
3835 `(let* ((fbound-list (byte-compile-find-bound-condition
3836 ,condition '(fboundp functionp)
3837 byte-compile-unresolved-functions))
3838 (bound-list (byte-compile-find-bound-condition
3839 ,condition '(boundp default-boundp)))
3840 ;; Maybe add to the bound list.
3841 (byte-compile-bound-variables
3842 (append bound-list byte-compile-bound-variables)))
3843 (unwind-protect
3844 ;; If things not being bound at all is ok, so must them being
3845 ;; obsolete. Note that we add to the existing lists since Tramp
3846 ;; (ab)uses this feature.
3847 ;; FIXME: If `foo' is obsoleted by `bar', the code below
3848 ;; correctly arranges to silence the warnings after testing
3849 ;; existence of `foo', but the warning should also be
3850 ;; silenced after testing the existence of `bar'.
3851 (let ((byte-compile-not-obsolete-vars
3852 (append byte-compile-not-obsolete-vars bound-list))
3853 (byte-compile-not-obsolete-funcs
3854 (append byte-compile-not-obsolete-funcs fbound-list)))
3855 ,@body)
3856 ;; Maybe remove the function symbol from the unresolved list.
3857 (dolist (fbound fbound-list)
3858 (when fbound
3859 (setq byte-compile-unresolved-functions
3860 (delq (assq fbound byte-compile-unresolved-functions)
3861 byte-compile-unresolved-functions)))))))
3863 (defun byte-compile-if (form)
3864 (byte-compile-form (car (cdr form)))
3865 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3866 ;; and avoid warnings about the relevant symbols in the consequent.
3867 (let ((clause (nth 1 form))
3868 (donetag (byte-compile-make-tag)))
3869 (if (null (nthcdr 3 form))
3870 ;; No else-forms
3871 (progn
3872 (byte-compile-goto-if nil byte-compile--for-effect donetag)
3873 (byte-compile-maybe-guarded clause
3874 (byte-compile-form (nth 2 form) byte-compile--for-effect))
3875 (byte-compile-out-tag donetag))
3876 (let ((elsetag (byte-compile-make-tag)))
3877 (byte-compile-goto 'byte-goto-if-nil elsetag)
3878 (byte-compile-maybe-guarded clause
3879 (byte-compile-form (nth 2 form) byte-compile--for-effect))
3880 (byte-compile-goto 'byte-goto donetag)
3881 (byte-compile-out-tag elsetag)
3882 (byte-compile-maybe-guarded (list 'not clause)
3883 (byte-compile-body (cdr (cdr (cdr form))) byte-compile--for-effect))
3884 (byte-compile-out-tag donetag))))
3885 (setq byte-compile--for-effect nil))
3887 (defun byte-compile-cond (clauses)
3888 (let ((donetag (byte-compile-make-tag))
3889 nexttag clause)
3890 (while (setq clauses (cdr clauses))
3891 (setq clause (car clauses))
3892 (cond ((or (eq (car clause) t)
3893 (and (eq (car-safe (car clause)) 'quote)
3894 (car-safe (cdr-safe (car clause)))))
3895 ;; Unconditional clause
3896 (setq clause (cons t clause)
3897 clauses nil))
3898 ((cdr clauses)
3899 (byte-compile-form (car clause))
3900 (if (null (cdr clause))
3901 ;; First clause is a singleton.
3902 (byte-compile-goto-if t byte-compile--for-effect donetag)
3903 (setq nexttag (byte-compile-make-tag))
3904 (byte-compile-goto 'byte-goto-if-nil nexttag)
3905 (byte-compile-maybe-guarded (car clause)
3906 (byte-compile-body (cdr clause) byte-compile--for-effect))
3907 (byte-compile-goto 'byte-goto donetag)
3908 (byte-compile-out-tag nexttag)))))
3909 ;; Last clause
3910 (let ((guard (car clause)))
3911 (and (cdr clause) (not (eq guard t))
3912 (progn (byte-compile-form guard)
3913 (byte-compile-goto-if nil byte-compile--for-effect donetag)
3914 (setq clause (cdr clause))))
3915 (byte-compile-maybe-guarded guard
3916 (byte-compile-body-do-effect clause)))
3917 (byte-compile-out-tag donetag)))
3919 (defun byte-compile-and (form)
3920 (let ((failtag (byte-compile-make-tag))
3921 (args (cdr form)))
3922 (if (null args)
3923 (byte-compile-form-do-effect t)
3924 (byte-compile-and-recursion args failtag))))
3926 ;; Handle compilation of a nontrivial `and' call.
3927 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3928 (defun byte-compile-and-recursion (rest failtag)
3929 (if (cdr rest)
3930 (progn
3931 (byte-compile-form (car rest))
3932 (byte-compile-goto-if nil byte-compile--for-effect failtag)
3933 (byte-compile-maybe-guarded (car rest)
3934 (byte-compile-and-recursion (cdr rest) failtag)))
3935 (byte-compile-form-do-effect (car rest))
3936 (byte-compile-out-tag failtag)))
3938 (defun byte-compile-or (form)
3939 (let ((wintag (byte-compile-make-tag))
3940 (args (cdr form)))
3941 (if (null args)
3942 (byte-compile-form-do-effect nil)
3943 (byte-compile-or-recursion args wintag))))
3945 ;; Handle compilation of a nontrivial `or' call.
3946 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3947 (defun byte-compile-or-recursion (rest wintag)
3948 (if (cdr rest)
3949 (progn
3950 (byte-compile-form (car rest))
3951 (byte-compile-goto-if t byte-compile--for-effect wintag)
3952 (byte-compile-maybe-guarded (list 'not (car rest))
3953 (byte-compile-or-recursion (cdr rest) wintag)))
3954 (byte-compile-form-do-effect (car rest))
3955 (byte-compile-out-tag wintag)))
3957 (defun byte-compile-while (form)
3958 (let ((endtag (byte-compile-make-tag))
3959 (looptag (byte-compile-make-tag)))
3960 (byte-compile-out-tag looptag)
3961 (byte-compile-form (car (cdr form)))
3962 (byte-compile-goto-if nil byte-compile--for-effect endtag)
3963 (byte-compile-body (cdr (cdr form)) t)
3964 (byte-compile-goto 'byte-goto looptag)
3965 (byte-compile-out-tag endtag)
3966 (setq byte-compile--for-effect nil)))
3968 (defun byte-compile-funcall (form)
3969 (mapc 'byte-compile-form (cdr form))
3970 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3973 ;; let binding
3975 (defun byte-compile-push-binding-init (clause)
3976 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
3977 Return the offset in the form (VAR . OFFSET)."
3978 (let* ((var (if (consp clause) (car clause) clause)))
3979 ;; We record the stack position even of dynamic bindings; we'll put
3980 ;; them in the proper place later.
3981 (prog1 (cons var byte-compile-depth)
3982 (if (consp clause)
3983 (byte-compile-form (cadr clause))
3984 (byte-compile-push-constant nil)))))
3986 (defun byte-compile-not-lexical-var-p (var)
3987 (or (not (symbolp var))
3988 (special-variable-p var)
3989 (memq var byte-compile-bound-variables)
3990 (memq var '(nil t))
3991 (keywordp var)))
3993 (defun byte-compile-bind (var init-lexenv)
3994 "Emit byte-codes to bind VAR and update `byte-compile--lexical-environment'.
3995 INIT-LEXENV should be a lexical-environment alist describing the
3996 positions of the init value that have been pushed on the stack.
3997 Return non-nil if the TOS value was popped."
3998 ;; The mix of lexical and dynamic bindings mean that we may have to
3999 ;; juggle things on the stack, to move them to TOS for
4000 ;; dynamic binding.
4001 (if (and lexical-binding (not (byte-compile-not-lexical-var-p var)))
4002 ;; VAR is a simple stack-allocated lexical variable.
4003 (progn (push (assq var init-lexenv)
4004 byte-compile--lexical-environment)
4005 nil)
4006 ;; VAR should be dynamically bound.
4007 (while (assq var byte-compile--lexical-environment)
4008 ;; This dynamic binding shadows a lexical binding.
4009 (setq byte-compile--lexical-environment
4010 (remq (assq var byte-compile--lexical-environment)
4011 byte-compile--lexical-environment)))
4012 (cond
4013 ((eq var (caar init-lexenv))
4014 ;; VAR is dynamic and is on the top of the
4015 ;; stack, so we can just bind it like usual.
4016 (byte-compile-dynamic-variable-bind var)
4019 ;; VAR is dynamic, but we have to get its
4020 ;; value out of the middle of the stack.
4021 (let ((stack-pos (cdr (assq var init-lexenv))))
4022 (byte-compile-stack-ref stack-pos)
4023 (byte-compile-dynamic-variable-bind var)
4024 ;; Now we have to store nil into its temporary
4025 ;; stack position so it doesn't prevent the value from being GC'd.
4026 ;; FIXME: Not worth the trouble.
4027 ;; (byte-compile-push-constant nil)
4028 ;; (byte-compile-stack-set stack-pos)
4030 nil))))
4032 (defun byte-compile-unbind (clauses init-lexenv preserve-body-value)
4033 "Emit byte-codes to unbind the variables bound by CLAUSES.
4034 CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
4035 lexical-environment alist describing the positions of the init value that
4036 have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
4037 then an additional value on the top of the stack, above any lexical binding
4038 slots, is preserved, so it will be on the top of the stack after all
4039 binding slots have been popped."
4040 ;; Unbind dynamic variables.
4041 (let ((num-dynamic-bindings 0))
4042 (dolist (clause clauses)
4043 (unless (assq (if (consp clause) (car clause) clause)
4044 byte-compile--lexical-environment)
4045 (setq num-dynamic-bindings (1+ num-dynamic-bindings))))
4046 (unless (zerop num-dynamic-bindings)
4047 (byte-compile-out 'byte-unbind num-dynamic-bindings)))
4048 ;; Pop lexical variables off the stack, possibly preserving the
4049 ;; return value of the body.
4050 (when init-lexenv
4051 ;; INIT-LEXENV contains all init values left on the stack.
4052 (byte-compile-discard (length init-lexenv) preserve-body-value)))
4054 (defun byte-compile-let (form)
4055 "Generate code for the `let' or `let*' form FORM."
4056 (let ((clauses (cadr form))
4057 (init-lexenv nil)
4058 (is-let (eq (car form) 'let)))
4059 (when is-let
4060 ;; First compute the binding values in the old scope.
4061 (dolist (var clauses)
4062 (push (byte-compile-push-binding-init var) init-lexenv)))
4063 ;; New scope.
4064 (let ((byte-compile-bound-variables byte-compile-bound-variables)
4065 (byte-compile--lexical-environment
4066 byte-compile--lexical-environment))
4067 ;; Bind the variables.
4068 ;; For `let', do it in reverse order, because it makes no
4069 ;; semantic difference, but it is a lot more efficient since the
4070 ;; values are now in reverse order on the stack.
4071 (dolist (var (if is-let (reverse clauses) clauses))
4072 (unless is-let
4073 (push (byte-compile-push-binding-init var) init-lexenv))
4074 (let ((var (if (consp var) (car var) var)))
4075 (if (byte-compile-bind var init-lexenv)
4076 (pop init-lexenv))))
4077 ;; Emit the body.
4078 (let ((init-stack-depth byte-compile-depth))
4079 (byte-compile-body-do-effect (cdr (cdr form)))
4080 ;; Unbind both lexical and dynamic variables.
4081 (cl-assert (or (eq byte-compile-depth init-stack-depth)
4082 (eq byte-compile-depth (1+ init-stack-depth))))
4083 (byte-compile-unbind clauses init-lexenv
4084 (> byte-compile-depth init-stack-depth))))))
4088 (byte-defop-compiler-1 /= byte-compile-negated)
4089 (byte-defop-compiler-1 atom byte-compile-negated)
4090 (byte-defop-compiler-1 nlistp byte-compile-negated)
4092 (put '/= 'byte-compile-negated-op '=)
4093 (put 'atom 'byte-compile-negated-op 'consp)
4094 (put 'nlistp 'byte-compile-negated-op 'listp)
4096 (defun byte-compile-negated (form)
4097 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
4099 ;; Even when optimization is off, /= is optimized to (not (= ...)).
4100 (defun byte-compile-negation-optimizer (form)
4101 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
4102 (byte-compile-set-symbol-position (car form))
4103 (list 'not
4104 (cons (or (get (car form) 'byte-compile-negated-op)
4105 (error
4106 "Compiler error: ‘%s’ has no ‘byte-compile-negated-op’ property"
4107 (car form)))
4108 (cdr form))))
4110 ;;; other tricky macro-like special-forms
4112 (byte-defop-compiler-1 catch)
4113 (byte-defop-compiler-1 unwind-protect)
4114 (byte-defop-compiler-1 condition-case)
4115 (byte-defop-compiler-1 save-excursion)
4116 (byte-defop-compiler-1 save-current-buffer)
4117 (byte-defop-compiler-1 save-restriction)
4118 ;; (byte-defop-compiler-1 save-window-excursion) ;Obsolete: now a macro.
4119 ;; (byte-defop-compiler-1 with-output-to-temp-buffer) ;Obsolete: now a macro.
4121 (defvar byte-compile--use-old-handlers nil
4122 "If nil, use new byte codes introduced in Emacs-24.4.")
4124 (defun byte-compile-catch (form)
4125 (byte-compile-form (car (cdr form)))
4126 (if (not byte-compile--use-old-handlers)
4127 (let ((endtag (byte-compile-make-tag)))
4128 (byte-compile-goto 'byte-pushcatch endtag)
4129 (byte-compile-body (cddr form) nil)
4130 (byte-compile-out 'byte-pophandler)
4131 (byte-compile-out-tag endtag))
4132 (pcase (cddr form)
4133 (`(:fun-body ,f)
4134 (byte-compile-form `(list 'funcall ,f)))
4135 (body
4136 (byte-compile-push-constant
4137 (byte-compile-top-level (cons 'progn body) byte-compile--for-effect))))
4138 (byte-compile-out 'byte-catch 0)))
4140 (defun byte-compile-unwind-protect (form)
4141 (pcase (cddr form)
4142 (`(:fun-body ,f)
4143 (byte-compile-form
4144 (if byte-compile--use-old-handlers `(list (list 'funcall ,f)) f)))
4145 (handlers
4146 (if byte-compile--use-old-handlers
4147 (byte-compile-push-constant
4148 (byte-compile-top-level-body handlers t))
4149 (byte-compile-form `#'(lambda () ,@handlers)))))
4150 (byte-compile-out 'byte-unwind-protect 0)
4151 (byte-compile-form-do-effect (car (cdr form)))
4152 (byte-compile-out 'byte-unbind 1))
4154 (defun byte-compile-condition-case (form)
4155 (if byte-compile--use-old-handlers
4156 (byte-compile-condition-case--old form)
4157 (byte-compile-condition-case--new form)))
4159 (defun byte-compile-condition-case--old (form)
4160 (let* ((var (nth 1 form))
4161 (fun-bodies (eq var :fun-body))
4162 (byte-compile-bound-variables
4163 (if (and var (not fun-bodies))
4164 (cons var byte-compile-bound-variables)
4165 byte-compile-bound-variables)))
4166 (byte-compile-set-symbol-position 'condition-case)
4167 (unless (symbolp var)
4168 (byte-compile-warn
4169 "‘%s’ is not a variable-name or nil (in condition-case)" var))
4170 (if fun-bodies (setq var (make-symbol "err")))
4171 (byte-compile-push-constant var)
4172 (if fun-bodies
4173 (byte-compile-form `(list 'funcall ,(nth 2 form)))
4174 (byte-compile-push-constant
4175 (byte-compile-top-level (nth 2 form) byte-compile--for-effect)))
4176 (let ((compiled-clauses
4177 (mapcar
4178 (lambda (clause)
4179 (let ((condition (car clause)))
4180 (cond ((not (or (symbolp condition)
4181 (and (listp condition)
4182 (let ((ok t))
4183 (dolist (sym condition)
4184 (if (not (symbolp sym))
4185 (setq ok nil)))
4186 ok))))
4187 (byte-compile-warn
4188 "‘%S’ is not a condition name or list of such (in condition-case)"
4189 condition))
4190 ;; (not (or (eq condition 't)
4191 ;; (and (stringp (get condition 'error-message))
4192 ;; (consp (get condition
4193 ;; 'error-conditions)))))
4194 ;; (byte-compile-warn
4195 ;; "‘%s’ is not a known condition name
4196 ;; (in condition-case)"
4197 ;; condition))
4199 (if fun-bodies
4200 `(list ',condition (list 'funcall ,(cadr clause) ',var))
4201 (cons condition
4202 (byte-compile-top-level-body
4203 (cdr clause) byte-compile--for-effect)))))
4204 (cdr (cdr (cdr form))))))
4205 (if fun-bodies
4206 (byte-compile-form `(list ,@compiled-clauses))
4207 (byte-compile-push-constant compiled-clauses)))
4208 (byte-compile-out 'byte-condition-case 0)))
4210 (defun byte-compile-condition-case--new (form)
4211 (let* ((var (nth 1 form))
4212 (body (nth 2 form))
4213 (depth byte-compile-depth)
4214 (clauses (mapcar (lambda (clause)
4215 (cons (byte-compile-make-tag) clause))
4216 (nthcdr 3 form)))
4217 (endtag (byte-compile-make-tag)))
4218 (byte-compile-set-symbol-position 'condition-case)
4219 (unless (symbolp var)
4220 (byte-compile-warn
4221 "‘%s’ is not a variable-name or nil (in condition-case)" var))
4223 (dolist (clause (reverse clauses))
4224 (let ((condition (nth 1 clause)))
4225 (unless (consp condition) (setq condition (list condition)))
4226 (dolist (c condition)
4227 (unless (and c (symbolp c))
4228 (byte-compile-warn
4229 "‘%S’ is not a condition name (in condition-case)" c))
4230 ;; In reality, the `error-conditions' property is only required
4231 ;; for the argument to `signal', not to `condition-case'.
4232 ;;(unless (consp (get c 'error-conditions))
4233 ;; (byte-compile-warn
4234 ;; "‘%s’ is not a known condition name (in condition-case)"
4235 ;; c))
4237 (byte-compile-push-constant condition))
4238 (byte-compile-goto 'byte-pushconditioncase (car clause)))
4240 (byte-compile-form body) ;; byte-compile--for-effect
4241 (dolist (_ clauses) (byte-compile-out 'byte-pophandler))
4242 (byte-compile-goto 'byte-goto endtag)
4244 (while clauses
4245 (let ((clause (pop clauses))
4246 (byte-compile-bound-variables byte-compile-bound-variables)
4247 (byte-compile--lexical-environment
4248 byte-compile--lexical-environment))
4249 (setq byte-compile-depth (1+ depth))
4250 (byte-compile-out-tag (pop clause))
4251 (dolist (_ clauses) (byte-compile-out 'byte-pophandler))
4252 (cond
4253 ((null var) (byte-compile-discard))
4254 (lexical-binding
4255 (push (cons var (1- byte-compile-depth))
4256 byte-compile--lexical-environment))
4257 (t (byte-compile-dynamic-variable-bind var)))
4258 (byte-compile-body (cdr clause)) ;; byte-compile--for-effect
4259 (cond
4260 ((null var) nil)
4261 (lexical-binding (byte-compile-discard 1 'preserve-tos))
4262 (t (byte-compile-out 'byte-unbind 1)))
4263 (byte-compile-goto 'byte-goto endtag)))
4265 (byte-compile-out-tag endtag)))
4267 (defun byte-compile-save-excursion (form)
4268 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
4269 (byte-compile-warning-enabled-p 'suspicious))
4270 (byte-compile-warn
4271 "Use ‘with-current-buffer’ rather than save-excursion+set-buffer"))
4272 (byte-compile-out 'byte-save-excursion 0)
4273 (byte-compile-body-do-effect (cdr form))
4274 (byte-compile-out 'byte-unbind 1))
4276 (defun byte-compile-save-restriction (form)
4277 (byte-compile-out 'byte-save-restriction 0)
4278 (byte-compile-body-do-effect (cdr form))
4279 (byte-compile-out 'byte-unbind 1))
4281 (defun byte-compile-save-current-buffer (form)
4282 (byte-compile-out 'byte-save-current-buffer 0)
4283 (byte-compile-body-do-effect (cdr form))
4284 (byte-compile-out 'byte-unbind 1))
4286 ;;; top-level forms elsewhere
4288 (byte-defop-compiler-1 defvar)
4289 (byte-defop-compiler-1 defconst byte-compile-defvar)
4290 (byte-defop-compiler-1 autoload)
4291 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
4293 ;; If foo.el declares `toto' as obsolete, it is likely that foo.el will
4294 ;; actually use `toto' in order for this obsolete variable to still work
4295 ;; correctly, so paradoxically, while byte-compiling foo.el, the presence
4296 ;; of a make-obsolete-variable call for `toto' is an indication that `toto'
4297 ;; should not trigger obsolete-warnings in foo.el.
4298 (byte-defop-compiler-1 make-obsolete-variable)
4299 (defun byte-compile-make-obsolete-variable (form)
4300 (when (eq 'quote (car-safe (nth 1 form)))
4301 (push (nth 1 (nth 1 form)) byte-compile-global-not-obsolete-vars))
4302 (byte-compile-normal-call form))
4304 (defconst byte-compile-tmp-var (make-symbol "def-tmp-var"))
4306 (defun byte-compile-defvar (form)
4307 ;; This is not used for file-level defvar/consts.
4308 (when (and (symbolp (nth 1 form))
4309 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4310 (byte-compile-warning-enabled-p 'lexical))
4311 (byte-compile-warn "global/dynamic var ‘%s’ lacks a prefix"
4312 (nth 1 form)))
4313 (let ((fun (nth 0 form))
4314 (var (nth 1 form))
4315 (value (nth 2 form))
4316 (string (nth 3 form)))
4317 (byte-compile-set-symbol-position fun)
4318 (when (or (> (length form) 4)
4319 (and (eq fun 'defconst) (null (cddr form))))
4320 (let ((ncall (length (cdr form))))
4321 (byte-compile-warn
4322 "‘%s’ called with %d argument%s, but %s %s"
4323 fun ncall
4324 (if (= 1 ncall) "" "s")
4325 (if (< ncall 2) "requires" "accepts only")
4326 "2-3")))
4327 (push var byte-compile-bound-variables)
4328 (if (eq fun 'defconst)
4329 (push var byte-compile-const-variables))
4330 (when (and string (not (stringp string)))
4331 (byte-compile-warn "third arg to ‘%s %s’ is not a string: %s"
4332 fun var string))
4333 (byte-compile-form-do-effect
4334 (if (cddr form) ; `value' provided
4335 ;; Quote with `quote' to prevent byte-compiling the body,
4336 ;; which would lead to an inf-loop.
4337 `(funcall '(lambda (,byte-compile-tmp-var)
4338 (,fun ,var ,byte-compile-tmp-var ,@(nthcdr 3 form)))
4339 ,value)
4340 (if (eq fun 'defconst)
4341 ;; This will signal an appropriate error at runtime.
4342 `(eval ',form)
4343 ;; A simple (defvar foo) just returns foo.
4344 `',var)))))
4346 (defun byte-compile-autoload (form)
4347 (byte-compile-set-symbol-position 'autoload)
4348 (and (macroexp-const-p (nth 1 form))
4349 (macroexp-const-p (nth 5 form))
4350 (memq (eval (nth 5 form)) '(t macro)) ; macro-p
4351 (not (fboundp (eval (nth 1 form))))
4352 (byte-compile-warn
4353 "The compiler ignores `autoload' except at top level. You should
4354 probably put the autoload of the macro ‘%s’ at top-level."
4355 (eval (nth 1 form))))
4356 (byte-compile-normal-call form))
4358 ;; Lambdas in valid places are handled as special cases by various code.
4359 ;; The ones that remain are errors.
4360 (defun byte-compile-lambda-form (_form)
4361 (byte-compile-set-symbol-position 'lambda)
4362 (error "‘lambda’ used as function name is invalid"))
4364 ;; Compile normally, but deal with warnings for the function being defined.
4365 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
4366 ;; Used for eieio--defalias as well.
4367 (defun byte-compile-file-form-defalias (form)
4368 ;; For the compilation itself, we could largely get rid of this hunk-handler,
4369 ;; if it weren't for the fact that we need to figure out when a defalias
4370 ;; defines a macro, so as to add it to byte-compile-macro-environment.
4372 ;; FIXME: we also use this hunk-handler to implement the function's dynamic
4373 ;; docstring feature. We could actually implement it more elegantly in
4374 ;; byte-compile-lambda so it applies to all lambdas, but the problem is that
4375 ;; the resulting .elc format will not be recognized by make-docfile, so
4376 ;; either we stop using DOC for the docstrings of preloaded elc files (at the
4377 ;; cost of around 24KB on 32bit hosts, double on 64bit hosts) or we need to
4378 ;; build DOC in a more clever way (e.g. handle anonymous elements).
4379 (let ((byte-compile-free-references nil)
4380 (byte-compile-free-assignments nil))
4381 (pcase form
4382 ;; Decompose `form' into:
4383 ;; - `name' is the name of the defined function.
4384 ;; - `arg' is the expression to which it is defined.
4385 ;; - `rest' is the rest of the arguments.
4386 (`(,_ ',name ,arg . ,rest)
4387 (pcase-let*
4388 ;; `macro' is non-nil if it defines a macro.
4389 ;; `fun' is the function part of `arg' (defaults to `arg').
4390 (((or (and (or `(cons 'macro ,fun) `'(macro . ,fun)) (let macro t))
4391 (and (let fun arg) (let macro nil)))
4392 arg)
4393 ;; `lam' is the lambda expression in `fun' (or nil if not
4394 ;; recognized).
4395 ((or `(,(or `quote `function) ,lam) (let lam nil))
4396 fun)
4397 ;; `arglist' is the list of arguments (or t if not recognized).
4398 ;; `body' is the body of `lam' (or t if not recognized).
4399 ((or `(lambda ,arglist . ,body)
4400 ;; `(closure ,_ ,arglist . ,body)
4401 (and `(internal-make-closure ,arglist . ,_) (let body t))
4402 (and (let arglist t) (let body t)))
4403 lam))
4404 (unless (byte-compile-file-form-defmumble
4405 name macro arglist body rest)
4406 (when macro
4407 (if (null fun)
4408 (message "Macro %s unrecognized, won't work in file" name)
4409 (message "Macro %s partly recognized, trying our luck" name)
4410 (push (cons name (eval fun))
4411 byte-compile-macro-environment)))
4412 (byte-compile-keep-pending form))))
4414 ;; We used to just do: (byte-compile-normal-call form)
4415 ;; But it turns out that this fails to optimize the code.
4416 ;; So instead we now do the same as what other byte-hunk-handlers do,
4417 ;; which is to call back byte-compile-file-form and then return nil.
4418 ;; Except that we can't just call byte-compile-file-form since it would
4419 ;; call us right back.
4420 (_ (byte-compile-keep-pending form)))))
4422 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
4423 (defun byte-compile-no-warnings (form)
4424 (let (byte-compile-warnings)
4425 (byte-compile-form (cons 'progn (cdr form)))))
4427 ;; Warn about misuses of make-variable-buffer-local.
4428 (byte-defop-compiler-1 make-variable-buffer-local
4429 byte-compile-make-variable-buffer-local)
4430 (defun byte-compile-make-variable-buffer-local (form)
4431 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
4432 (byte-compile-warning-enabled-p 'make-local))
4433 (byte-compile-warn
4434 "‘make-variable-buffer-local’ not called at toplevel"))
4435 (byte-compile-normal-call form))
4436 (put 'make-variable-buffer-local
4437 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4438 (defun byte-compile-form-make-variable-buffer-local (form)
4439 (byte-compile-keep-pending form 'byte-compile-normal-call))
4441 ;;; tags
4443 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4444 ;; optimization to have the 'TAG as a part of the tag.
4445 ;; Tags will be (TAG . (tag-number . stack-depth)).
4446 (defun byte-compile-make-tag ()
4447 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4450 (defun byte-compile-out-tag (tag)
4451 (setq byte-compile-output (cons tag byte-compile-output))
4452 (if (cdr (cdr tag))
4453 (progn
4454 ;; ## remove this someday
4455 (and byte-compile-depth
4456 (not (= (cdr (cdr tag)) byte-compile-depth))
4457 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
4458 (setq byte-compile-depth (cdr (cdr tag))))
4459 (setcdr (cdr tag) byte-compile-depth)))
4461 (defun byte-compile-goto (opcode tag)
4462 (push (cons opcode tag) byte-compile-output)
4463 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4464 (1- byte-compile-depth)
4465 byte-compile-depth))
4466 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4467 (1- byte-compile-depth))))
4469 (defun byte-compile-stack-adjustment (op operand)
4470 "Return the amount by which an operation adjusts the stack.
4471 OP and OPERAND are as passed to `byte-compile-out'."
4472 (if (memq op '(byte-call byte-discardN byte-discardN-preserve-tos))
4473 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4474 ;; elements, and the push the result, for a total of -OPERAND.
4475 ;; For discardN*, of course, we just pop OPERAND elements.
4476 (- operand)
4477 (or (aref byte-stack+-info (symbol-value op))
4478 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4479 ;; that take OPERAND values off the stack and push a result, for
4480 ;; a total of 1 - OPERAND
4481 (- 1 operand))))
4483 (defun byte-compile-out (op &optional operand)
4484 (push (cons op operand) byte-compile-output)
4485 (if (eq op 'byte-return)
4486 ;; This is actually an unnecessary case, because there should be no
4487 ;; more ops behind byte-return.
4488 (setq byte-compile-depth nil)
4489 (setq byte-compile-depth
4490 (+ byte-compile-depth (byte-compile-stack-adjustment op operand)))
4491 (setq byte-compile-maxdepth (max byte-compile-depth byte-compile-maxdepth))
4492 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4495 ;;; call tree stuff
4497 (defun byte-compile-annotate-call-tree (form)
4498 (let (entry)
4499 ;; annotate the current call
4500 (if (setq entry (assq (car form) byte-compile-call-tree))
4501 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4502 (setcar (cdr entry)
4503 (cons byte-compile-current-form (nth 1 entry))))
4504 (setq byte-compile-call-tree
4505 (cons (list (car form) (list byte-compile-current-form) nil)
4506 byte-compile-call-tree)))
4507 ;; annotate the current function
4508 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4509 (or (memq (car form) (nth 2 entry)) ;called
4510 (setcar (cdr (cdr entry))
4511 (cons (car form) (nth 2 entry))))
4512 (setq byte-compile-call-tree
4513 (cons (list byte-compile-current-form nil (list (car form)))
4514 byte-compile-call-tree)))
4517 ;; Renamed from byte-compile-report-call-tree
4518 ;; to avoid interfering with completion of byte-compile-file.
4519 ;;;###autoload
4520 (defun display-call-tree (&optional filename)
4521 "Display a call graph of a specified file.
4522 This lists which functions have been called, what functions called
4523 them, and what functions they call. The list includes all functions
4524 whose definitions have been compiled in this Emacs session, as well as
4525 all functions called by those functions.
4527 The call graph does not include macros, inline functions, or
4528 primitives that the byte-code interpreter knows about directly \(eq,
4529 cons, etc.\).
4531 The call tree also lists those functions which are not known to be called
4532 \(that is, to which no calls have been compiled\), and which cannot be
4533 invoked interactively."
4534 (interactive)
4535 (message "Generating call tree...")
4536 (with-output-to-temp-buffer "*Call-Tree*"
4537 (set-buffer "*Call-Tree*")
4538 (erase-buffer)
4539 (message "Generating call tree... (sorting on %s)"
4540 byte-compile-call-tree-sort)
4541 (insert "Call tree for "
4542 (cond ((null byte-compile-current-file) (or filename "???"))
4543 ((stringp byte-compile-current-file)
4544 byte-compile-current-file)
4545 (t (buffer-name byte-compile-current-file)))
4546 " sorted on "
4547 (prin1-to-string byte-compile-call-tree-sort)
4548 ":\n\n")
4549 (if byte-compile-call-tree-sort
4550 (setq byte-compile-call-tree
4551 (sort byte-compile-call-tree
4552 (pcase byte-compile-call-tree-sort
4553 (`callers
4554 (lambda (x y) (< (length (nth 1 x))
4555 (length (nth 1 y)))))
4556 (`calls
4557 (lambda (x y) (< (length (nth 2 x))
4558 (length (nth 2 y)))))
4559 (`calls+callers
4560 (lambda (x y) (< (+ (length (nth 1 x))
4561 (length (nth 2 x)))
4562 (+ (length (nth 1 y))
4563 (length (nth 2 y))))))
4564 (`name
4565 (lambda (x y) (string< (car x) (car y))))
4566 (_ (error "‘byte-compile-call-tree-sort’: ‘%s’ - unknown sort mode"
4567 byte-compile-call-tree-sort))))))
4568 (message "Generating call tree...")
4569 (let ((rest byte-compile-call-tree)
4570 (b (current-buffer))
4572 callers calls)
4573 (while rest
4574 (prin1 (car (car rest)) b)
4575 (setq callers (nth 1 (car rest))
4576 calls (nth 2 (car rest)))
4577 (insert "\t"
4578 (cond ((not (fboundp (setq f (car (car rest)))))
4579 (if (null f)
4580 " <top level>";; shouldn't insert nil then, actually -sk
4581 " <not defined>"))
4582 ((subrp (setq f (symbol-function f)))
4583 " <subr>")
4584 ((symbolp f)
4585 (format " ==> %s" f))
4586 ((byte-code-function-p f)
4587 "<compiled function>")
4588 ((not (consp f))
4589 "<malformed function>")
4590 ((eq 'macro (car f))
4591 (if (or (byte-code-function-p (cdr f))
4592 (assq 'byte-code (cdr (cdr (cdr f)))))
4593 " <compiled macro>"
4594 " <macro>"))
4595 ((assq 'byte-code (cdr (cdr f)))
4596 "<compiled lambda>")
4597 ((eq 'lambda (car f))
4598 "<function>")
4599 (t "???"))
4600 (format " (%d callers + %d calls = %d)"
4601 ;; Does the optimizer eliminate common subexpressions?-sk
4602 (length callers)
4603 (length calls)
4604 (+ (length callers) (length calls)))
4605 "\n")
4606 (if callers
4607 (progn
4608 (insert " called by:\n")
4609 (setq p (point))
4610 (insert " " (if (car callers)
4611 (mapconcat 'symbol-name callers ", ")
4612 "<top level>"))
4613 (let ((fill-prefix " "))
4614 (fill-region-as-paragraph p (point)))
4615 (unless (= 0 (current-column))
4616 (insert "\n"))))
4617 (if calls
4618 (progn
4619 (insert " calls:\n")
4620 (setq p (point))
4621 (insert " " (mapconcat 'symbol-name calls ", "))
4622 (let ((fill-prefix " "))
4623 (fill-region-as-paragraph p (point)))
4624 (unless (= 0 (current-column))
4625 (insert "\n"))))
4626 (setq rest (cdr rest)))
4628 (message "Generating call tree...(finding uncalled functions...)")
4629 (setq rest byte-compile-call-tree)
4630 (let (uncalled def)
4631 (while rest
4632 (or (nth 1 (car rest))
4633 (null (setq f (caar rest)))
4634 (progn
4635 (setq def (byte-compile-fdefinition f t))
4636 (and (eq (car-safe def) 'macro)
4637 (eq (car-safe (cdr-safe def)) 'lambda)
4638 (setq def (cdr def)))
4639 (functionp def))
4640 (progn
4641 (setq def (byte-compile-fdefinition f nil))
4642 (and (eq (car-safe def) 'macro)
4643 (eq (car-safe (cdr-safe def)) 'lambda)
4644 (setq def (cdr def)))
4645 (commandp def))
4646 (setq uncalled (cons f uncalled)))
4647 (setq rest (cdr rest)))
4648 (if uncalled
4649 (let ((fill-prefix " "))
4650 (insert "Noninteractive functions not known to be called:\n ")
4651 (setq p (point))
4652 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4653 (fill-region-as-paragraph p (point))))))
4654 (message "Generating call tree...done.")))
4657 ;;;###autoload
4658 (defun batch-byte-compile-if-not-done ()
4659 "Like `byte-compile-file' but doesn't recompile if already up to date.
4660 Use this from the command line, with `-batch';
4661 it won't work in an interactive Emacs."
4662 (batch-byte-compile t))
4664 ;;; by crl@newton.purdue.edu
4665 ;;; Only works noninteractively.
4666 ;;;###autoload
4667 (defun batch-byte-compile (&optional noforce)
4668 "Run `byte-compile-file' on the files remaining on the command line.
4669 Use this from the command line, with `-batch';
4670 it won't work in an interactive Emacs.
4671 Each file is processed even if an error occurred previously.
4672 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4673 If NOFORCE is non-nil, don't recompile a file that seems to be
4674 already up-to-date."
4675 ;; command-line-args-left is what is left of the command line, from
4676 ;; startup.el.
4677 (defvar command-line-args-left) ;Avoid 'free variable' warning
4678 (if (not noninteractive)
4679 (error "‘batch-byte-compile’ is to be used only with -batch"))
4680 (let ((error nil))
4681 (while command-line-args-left
4682 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4683 ;; Directory as argument.
4684 (let (source dest)
4685 (dolist (file (directory-files (car command-line-args-left)))
4686 (if (and (string-match emacs-lisp-file-regexp file)
4687 (not (auto-save-file-name-p file))
4688 (setq source
4689 (expand-file-name file
4690 (car command-line-args-left)))
4691 (setq dest (byte-compile-dest-file source))
4692 (file-exists-p dest)
4693 (file-newer-than-file-p source dest))
4694 (if (null (batch-byte-compile-file source))
4695 (setq error t)))))
4696 ;; Specific file argument
4697 (if (or (not noforce)
4698 (let* ((source (car command-line-args-left))
4699 (dest (byte-compile-dest-file source)))
4700 (or (not (file-exists-p dest))
4701 (file-newer-than-file-p source dest))))
4702 (if (null (batch-byte-compile-file (car command-line-args-left)))
4703 (setq error t))))
4704 (setq command-line-args-left (cdr command-line-args-left)))
4705 (kill-emacs (if error 1 0))))
4707 (defun batch-byte-compile-file (file)
4708 (let ((byte-compile-root-dir (or byte-compile-root-dir default-directory)))
4709 (if debug-on-error
4710 (byte-compile-file file)
4711 (condition-case err
4712 (byte-compile-file file)
4713 (file-error
4714 (message (if (cdr err)
4715 ">>Error occurred processing %s: %s (%s)"
4716 ">>Error occurred processing %s: %s")
4717 file
4718 (get (car err) 'error-message)
4719 (prin1-to-string (cdr err)))
4720 (let ((destfile (byte-compile-dest-file file)))
4721 (if (file-exists-p destfile)
4722 (delete-file destfile)))
4723 nil)
4724 (error
4725 (message (if (cdr err)
4726 ">>Error occurred processing %s: %s (%s)"
4727 ">>Error occurred processing %s: %s")
4728 file
4729 (get (car err) 'error-message)
4730 (prin1-to-string (cdr err)))
4731 nil)))))
4733 (defun byte-compile-refresh-preloaded ()
4734 "Reload any Lisp file that was changed since Emacs was dumped.
4735 Use with caution."
4736 (let* ((argv0 (car command-line-args))
4737 (emacs-file (executable-find argv0)))
4738 (if (not (and emacs-file (file-executable-p emacs-file)))
4739 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4740 (dolist (f (reverse load-history))
4741 (setq f (car f))
4742 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4743 (when (and (file-readable-p f)
4744 (file-newer-than-file-p f emacs-file)
4745 ;; Don't reload the source version of the files below
4746 ;; because that causes subsequent byte-compilation to
4747 ;; be a lot slower and need a higher max-lisp-eval-depth,
4748 ;; so it can cause recompilation to fail.
4749 (not (member (file-name-nondirectory f)
4750 '("pcase.el" "bytecomp.el" "macroexp.el"
4751 "cconv.el" "byte-opt.el"))))
4752 (message "Reloading stale %s" (file-name-nondirectory f))
4753 (condition-case nil
4754 (load f 'noerror nil 'nosuffix)
4755 ;; Probably shouldn't happen, but in case of an error, it seems
4756 ;; at least as useful to ignore it as it is to stop compilation.
4757 (error nil)))))))
4759 ;;;###autoload
4760 (defun batch-byte-recompile-directory (&optional arg)
4761 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4762 Must be used only with `-batch', and kills Emacs on completion.
4763 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4765 Optional argument ARG is passed as second argument ARG to
4766 `byte-recompile-directory'; see there for its possible values
4767 and corresponding effects."
4768 ;; command-line-args-left is what is left of the command line (startup.el)
4769 (defvar command-line-args-left) ;Avoid 'free variable' warning
4770 (if (not noninteractive)
4771 (error "batch-byte-recompile-directory is to be used only with -batch"))
4772 (or command-line-args-left
4773 (setq command-line-args-left '(".")))
4774 (while command-line-args-left
4775 (byte-recompile-directory (car command-line-args-left) arg)
4776 (setq command-line-args-left (cdr command-line-args-left)))
4777 (kill-emacs 0))
4779 ;;; Core compiler macros.
4781 (put 'featurep 'compiler-macro
4782 (lambda (form feature &rest _ignore)
4783 ;; Emacs-21's byte-code doesn't run under XEmacs or SXEmacs anyway, so
4784 ;; we can safely optimize away this test.
4785 (if (member feature '('xemacs 'sxemacs 'emacs))
4786 (eval form)
4787 form)))
4789 (provide 'byte-compile)
4790 (provide 'bytecomp)
4793 ;;; report metering (see the hacks in bytecode.c)
4795 (defvar byte-code-meter)
4796 (defun byte-compile-report-ops ()
4797 (or (boundp 'byte-metering-on)
4798 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4799 (with-output-to-temp-buffer "*Meter*"
4800 (set-buffer "*Meter*")
4801 (let ((i 0) n op off)
4802 (while (< i 256)
4803 (setq n (aref (aref byte-code-meter 0) i)
4804 off nil)
4805 (if t ;(not (zerop n))
4806 (progn
4807 (setq op i)
4808 (setq off nil)
4809 (cond ((< op byte-nth)
4810 (setq off (logand op 7))
4811 (setq op (logand op 248)))
4812 ((>= op byte-constant)
4813 (setq off (- op byte-constant)
4814 op byte-constant)))
4815 (setq op (aref byte-code-vector op))
4816 (insert (format "%-4d" i))
4817 (insert (symbol-name op))
4818 (if off (insert " [" (int-to-string off) "]"))
4819 (indent-to 40)
4820 (insert (int-to-string n) "\n")))
4821 (setq i (1+ i))))))
4823 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4824 ;; itself, compile some of its most used recursive functions (at load time).
4826 (eval-when-compile
4827 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4828 (assq 'byte-code (symbol-function 'byte-compile-form))
4829 (let ((byte-optimize nil) ; do it fast
4830 (byte-compile-warnings nil))
4831 (mapc (lambda (x)
4832 (or noninteractive (message "compiling %s..." x))
4833 (byte-compile x)
4834 (or noninteractive (message "compiling %s...done" x)))
4835 '(byte-compile-normal-call
4836 byte-compile-form
4837 byte-compile-body
4838 ;; Inserted some more than necessary, to speed it up.
4839 byte-compile-top-level
4840 byte-compile-out-toplevel
4841 byte-compile-constant
4842 byte-compile-variable-ref))))
4843 nil)
4845 (run-hooks 'bytecomp-load-hook)
4847 ;;; bytecomp.el ends here