1 ;;; bytecomp.el --- compilation of Lisp code into byte code -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2012
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
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/>.
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.
36 ;; ========================================================================
38 ;; byte-recompile-directory, byte-compile-file,
39 ;; byte-recompile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables: M-x customize-group bytecomp
75 ;; o The form `defsubst' is just like `defun', except that the function
76 ;; generated will be open-coded in compiled code which uses it. This
77 ;; means that no function call will be generated, it will simply be
78 ;; spliced in. Lisp functions calls are very slow, so this can be a
81 ;; You can generally accomplish the same thing with `defmacro', but in
82 ;; that case, the defined procedure can't be used as an argument to
85 ;; o You can also open-code one particular call to a function without
86 ;; open-coding all calls. Use the 'inline' form to do this, like so:
88 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
90 ;; (inline ;; `foo' and `baz' will be
91 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
94 ;; o It is possible to open-code a function in the same file it is defined
95 ;; in without having to load that file before compiling it. The
96 ;; byte-compiler has been modified to remember function definitions in
97 ;; the compilation environment in the same way that it remembers macro
100 ;; o Forms like ((lambda ...) ...) are open-coded.
102 ;; o The form `eval-when-compile' is like progn, except that the body
103 ;; is evaluated at compile-time. When it appears at top-level, this
104 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
105 ;; When it does not appear at top-level, it is similar to the
106 ;; Common Lisp #. reader macro (but not in interpreted code).
108 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
109 ;; the whole form is evalled both at compile-time and at run-time.
111 ;; o The command compile-defun is analogous to eval-defun.
113 ;; o If you run byte-compile-file on a filename which is visited in a
114 ;; buffer, and that buffer is modified, you are asked whether you want
115 ;; to save the buffer before compiling.
117 ;; o byte-compiled files now start with the string `;ELC'.
118 ;; Some versions of `file' can be customized to recognize that.
123 (eval-when-compile (require 'cl-lib))
125 (or (fboundp 'defsubst)
126 ;; This really ought to be loaded already!
129 ;; The feature of compiling in a specific target Emacs version
130 ;; has been turned off because compile time options are a bad idea.
131 (defgroup bytecomp nil
132 "Emacs Lisp byte-compiler."
135 (defcustom emacs-lisp-file-regexp "\\.el\\'"
136 "Regexp which matches Emacs Lisp source files.
137 If you change this, you might want to set `byte-compile-dest-file-function'."
141 (defcustom byte-compile-dest-file-function nil
142 "Function for the function `byte-compile-dest-file' to call.
143 It should take one argument, the name of an Emacs Lisp source
144 file name, and return the name of the compiled file."
146 :type '(choice (const nil) function)
149 ;; This enables file name handlers such as jka-compr
150 ;; to remove parts of the file name that should not be copied
151 ;; through to the output file name.
152 (defun byte-compiler-base-file-name (filename)
153 (let ((handler (find-file-name-handler filename
154 'byte-compiler-base-file-name)))
156 (funcall handler 'byte-compiler-base-file-name filename)
159 (or (fboundp 'byte-compile-dest-file)
160 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
161 ;; so only define it if it is undefined.
162 ;; Note - redefining this function is obsolete as of 23.2.
163 ;; Customize byte-compile-dest-file-function instead.
164 (defun byte-compile-dest-file (filename)
165 "Convert an Emacs Lisp source file name to a compiled file name.
166 If `byte-compile-dest-file-function' is non-nil, uses that
167 function to do the work. Otherwise, if FILENAME matches
168 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
169 adds `c' to it; otherwise adds `.elc'."
170 (if byte-compile-dest-file-function
171 (funcall byte-compile-dest-file-function filename)
172 (setq filename (file-name-sans-versions
173 (byte-compiler-base-file-name filename)))
174 (cond ((string-match emacs-lisp-file-regexp filename)
175 (concat (substring filename 0 (match-beginning 0)) ".elc"))
176 (t (concat filename ".elc"))))))
178 ;; This can be the 'byte-compile property of any symbol.
179 (autoload 'byte-compile-inline-expand "byte-opt")
181 ;; This is the entry point to the lapcode optimizer pass1.
182 (autoload 'byte-optimize-form "byte-opt")
183 ;; This is the entry point to the lapcode optimizer pass2.
184 (autoload 'byte-optimize-lapcode "byte-opt")
185 (autoload 'byte-compile-unfold-lambda "byte-opt")
187 ;; This is the entry point to the decompiler, which is used by the
188 ;; disassembler. The disassembler just requires 'byte-compile, but
189 ;; that doesn't define this function, so this seems to be a reasonable
191 (autoload 'byte-decompile-bytecode "byte-opt")
193 (defcustom byte-compile-verbose
194 (and (not noninteractive) (> baud-rate search-slow-speed))
195 "Non-nil means print messages describing progress of byte-compiler."
199 (defcustom byte-optimize t
200 "Enable optimization in the byte compiler.
202 nil - no optimization
203 t - all optimizations
204 `source' - source-level optimizations only
205 `byte' - code-level optimizations only"
207 :type '(choice (const :tag "none" nil)
209 (const :tag "source-level" source)
210 (const :tag "byte-level" byte)))
212 (defcustom byte-compile-delete-errors nil
213 "If non-nil, the optimizer may delete forms that may signal an error.
214 This includes variable references and calls to functions such as `car'."
218 (defvar byte-compile-dynamic nil
219 "If non-nil, compile function bodies so they load lazily.
220 They are hidden in comments in the compiled file,
221 and each one is brought into core when the
224 To enable this option, make it a file-local variable
225 in the source file you want it to apply to.
226 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
228 When this option is true, if you load the compiled file and then move it,
229 the functions you loaded will not be able to run.")
230 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
232 (defvar byte-compile-disable-print-circle nil
233 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
234 (make-obsolete-variable 'byte-compile-disable-print-circle nil "24.1")
235 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
237 (defcustom byte-compile-dynamic-docstrings t
238 "If non-nil, compile doc strings for lazy access.
239 We bury the doc strings of functions and variables inside comments in
240 the file, and bring them into core only when they are actually needed.
242 When this option is true, if you load the compiled file and then move it,
243 you won't be able to find the documentation of anything in that file.
245 To disable this option for a certain file, make it a file-local variable
246 in the source file. For example, add this to the first line:
247 -*-byte-compile-dynamic-docstrings:nil;-*-
248 You can also set the variable globally.
250 This option is enabled by default because it reduces Emacs memory usage."
253 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
255 (defconst byte-compile-log-buffer "*Compile-Log*"
256 "Name of the byte-compiler's log buffer.")
258 (defcustom byte-optimize-log nil
259 "If non-nil, the byte-compiler will log its optimizations.
260 If this is 'source, then only source-level optimizations will be logged.
261 If it is 'byte, then only byte-level optimizations will be logged.
262 The information is logged to `byte-compile-log-buffer'."
264 :type '(choice (const :tag "none" nil)
266 (const :tag "source-level" source)
267 (const :tag "byte-level" byte)))
269 (defcustom byte-compile-error-on-warn nil
270 "If true, the byte-compiler reports warnings with `error'."
274 (defconst byte-compile-warning-types
275 '(redefine callargs free-vars unresolved
276 obsolete noruntime cl-functions interactive-only
277 make-local mapcar constants suspicious lexical)
278 "The list of warning types used when `byte-compile-warnings' is t.")
279 (defcustom byte-compile-warnings t
280 "List of warnings that the byte-compiler should issue (t for all).
282 Elements of the list may be:
284 free-vars references to variables not in the current lexical scope.
285 unresolved calls to unknown functions.
286 callargs function calls with args that don't match the definition.
287 redefine function name redefined from a macro to ordinary function or vice
288 versa, or redefined to take a different number of arguments.
289 obsolete obsolete variables and functions.
290 noruntime functions that may not be defined at runtime (typically
291 defined only under `eval-when-compile').
292 cl-functions calls to runtime functions from the CL package (as
293 distinguished from macros and aliases).
295 commands that normally shouldn't be called from Lisp code.
296 make-local calls to make-variable-buffer-local that may be incorrect.
297 mapcar mapcar called for effect.
298 constants let-binding of, or assignment to, constants/nonvariables.
299 suspicious constructs that usually don't do what the coder wanted.
301 If the list begins with `not', then the remaining elements specify warnings to
302 suppress. For example, (not mapcar) will suppress warnings about mapcar."
304 :type `(choice (const :tag "All" t)
305 (set :menu-tag "Some"
306 ,@(mapcar (lambda (x) `(const ,x))
307 byte-compile-warning-types))))
310 (put 'byte-compile-warnings 'safe-local-variable
313 (null (delq nil (mapcar (lambda (x) (not (symbolp x))) v))))))
315 (defun byte-compile-warning-enabled-p (warning)
316 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
317 (or (eq byte-compile-warnings t)
318 (if (eq (car byte-compile-warnings) 'not)
319 (not (memq warning byte-compile-warnings))
320 (memq warning byte-compile-warnings))))
323 (defun byte-compile-disable-warning (warning)
324 "Change `byte-compile-warnings' to disable WARNING.
325 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
326 Otherwise, if the first element is `not', add WARNING, else remove it.
327 Normally you should let-bind `byte-compile-warnings' before calling this,
328 else the global value will be modified."
329 (setq byte-compile-warnings
330 (cond ((eq byte-compile-warnings t)
332 ((eq (car byte-compile-warnings) 'not)
333 (if (memq warning byte-compile-warnings)
334 byte-compile-warnings
335 (append byte-compile-warnings (list warning))))
337 (delq warning byte-compile-warnings)))))
340 (defun byte-compile-enable-warning (warning)
341 "Change `byte-compile-warnings' to enable WARNING.
342 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
343 first element is `not', remove WARNING, else add it.
344 Normally you should let-bind `byte-compile-warnings' before calling this,
345 else the global value will be modified."
346 (or (eq byte-compile-warnings t)
347 (setq byte-compile-warnings
348 (cond ((eq (car byte-compile-warnings) 'not)
349 (delq warning byte-compile-warnings))
350 ((memq warning byte-compile-warnings)
351 byte-compile-warnings)
353 (append byte-compile-warnings (list warning)))))))
355 (defvar byte-compile-interactive-only-functions
356 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
357 insert-file insert-buffer insert-file-literally previous-line next-line
358 goto-line comint-run delete-backward-char)
359 "List of commands that are not meant to be called from Lisp.")
361 (defvar byte-compile-not-obsolete-vars nil
362 "List of variables that shouldn't be reported as obsolete.")
363 (defvar byte-compile-global-not-obsolete-vars nil
364 "Global list of variables that shouldn't be reported as obsolete.")
366 (defvar byte-compile-not-obsolete-funcs nil
367 "List of functions that shouldn't be reported as obsolete.")
369 (defcustom byte-compile-generate-call-tree nil
370 "Non-nil means collect call-graph information when compiling.
371 This records which functions were called and from where.
372 If the value is t, compilation displays the call graph when it finishes.
373 If the value is neither t nor nil, compilation asks you whether to display
376 The call tree only lists functions called, not macros used. Those functions
377 which the byte-code interpreter knows about directly (eq, cons, etc.) are
380 The call tree also lists those functions which are not known to be called
381 \(that is, to which no calls have been compiled). Functions which can be
382 invoked interactively are excluded from this list."
384 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
385 (other :tag "Ask" lambda)))
387 (defvar byte-compile-call-tree nil
388 "Alist of functions and their call tree.
389 Each element looks like
391 \(FUNCTION CALLERS CALLS\)
393 where CALLERS is a list of functions that call FUNCTION, and CALLS
394 is a list of functions for which calls were generated while compiling
397 (defcustom byte-compile-call-tree-sort 'name
398 "If non-nil, sort the call tree.
399 The values `name', `callers', `calls', `calls+callers'
400 specify different fields to sort on."
402 :type '(choice (const name) (const callers) (const calls)
403 (const calls+callers) (const nil)))
405 (defvar byte-compile-debug nil)
406 (defvar byte-compile-constants nil
407 "List of all constants encountered during compilation of this form.")
408 (defvar byte-compile-variables nil
409 "List of all variables encountered during compilation of this form.")
410 (defvar byte-compile-bound-variables nil
411 "List of dynamic variables bound in the context of the current form.
412 This list lives partly on the stack.")
413 (defvar byte-compile-const-variables nil
414 "List of variables declared as constants during compilation of this file.")
415 (defvar byte-compile-free-references)
416 (defvar byte-compile-free-assignments)
418 (defvar byte-compiler-error-flag)
420 (defconst byte-compile-initial-macro-environment
422 ;; (byte-compiler-options . (lambda (&rest forms)
423 ;; (apply 'byte-compiler-options-handler forms)))
424 (declare-function . byte-compile-macroexpand-declare-function)
425 (eval-when-compile . (lambda (&rest body)
429 (byte-compile-top-level
430 (byte-compile-preprocess (cons 'progn body)))))))
431 (eval-and-compile . (lambda (&rest body)
432 (byte-compile-eval-before-compile (cons 'progn body))
433 (cons 'progn body))))
434 "The default macro-environment passed to macroexpand by the compiler.
435 Placing a macro here will cause a macro to have different semantics when
436 expanded by the compiler as when expanded by the interpreter.")
438 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
439 "Alist of macros defined in the file being compiled.
440 Each element looks like (MACRONAME . DEFINITION). It is
441 \(MACRONAME . nil) when a macro is redefined as a function.")
443 (defvar byte-compile-function-environment nil
444 "Alist of functions defined in the file being compiled.
445 This is so we can inline them when necessary.
446 Each element looks like (FUNCTIONNAME . DEFINITION). It is
447 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
448 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
449 and we don't know the definition. For an autoloaded function, DEFINITION
450 has the form (autoload . FILENAME).")
452 (defvar byte-compile-unresolved-functions nil
453 "Alist of undefined functions to which calls have been compiled.
454 This variable is only significant whilst compiling an entire buffer.
455 Used for warnings when a function is not known to be defined or is later
456 defined with incorrect args.")
458 (defvar byte-compile-noruntime-functions nil
459 "Alist of functions called that may not be defined when the compiled code is run.
460 Used for warnings about calling a function that is defined during compilation
461 but won't necessarily be defined when the compiled file is loaded.")
463 ;; Variables for lexical binding
464 (defvar byte-compile--lexical-environment nil
465 "The current lexical environment.")
467 (defvar byte-compile-tag-number 0)
468 (defvar byte-compile-output nil
469 "Alist describing contents to put in byte code string.
470 Each element is (INDEX . VALUE)")
471 (defvar byte-compile-depth 0 "Current depth of execution stack.")
472 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
475 ;;; The byte codes; this information is duplicated in bytecomp.c
477 (defvar byte-code-vector nil
478 "An array containing byte-code names indexed by byte-code values.")
480 (defvar byte-stack+-info nil
481 "An array with the stack adjustment for each byte-code.")
483 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
484 ;; This is a speed-hack for building the byte-code-vector at compile-time.
485 ;; We fill in the vector at macroexpand-time, and then after the last call
486 ;; to byte-defop, we write the vector out as a constant instead of writing
487 ;; out a bunch of calls to aset.
488 ;; Actually, we don't fill in the vector itself, because that could make
489 ;; it problematic to compile big changes to this compiler; we store the
490 ;; values on its plist, and remove them later in -extrude.
491 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
492 (put 'byte-code-vector 'tmp-compile-time-value
493 (make-vector 256 nil))))
494 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
495 (put 'byte-stack+-info 'tmp-compile-time-value
496 (make-vector 256 nil)))))
497 (aset v1 opcode opname)
498 (aset v2 opcode stack-adjust))
500 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
501 (list 'defconst opname opcode)))
503 (defmacro byte-extrude-byte-code-vectors ()
504 (prog1 (list 'setq 'byte-code-vector
505 (get 'byte-code-vector 'tmp-compile-time-value)
507 (get 'byte-stack+-info 'tmp-compile-time-value))
508 (put 'byte-code-vector 'tmp-compile-time-value nil)
509 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
512 ;; These opcodes are special in that they pack their argument into the
515 (byte-defop 0 1 byte-stack-ref "for stack reference")
516 (byte-defop 8 1 byte-varref "for variable reference")
517 (byte-defop 16 -1 byte-varset "for setting a variable")
518 (byte-defop 24 -1 byte-varbind "for binding a variable")
519 (byte-defop 32 0 byte-call "for calling a function")
520 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
521 ;; codes 8-47 are consumed by the preceding opcodes
525 (byte-defop 56 -1 byte-nth)
526 (byte-defop 57 0 byte-symbolp)
527 (byte-defop 58 0 byte-consp)
528 (byte-defop 59 0 byte-stringp)
529 (byte-defop 60 0 byte-listp)
530 (byte-defop 61 -1 byte-eq)
531 (byte-defop 62 -1 byte-memq)
532 (byte-defop 63 0 byte-not)
533 (byte-defop 64 0 byte-car)
534 (byte-defop 65 0 byte-cdr)
535 (byte-defop 66 -1 byte-cons)
536 (byte-defop 67 0 byte-list1)
537 (byte-defop 68 -1 byte-list2)
538 (byte-defop 69 -2 byte-list3)
539 (byte-defop 70 -3 byte-list4)
540 (byte-defop 71 0 byte-length)
541 (byte-defop 72 -1 byte-aref)
542 (byte-defop 73 -2 byte-aset)
543 (byte-defop 74 0 byte-symbol-value)
544 (byte-defop 75 0 byte-symbol-function) ; this was commented out
545 (byte-defop 76 -1 byte-set)
546 (byte-defop 77 -1 byte-fset) ; this was commented out
547 (byte-defop 78 -1 byte-get)
548 (byte-defop 79 -2 byte-substring)
549 (byte-defop 80 -1 byte-concat2)
550 (byte-defop 81 -2 byte-concat3)
551 (byte-defop 82 -3 byte-concat4)
552 (byte-defop 83 0 byte-sub1)
553 (byte-defop 84 0 byte-add1)
554 (byte-defop 85 -1 byte-eqlsign)
555 (byte-defop 86 -1 byte-gtr)
556 (byte-defop 87 -1 byte-lss)
557 (byte-defop 88 -1 byte-leq)
558 (byte-defop 89 -1 byte-geq)
559 (byte-defop 90 -1 byte-diff)
560 (byte-defop 91 0 byte-negate)
561 (byte-defop 92 -1 byte-plus)
562 (byte-defop 93 -1 byte-max)
563 (byte-defop 94 -1 byte-min)
564 (byte-defop 95 -1 byte-mult) ; v19 only
565 (byte-defop 96 1 byte-point)
566 (byte-defop 98 0 byte-goto-char)
567 (byte-defop 99 0 byte-insert)
568 (byte-defop 100 1 byte-point-max)
569 (byte-defop 101 1 byte-point-min)
570 (byte-defop 102 0 byte-char-after)
571 (byte-defop 103 1 byte-following-char)
572 (byte-defop 104 1 byte-preceding-char)
573 (byte-defop 105 1 byte-current-column)
574 (byte-defop 106 0 byte-indent-to)
575 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
576 (byte-defop 108 1 byte-eolp)
577 (byte-defop 109 1 byte-eobp)
578 (byte-defop 110 1 byte-bolp)
579 (byte-defop 111 1 byte-bobp)
580 (byte-defop 112 1 byte-current-buffer)
581 (byte-defop 113 0 byte-set-buffer)
582 (byte-defop 114 0 byte-save-current-buffer
583 "To make a binding to record the current buffer")
584 (byte-defop 115 0 byte-set-mark-OBSOLETE)
585 (byte-defop 116 1 byte-interactive-p-OBSOLETE)
587 ;; These ops are new to v19
588 (byte-defop 117 0 byte-forward-char)
589 (byte-defop 118 0 byte-forward-word)
590 (byte-defop 119 -1 byte-skip-chars-forward)
591 (byte-defop 120 -1 byte-skip-chars-backward)
592 (byte-defop 121 0 byte-forward-line)
593 (byte-defop 122 0 byte-char-syntax)
594 (byte-defop 123 -1 byte-buffer-substring)
595 (byte-defop 124 -1 byte-delete-region)
596 (byte-defop 125 -1 byte-narrow-to-region)
597 (byte-defop 126 1 byte-widen)
598 (byte-defop 127 0 byte-end-of-line)
602 ;; These store their argument in the next two bytes
603 (byte-defop 129 1 byte-constant2
604 "for reference to a constant with vector index >= byte-constant-limit")
605 (byte-defop 130 0 byte-goto "for unconditional jump")
606 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
607 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
608 (byte-defop 133 -1 byte-goto-if-nil-else-pop
609 "to examine top-of-stack, jump and don't pop it if it's nil,
611 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
612 "to examine top-of-stack, jump and don't pop it if it's non nil,
615 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
616 (byte-defop 136 -1 byte-discard "to discard one value from stack")
617 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
619 (byte-defop 138 0 byte-save-excursion
620 "to make a binding to record the buffer, point and mark")
621 (byte-defop 139 0 byte-save-window-excursion-OBSOLETE
622 "to make a binding to record entire window configuration")
623 (byte-defop 140 0 byte-save-restriction
624 "to make a binding to record the current buffer clipping restrictions")
625 (byte-defop 141 -1 byte-catch
626 "for catch. Takes, on stack, the tag and an expression for the body")
627 (byte-defop 142 -1 byte-unwind-protect
628 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
630 ;; For condition-case. Takes, on stack, the variable to bind,
631 ;; an expression for the body, and a list of clauses.
632 (byte-defop 143 -2 byte-condition-case)
634 (byte-defop 144 0 byte-temp-output-buffer-setup-OBSOLETE)
635 (byte-defop 145 -1 byte-temp-output-buffer-show-OBSOLETE)
637 ;; these ops are new to v19
639 ;; To unbind back to the beginning of this frame.
640 ;; Not used yet, but will be needed for tail-recursion elimination.
641 (byte-defop 146 0 byte-unbind-all)
643 ;; these ops are new to v19
644 (byte-defop 147 -2 byte-set-marker)
645 (byte-defop 148 0 byte-match-beginning)
646 (byte-defop 149 0 byte-match-end)
647 (byte-defop 150 0 byte-upcase)
648 (byte-defop 151 0 byte-downcase)
649 (byte-defop 152 -1 byte-string=)
650 (byte-defop 153 -1 byte-string<)
651 (byte-defop 154 -1 byte-equal)
652 (byte-defop 155 -1 byte-nthcdr)
653 (byte-defop 156 -1 byte-elt)
654 (byte-defop 157 -1 byte-member)
655 (byte-defop 158 -1 byte-assq)
656 (byte-defop 159 0 byte-nreverse)
657 (byte-defop 160 -1 byte-setcar)
658 (byte-defop 161 -1 byte-setcdr)
659 (byte-defop 162 0 byte-car-safe)
660 (byte-defop 163 0 byte-cdr-safe)
661 (byte-defop 164 -1 byte-nconc)
662 (byte-defop 165 -1 byte-quo)
663 (byte-defop 166 -1 byte-rem)
664 (byte-defop 167 0 byte-numberp)
665 (byte-defop 168 0 byte-integerp)
668 (byte-defop 175 nil byte-listN)
669 (byte-defop 176 nil byte-concatN)
670 (byte-defop 177 nil byte-insertN)
672 (byte-defop 178 -1 byte-stack-set) ; Stack offset in following one byte.
673 (byte-defop 179 -1 byte-stack-set2) ; Stack offset in following two bytes.
675 ;; If (following one byte & 0x80) == 0
676 ;; discard (following one byte & 0x7F) stack entries
678 ;; discard (following one byte & 0x7F) stack entries _underneath_ TOS
679 ;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
680 (byte-defop 182 nil byte-discardN)
681 ;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
682 ;; `byte-discardN' with the high bit in the operand set (by
683 ;; `byte-compile-lapcode').
684 (defconst byte-discardN-preserve-tos byte-discardN)
688 (byte-defop 192 1 byte-constant "for reference to a constant")
689 ;; codes 193-255 are consumed by byte-constant.
690 (defconst byte-constant-limit 64
691 "Exclusive maximum index usable in the `byte-constant' opcode.")
693 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
694 byte-goto-if-nil-else-pop
695 byte-goto-if-not-nil-else-pop)
696 "List of byte-codes whose offset is a pc.")
698 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
700 (byte-extrude-byte-code-vectors)
702 ;;; lapcode generator
704 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
705 ;; source -> bytecode, because it's a lot easier to make optimizations
706 ;; on lapcode than on bytecode.
708 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
709 ;; where instruction is a symbol naming a byte-code instruction,
710 ;; and parameter is an argument to that instruction, if any.
712 ;; The instruction can be the pseudo-op TAG, which means that this position
713 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
714 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
715 ;; parameter for some goto op.
717 ;; If the operation is varbind, varref, varset or push-constant, then the
718 ;; parameter is (variable/constant . index_in_constant_vector).
720 ;; First, the source code is macroexpanded and optimized in various ways.
721 ;; Then the resultant code is compiled into lapcode. Another set of
722 ;; optimizations are then run over the lapcode. Then the variables and
723 ;; constants referenced by the lapcode are collected and placed in the
724 ;; constants-vector. (This happens now so that variables referenced by dead
725 ;; code don't consume space.) And finally, the lapcode is transformed into
726 ;; compacted byte-code.
728 ;; A distinction is made between variables and constants because the variable-
729 ;; referencing instructions are more sensitive to the variables being near the
730 ;; front of the constants-vector than the constant-referencing instructions.
731 ;; Also, this lets us notice references to free variables.
733 (defmacro byte-compile-push-bytecodes (&rest args)
734 "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
735 ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
736 BYTES and PC are updated after evaluating all the arguments."
737 (let ((byte-exprs (butlast args 2))
738 (bytes-var (car (last args 2)))
739 (pc-var (car (last args))))
740 `(setq ,bytes-var ,(if (null (cdr byte-exprs))
741 `(progn (cl-assert (<= 0 ,(car byte-exprs)))
742 (cons ,@byte-exprs ,bytes-var))
743 `(nconc (list ,@(reverse byte-exprs)) ,bytes-var))
744 ,pc-var (+ ,(length byte-exprs) ,pc-var))))
746 (defmacro byte-compile-push-bytecode-const2 (opcode const2 bytes pc)
747 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
748 CONST2 may be evaluated multiple times."
749 `(byte-compile-push-bytecodes ,opcode (logand ,const2 255) (lsh ,const2 -8)
752 (defun byte-compile-lapcode (lap)
753 "Turns lapcode into bytecode. The lapcode is destroyed."
754 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
755 (let ((pc 0) ; Program counter
756 op off ; Operation & offset
757 opcode ; numeric value of OP
758 (bytes '()) ; Put the output bytes here
759 (patchlist nil)) ; List of gotos to patch
760 (dolist (lap-entry lap)
761 (setq op (car lap-entry)
765 (error "Non-symbolic opcode `%s'" op))
770 (if (eq op 'byte-discardN-preserve-tos)
771 ;; byte-discardN-preserve-tos is a pseudo op, which
772 ;; is actually the same as byte-discardN
773 ;; with a modified argument.
776 (cond ((memq op byte-goto-ops)
778 (byte-compile-push-bytecodes opcode nil (cdr off) bytes pc)
779 (push bytes patchlist))
780 ((or (and (consp off)
781 ;; Variable or constant reference
784 (eq op 'byte-constant)))
785 (and (eq op 'byte-constant)
788 (if (< off byte-constant-limit)
789 (byte-compile-push-bytecodes (+ byte-constant off)
791 (byte-compile-push-bytecode-const2 byte-constant2 off
793 ((and (= opcode byte-stack-set)
795 ;; Use the two-byte version of byte-stack-set if the
796 ;; offset is too large for the normal version.
797 (byte-compile-push-bytecode-const2 byte-stack-set2 off
799 ((and (>= opcode byte-listN)
800 (< opcode byte-discardN))
801 ;; These insns all put their operand into one extra byte.
802 (byte-compile-push-bytecodes opcode off bytes pc))
803 ((= opcode byte-discardN)
804 ;; byte-discardN is weird in that it encodes a flag in the
805 ;; top bit of its one-byte argument. If the argument is
806 ;; too large to fit in 7 bits, the opcode can be repeated.
807 (let ((flag (if (eq op 'byte-discardN-preserve-tos) #x80 0)))
809 (byte-compile-push-bytecodes opcode (logior #x7f flag)
811 (setq off (- off #x7f)))
812 (byte-compile-push-bytecodes opcode (logior off flag)
815 ;; opcode that doesn't use OFF
816 (byte-compile-push-bytecodes opcode bytes pc))
817 ((and (eq opcode byte-stack-ref) (eq off 0))
818 ;; (stack-ref 0) is really just another name for `dup'.
819 (debug) ;FIXME: When would this happen?
820 (byte-compile-push-bytecodes byte-dup bytes pc))
821 ;; The following three cases are for the special
822 ;; insns that encode their operand into 0, 1, or 2
823 ;; extra bytes depending on its magnitude.
825 (byte-compile-push-bytecodes (+ opcode off) bytes pc))
827 (byte-compile-push-bytecodes (+ opcode 6) off bytes pc))
829 (byte-compile-push-bytecode-const2 (+ opcode 7) off
831 ;;(if (not (= pc (length bytes)))
832 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
833 ;; Patch tag PCs into absolute jumps.
834 (dolist (bytes-tail patchlist)
835 (setq pc (caar bytes-tail)) ; Pick PC from goto's tag.
836 (setcar (cdr bytes-tail) (logand pc 255))
837 (setcar bytes-tail (lsh pc -8))
838 ;; FIXME: Replace this by some workaround.
839 (if (> (car bytes-tail) 255) (error "Bytecode overflow")))
841 (apply 'unibyte-string (nreverse bytes))))
844 ;;; compile-time evaluation
846 (defun byte-compile-cl-file-p (file)
847 "Return non-nil if FILE is one of the CL files."
849 (string-match "^cl\\.el" (file-name-nondirectory file))))
851 (defun byte-compile-eval (form)
852 "Eval FORM and mark the functions defined therein.
853 Each function's symbol gets added to `byte-compile-noruntime-functions'."
854 (let ((hist-orig load-history)
855 (hist-nil-orig current-load-list))
856 (prog1 (eval form lexical-binding)
857 (when (byte-compile-warning-enabled-p 'noruntime)
858 (let ((hist-new load-history)
859 (hist-nil-new current-load-list))
860 ;; Go through load-history, look for newly loaded files
861 ;; and mark all the functions defined therein.
862 (while (and hist-new (not (eq hist-new hist-orig)))
863 (let ((xs (pop hist-new))
865 ;; Make sure the file was not already loaded before.
866 (unless (or (assoc (car xs) hist-orig)
867 ;; Don't give both the "noruntime" and
868 ;; "cl-functions" warning for the same function.
869 ;; FIXME This seems incorrect - these are two
870 ;; independent warnings. For example, you may be
871 ;; choosing to see the cl warnings but ignore them.
872 ;; You probably don't want to ignore noruntime in the
874 (and (byte-compile-warning-enabled-p 'cl-functions)
875 (byte-compile-cl-file-p (car xs))))
879 (unless (memq s old-autoloads)
880 (push s byte-compile-noruntime-functions)))
881 ((and (consp s) (eq t (car s)))
882 (push (cdr s) old-autoloads))
883 ((and (consp s) (eq 'autoload (car s)))
884 (push (cdr s) byte-compile-noruntime-functions)))))))
885 ;; Go through current-load-list for the locally defined funs.
887 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
888 (let ((s (pop hist-nil-new)))
889 (when (and (symbolp s) (not (memq s old-autoloads)))
890 (push s byte-compile-noruntime-functions))
891 (when (and (consp s) (eq t (car s)))
892 (push (cdr s) old-autoloads)))))))
893 (when (byte-compile-warning-enabled-p 'cl-functions)
894 (let ((hist-new load-history))
895 ;; Go through load-history, looking for the cl files.
896 ;; Since new files are added at the start of load-history,
897 ;; we scan the new history until the tail matches the old.
898 (while (and (not byte-compile-cl-functions)
899 hist-new (not (eq hist-new hist-orig)))
900 ;; We used to check if the file had already been loaded,
901 ;; but it is better to check non-nil byte-compile-cl-functions.
902 (and (byte-compile-cl-file-p (car (pop hist-new)))
903 (byte-compile-find-cl-functions))))))))
905 (defun byte-compile-eval-before-compile (form)
906 "Evaluate FORM for `eval-and-compile'."
907 (let ((hist-nil-orig current-load-list))
908 (prog1 (eval form lexical-binding)
909 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
910 ;; FIXME Why does it do that - just as a hack?
911 ;; There are other ways to do this nowadays.
912 (let ((tem current-load-list))
913 (while (not (eq tem hist-nil-orig))
914 (when (equal (car tem) '(require . cl))
915 (byte-compile-disable-warning 'cl-functions))
916 (setq tem (cdr tem)))))))
918 ;;; byte compiler messages
920 (defvar byte-compile-current-form nil)
921 (defvar byte-compile-dest-file nil)
922 (defvar byte-compile-current-file nil)
923 (defvar byte-compile-current-group nil)
924 (defvar byte-compile-current-buffer nil)
926 ;; Log something that isn't a warning.
927 (defmacro byte-compile-log (format-string &rest args)
930 (memq byte-optimize-log '(t source))
931 (let ((print-escape-newlines t)
938 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
941 ;; Log something that isn't a warning.
942 (defun byte-compile-log-1 (string)
943 (with-current-buffer byte-compile-log-buffer
944 (let ((inhibit-read-only t))
945 (goto-char (point-max))
946 (byte-compile-warning-prefix nil nil)
947 (cond (noninteractive
948 (message " %s" string))
950 (insert (format "%s\n" string)))))))
952 (defvar byte-compile-read-position nil
953 "Character position we began the last `read' from.")
954 (defvar byte-compile-last-position nil
955 "Last known character position in the input.")
957 ;; copied from gnus-util.el
958 (defsubst byte-compile-delete-first (elt list)
959 (if (eq (car list) elt)
962 (while (and (cdr list)
963 (not (eq (cadr list) elt)))
964 (setq list (cdr list)))
966 (setcdr list (cddr list)))
969 ;; The purpose of this function is to iterate through the
970 ;; `read-symbol-positions-list'. Each time we process, say, a
971 ;; function definition (`defun') we remove `defun' from
972 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
973 ;; to that symbol's character position. Similarly, if we encounter a
974 ;; variable reference, like in (1+ foo), we remove `foo' from the
975 ;; list. If our current position is after the symbol's position, we
976 ;; assume we've already passed that point, and look for the next
977 ;; occurrence of the symbol.
979 ;; This function should not be called twice for the same occurrence of
980 ;; a symbol, and it should not be called for symbols generated by the
981 ;; byte compiler itself; because rather than just fail looking up the
982 ;; symbol, we may find an occurrence of the symbol further ahead, and
983 ;; then `byte-compile-last-position' as advanced too far.
985 ;; So your're probably asking yourself: Isn't this function a
986 ;; gross hack? And the answer, of course, would be yes.
987 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
988 (when byte-compile-read-position
991 (setq last byte-compile-last-position
992 entry (assq sym read-symbol-positions-list))
994 (setq byte-compile-last-position
995 (+ byte-compile-read-position (cdr entry))
996 read-symbol-positions-list
997 (byte-compile-delete-first
998 entry read-symbol-positions-list)))
999 (or (and allow-previous
1000 (not (= last byte-compile-last-position)))
1001 (> last byte-compile-last-position)))))))
1003 (defvar byte-compile-last-warned-form nil)
1004 (defvar byte-compile-last-logged-file nil)
1005 (defvar byte-compile-root-dir nil
1006 "Directory relative to which file names in error messages are written.")
1008 ;; FIXME: We should maybe extend abbreviate-file-name with an optional DIR
1009 ;; argument to try and use a relative file-name.
1010 (defun byte-compile-abbreviate-file (file &optional dir)
1011 (let ((f1 (abbreviate-file-name file))
1012 (f2 (file-relative-name file dir)))
1013 (if (< (length f2) (length f1)) f2 f1)))
1015 ;; This is used as warning-prefix for the compiler.
1016 ;; It is always called with the warnings buffer current.
1017 (defun byte-compile-warning-prefix (level entry)
1018 (let* ((inhibit-read-only t)
1019 (dir (or byte-compile-root-dir default-directory))
1020 (file (cond ((stringp byte-compile-current-file)
1021 (format "%s:" (byte-compile-abbreviate-file
1022 byte-compile-current-file dir)))
1023 ((bufferp byte-compile-current-file)
1024 (format "Buffer %s:"
1025 (buffer-name byte-compile-current-file)))
1026 ;; We might be simply loading a file that
1027 ;; contains explicit calls to byte-compile functions.
1028 ((stringp load-file-name)
1029 (format "%s:" (byte-compile-abbreviate-file
1030 load-file-name dir)))
1032 (pos (if (and byte-compile-current-file
1033 (integerp byte-compile-read-position))
1034 (with-current-buffer byte-compile-current-buffer
1037 (goto-char byte-compile-last-position)
1038 (1+ (count-lines (point-min) (point-at-bol))))
1040 (goto-char byte-compile-last-position)
1041 (1+ (current-column)))))
1043 (form (if (eq byte-compile-current-form :end) "end of data"
1044 (or byte-compile-current-form "toplevel form"))))
1045 (when (or (and byte-compile-current-file
1046 (not (equal byte-compile-current-file
1047 byte-compile-last-logged-file)))
1048 (and byte-compile-current-form
1049 (not (eq byte-compile-current-form
1050 byte-compile-last-warned-form))))
1051 (insert (format "\nIn %s:\n" form)))
1053 (insert (format "%s%s" file pos))))
1054 (setq byte-compile-last-logged-file byte-compile-current-file
1055 byte-compile-last-warned-form byte-compile-current-form)
1058 ;; This no-op function is used as the value of warning-series
1059 ;; to tell inner calls to displaying-byte-compile-warnings
1060 ;; not to bind warning-series.
1061 (defun byte-compile-warning-series (&rest _ignore)
1064 ;; (compile-mode) will cause this to be loaded.
1065 (declare-function compilation-forget-errors "compile" ())
1067 ;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
1068 ;; Return the position of the start of the page in the log buffer.
1069 ;; But do nothing in batch mode.
1070 (defun byte-compile-log-file ()
1071 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1072 (not noninteractive)
1073 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1074 (goto-char (point-max))
1075 (let* ((inhibit-read-only t)
1076 (dir (and byte-compile-current-file
1077 (file-name-directory byte-compile-current-file)))
1078 (was-same (equal default-directory dir))
1082 (insert (format "Leaving directory `%s'\n" default-directory))))
1085 (setq pt (point-marker))
1086 (if byte-compile-current-file
1087 (insert "\f\nCompiling "
1088 (if (stringp byte-compile-current-file)
1089 (concat "file " byte-compile-current-file)
1091 (buffer-name byte-compile-current-file)))
1092 " at " (current-time-string) "\n")
1093 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1095 (setq default-directory dir)
1097 (insert (format "Entering directory `%s'\n"
1098 default-directory))))
1099 (setq byte-compile-last-logged-file byte-compile-current-file
1100 byte-compile-last-warned-form nil)
1101 ;; Do this after setting default-directory.
1102 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1103 (compilation-forget-errors)
1106 ;; Log a message STRING in `byte-compile-log-buffer'.
1107 ;; Also log the current function and file if not already done.
1108 (defun byte-compile-log-warning (string &optional fill level)
1109 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1110 (warning-type-format "")
1111 (warning-fill-prefix (if fill " "))
1112 (inhibit-read-only t))
1113 (display-warning 'bytecomp string level byte-compile-log-buffer)))
1115 (defun byte-compile-warn (format &rest args)
1116 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1117 (setq format (apply 'format format args))
1118 (if byte-compile-error-on-warn
1119 (error "%s" format) ; byte-compile-file catches and logs it
1120 (byte-compile-log-warning format t :warning)))
1122 (defun byte-compile-warn-obsolete (symbol)
1123 "Warn that SYMBOL (a variable or function) is obsolete."
1124 (when (byte-compile-warning-enabled-p 'obsolete)
1125 (let* ((funcp (get symbol 'byte-obsolete-info))
1126 (msg (macroexp--obsolete-warning
1128 (or funcp (get symbol 'byte-obsolete-variable))
1129 (if funcp "function" "variable"))))
1130 (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
1131 (byte-compile-warn "%s" msg)))))
1133 (defun byte-compile-report-error (error-info)
1134 "Report Lisp error in compilation. ERROR-INFO is the error data."
1135 (setq byte-compiler-error-flag t)
1136 (byte-compile-log-warning
1137 (error-message-string error-info)
1140 ;;; sanity-checking arglists
1142 (defun byte-compile-fdefinition (name macro-p)
1143 ;; If a function has an entry saying (FUNCTION . t).
1144 ;; that means we know it is defined but we don't know how.
1145 ;; If a function has an entry saying (FUNCTION . nil),
1146 ;; that means treat it as not defined.
1147 (let* ((list (if macro-p
1148 byte-compile-macro-environment
1149 byte-compile-function-environment))
1150 (env (cdr (assq name list))))
1153 (while (and (symbolp fn)
1155 (or (symbolp (symbol-function fn))
1156 (consp (symbol-function fn))
1158 (byte-code-function-p (symbol-function fn)))))
1159 (setq fn (symbol-function fn)))
1160 (let ((advertised (gethash (if (and (symbolp fn) (fboundp fn))
1162 (symbol-function fn)
1164 advertised-signature-table t)))
1168 `(macro lambda ,advertised)
1169 `(lambda ,advertised)))
1170 ((and (not macro-p) (byte-code-function-p fn)) fn)
1171 ((not (consp fn)) nil)
1172 ((eq 'macro (car fn)) (cdr fn))
1174 ((eq 'autoload (car fn)) nil)
1177 (defun byte-compile-arglist-signature (arglist)
1179 ;; New style byte-code arglist.
1181 (cons (logand arglist 127) ;Mandatory.
1182 (if (zerop (logand arglist 128)) ;No &rest.
1183 (lsh arglist -8)))) ;Nonrest.
1184 ;; Old style byte-code, or interpreted function.
1190 (cond ((eq (car arglist) '&optional)
1191 (or opts (setq opts 0)))
1192 ((eq (car arglist) '&rest)
1198 (setq opts (1+ opts))
1199 (setq args (1+ args)))))
1200 (setq arglist (cdr arglist)))
1201 (cons args (if restp nil (if opts (+ args opts) args)))))
1206 (defun byte-compile-arglist-signatures-congruent-p (old new)
1208 (> (car new) (car old)) ; requires more args now
1209 (and (null (cdr old)) ; took rest-args, doesn't any more
1211 (and (cdr new) (cdr old) ; can't take as many args now
1212 (< (cdr new) (cdr old)))
1215 (defun byte-compile-arglist-signature-string (signature)
1216 (cond ((null (cdr signature))
1217 (format "%d+" (car signature)))
1218 ((= (car signature) (cdr signature))
1219 (format "%d" (car signature)))
1220 (t (format "%d-%d" (car signature) (cdr signature)))))
1223 ;; Warn if the form is calling a function with the wrong number of arguments.
1224 (defun byte-compile-callargs-warn (form)
1225 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1226 (byte-compile-fdefinition (car form) t)))
1227 (sig (if (and def (not (eq def t)))
1229 (and (eq (car-safe def) 'macro)
1230 (eq (car-safe (cdr-safe def)) 'lambda)
1231 (setq def (cdr def)))
1232 (byte-compile-arglist-signature
1233 (if (memq (car-safe def) '(declared lambda))
1235 (if (byte-code-function-p def)
1238 (if (and (fboundp (car form))
1239 (subrp (symbol-function (car form))))
1240 (subr-arity (symbol-function (car form))))))
1241 (ncall (length (cdr form))))
1242 ;; Check many or unevalled from subr-arity.
1243 (if (and (cdr-safe sig)
1244 (not (numberp (cdr sig))))
1247 (when (or (< ncall (car sig))
1248 (and (cdr sig) (> ncall (cdr sig))))
1249 (byte-compile-set-symbol-position (car form))
1251 "%s called with %d argument%s, but %s %s"
1253 (if (= 1 ncall) "" "s")
1254 (if (< ncall (car sig))
1257 (byte-compile-arglist-signature-string sig))))
1258 (byte-compile-format-warn form)
1259 ;; Check to see if the function will be available at runtime
1260 ;; and/or remember its arity if it's unknown.
1261 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1262 (not (memq (car form) byte-compile-noruntime-functions)))
1263 (eq (car form) byte-compile-current-form) ; ## This doesn't work
1265 ;; It's a currently-undefined function.
1266 ;; Remember number of args in call.
1267 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1268 (n (length (cdr form))))
1270 (or (memq n (cdr cons))
1271 (setcdr cons (cons n (cdr cons))))
1272 (push (list (car form) n)
1273 byte-compile-unresolved-functions))))))
1275 (defun byte-compile-format-warn (form)
1276 "Warn if FORM is `format'-like with inconsistent args.
1277 Applies if head of FORM is a symbol with non-nil property
1278 `byte-compile-format-like' and first arg is a constant string.
1279 Then check the number of format fields matches the number of
1281 (when (and (symbolp (car form))
1282 (stringp (nth 1 form))
1283 (get (car form) 'byte-compile-format-like))
1284 (let ((nfields (with-temp-buffer
1285 (insert (nth 1 form))
1286 (goto-char (point-min))
1288 (while (re-search-forward "%." nil t)
1289 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1292 (nargs (- (length form) 2)))
1293 (unless (= nargs nfields)
1295 "`%s' called with %d args to fill %d format field(s)" (car form)
1298 (dolist (elt '(format message error))
1299 (put elt 'byte-compile-format-like t))
1301 ;; Warn if a custom definition fails to specify :group.
1302 (defun byte-compile-nogroup-warn (form)
1303 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1304 byte-compile-current-group)
1305 ;; The group will be provided implicitly.
1307 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1309 (or (not (eq (car-safe name) 'quote))
1310 (and (eq (car form) 'custom-declare-group)
1311 (equal name ''emacs))
1312 (plist-get keyword-args :group)
1313 (not (and (consp name) (eq (car name) 'quote)))
1315 "%s for `%s' fails to specify containing group"
1316 (cdr (assq (car form)
1317 '((custom-declare-group . defgroup)
1318 (custom-declare-face . defface)
1319 (custom-declare-variable . defcustom))))
1321 ;; Update the current group, if needed.
1322 (if (and byte-compile-current-file ;Only when compiling a whole file.
1323 (eq (car form) 'custom-declare-group)
1324 (eq (car-safe name) 'quote))
1325 (setq byte-compile-current-group (cadr name))))))
1327 ;; Warn if the function or macro is being redefined with a different
1328 ;; number of arguments.
1329 (defun byte-compile-arglist-warn (name arglist macrop)
1330 (let* ((old (byte-compile-fdefinition name macrop))
1331 (initial (and macrop
1333 byte-compile-initial-macro-environment)))))
1334 ;; Assumes an element of b-c-i-macro-env that is a symbol points
1335 ;; to a defined function. (Bug#8646)
1336 (and initial (symbolp initial)
1337 (setq old (byte-compile-fdefinition initial nil)))
1338 (if (and old (not (eq old t)))
1340 (and (eq 'macro (car-safe old))
1341 (eq 'lambda (car-safe (cdr-safe old)))
1342 (setq old (cdr old)))
1343 (let ((sig1 (byte-compile-arglist-signature
1345 (`(lambda ,args . ,_) args)
1346 (`(closure ,_ ,args . ,_) args)
1347 ((pred byte-code-function-p) (aref old 0))
1349 (sig2 (byte-compile-arglist-signature arglist)))
1350 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1351 (byte-compile-set-symbol-position name)
1353 "%s %s used to take %s %s, now takes %s"
1354 (if macrop "macro" "function")
1356 (byte-compile-arglist-signature-string sig1)
1357 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1358 (byte-compile-arglist-signature-string sig2)))))
1359 ;; This is the first definition. See if previous calls are compatible.
1360 (let ((calls (assq name byte-compile-unresolved-functions))
1363 (when (and (symbolp name)
1364 (eq (function-get name 'byte-optimizer)
1365 'byte-compile-inline-expand))
1366 (byte-compile-warn "defsubst `%s' was used before it was defined"
1368 (setq sig (byte-compile-arglist-signature arglist)
1369 nums (sort (copy-sequence (cdr calls)) (function <))
1371 max (car (nreverse nums)))
1372 (when (or (< min (car sig))
1373 (and (cdr sig) (> max (cdr sig))))
1374 (byte-compile-set-symbol-position name)
1376 "%s being defined to take %s%s, but was previously called with %s"
1378 (byte-compile-arglist-signature-string sig)
1379 (if (equal sig '(1 . 1)) " arg" " args")
1380 (byte-compile-arglist-signature-string (cons min max))))
1382 (setq byte-compile-unresolved-functions
1383 (delq calls byte-compile-unresolved-functions)))))))
1385 (defvar byte-compile-cl-functions nil
1386 "List of functions defined in CL.")
1388 ;; Can't just add this to cl-load-hook, because that runs just before
1389 ;; the forms from cl.el get added to load-history.
1390 (defun byte-compile-find-cl-functions ()
1391 (unless byte-compile-cl-functions
1392 (dolist (elt load-history)
1393 (and (byte-compile-cl-file-p (car elt))
1394 (dolist (e (cdr elt))
1395 ;; Includes the cl-foo functions that cl autoloads.
1396 (when (memq (car-safe e) '(autoload defun))
1397 (push (cdr e) byte-compile-cl-functions)))))))
1399 (defun byte-compile-cl-warn (form)
1400 "Warn if FORM is a call of a function from the CL package."
1401 (let ((func (car-safe form)))
1402 (if (and byte-compile-cl-functions
1403 (memq func byte-compile-cl-functions)
1404 ;; Aliases which won't have been expanded at this point.
1405 ;; These aren't all aliases of subrs, so not trivial to
1406 ;; avoid hardwiring the list.
1408 '(cl--block-wrapper cl--block-throw
1409 multiple-value-call nth-value
1410 copy-seq first second rest endp cl-member
1411 ;; These are included in generated code
1412 ;; that can't be called except at compile time
1413 ;; or unless cl is loaded anyway.
1414 cl--defsubst-expand cl-struct-setf-expander
1415 ;; These would sometimes be warned about
1416 ;; but such warnings are never useful,
1417 ;; so don't warn about them.
1418 macroexpand cl-macroexpand-all
1419 cl--compiling-file))))
1420 (byte-compile-warn "function `%s' from cl package called at runtime"
1424 (defun byte-compile-print-syms (str1 strn syms)
1426 (byte-compile-set-symbol-position (car syms) t))
1427 (cond ((and (cdr syms) (not noninteractive))
1432 (setq s (symbol-name (pop syms))
1433 L (+ L (length s) 2))
1434 (if (< L (1- fill-column))
1435 (setq str (concat str " " s (and syms ",")))
1436 (setq str (concat str "\n " s (and syms ","))
1437 L (+ (length s) 4))))
1438 (byte-compile-warn "%s" str)))
1440 (byte-compile-warn "%s %s"
1442 (mapconcat #'symbol-name syms ", ")))
1445 (byte-compile-warn str1 (car syms)))))
1447 ;; If we have compiled any calls to functions which are not known to be
1448 ;; defined, issue a warning enumerating them.
1449 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1450 (defun byte-compile-warn-about-unresolved-functions ()
1451 (when (byte-compile-warning-enabled-p 'unresolved)
1452 (let ((byte-compile-current-form :end)
1455 ;; Separate the functions that will not be available at runtime
1456 ;; from the truly unresolved ones.
1457 (dolist (f byte-compile-unresolved-functions)
1459 (if (fboundp f) (push f noruntime) (push f unresolved)))
1460 ;; Complain about the no-run-time functions
1461 (byte-compile-print-syms
1462 "the function `%s' might not be defined at runtime."
1463 "the following functions might not be defined at runtime:"
1465 ;; Complain about the unresolved functions
1466 (byte-compile-print-syms
1467 "the function `%s' is not known to be defined."
1468 "the following functions are not known to be defined:"
1473 ;; Dynamically bound in byte-compile-from-buffer.
1474 ;; NB also used in cl.el and cl-macs.el.
1475 (defvar byte-compile--outbuffer)
1477 (defmacro byte-compile-close-variables (&rest body)
1480 ;; Close over these variables to encapsulate the
1481 ;; compilation state
1483 (byte-compile-macro-environment
1484 ;; Copy it because the compiler may patch into the
1485 ;; macroenvironment.
1486 (copy-alist byte-compile-initial-macro-environment))
1487 (byte-compile--outbuffer nil)
1488 (byte-compile-function-environment nil)
1489 (byte-compile-bound-variables nil)
1490 (byte-compile-const-variables nil)
1491 (byte-compile-free-references nil)
1492 (byte-compile-free-assignments nil)
1494 ;; Close over these variables so that `byte-compiler-options'
1495 ;; can change them on a per-file basis.
1497 (byte-compile-verbose byte-compile-verbose)
1498 (byte-optimize byte-optimize)
1499 (byte-compile-dynamic byte-compile-dynamic)
1500 (byte-compile-dynamic-docstrings
1501 byte-compile-dynamic-docstrings)
1502 ;; (byte-compile-generate-emacs19-bytecodes
1503 ;; byte-compile-generate-emacs19-bytecodes)
1504 (byte-compile-warnings byte-compile-warnings)
1508 (defmacro displaying-byte-compile-warnings (&rest body)
1510 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1511 (warning-series-started
1512 (and (markerp warning-series)
1513 (eq (marker-buffer warning-series)
1514 (get-buffer byte-compile-log-buffer)))))
1515 (byte-compile-find-cl-functions)
1516 (if (or (eq warning-series 'byte-compile-warning-series)
1517 warning-series-started)
1518 ;; warning-series does come from compilation,
1519 ;; so don't bind it, but maybe do set it.
1521 ;; Log the file name. Record position of that text.
1522 (setq tem (byte-compile-log-file))
1523 (unless warning-series-started
1524 (setq warning-series (or tem 'byte-compile-warning-series)))
1525 (if byte-compile-debug
1526 (funcall --displaying-byte-compile-warnings-fn)
1527 (condition-case error-info
1528 (funcall --displaying-byte-compile-warnings-fn)
1529 (error (byte-compile-report-error error-info)))))
1530 ;; warning-series does not come from compilation, so bind it.
1531 (let ((warning-series
1532 ;; Log the file name. Record position of that text.
1533 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1534 (if byte-compile-debug
1535 (funcall --displaying-byte-compile-warnings-fn)
1536 (condition-case error-info
1537 (funcall --displaying-byte-compile-warnings-fn)
1538 (error (byte-compile-report-error error-info))))))))
1541 (defun byte-force-recompile (directory)
1542 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1543 Files in subdirectories of DIRECTORY are processed also."
1544 (interactive "DByte force recompile (directory): ")
1545 (byte-recompile-directory directory nil t))
1548 (defun byte-recompile-directory (directory &optional arg force)
1549 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1550 This happens when a `.elc' file exists but is older than the `.el' file.
1551 Files in subdirectories of DIRECTORY are processed also.
1553 If the `.elc' file does not exist, normally this function *does not*
1554 compile the corresponding `.el' file. However, if the prefix argument
1555 ARG is 0, that means do compile all those files. A nonzero
1556 ARG means ask the user, for each such `.el' file, whether to
1557 compile it. A nonzero ARG also means ask about each subdirectory
1560 If the third argument FORCE is non-nil, recompile every `.el' file
1561 that already has a `.elc' file."
1562 (interactive "DByte recompile directory: \nP")
1563 (if arg (setq arg (prefix-numeric-value arg)))
1567 (force-mode-line-update))
1568 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1569 (setq default-directory (expand-file-name directory))
1570 ;; compilation-mode copies value of default-directory.
1571 (unless (eq major-mode 'compilation-mode)
1573 (let ((directories (list default-directory))
1574 (default-directory default-directory)
1580 (displaying-byte-compile-warnings
1582 (setq directory (car directories))
1583 (message "Checking %s..." directory)
1584 (dolist (file (directory-files directory))
1585 (let ((source (expand-file-name file directory)))
1586 (if (and (not (member file '("RCS" "CVS")))
1587 (not (eq ?\. (aref file 0)))
1588 (file-directory-p source)
1589 (not (file-symlink-p source)))
1590 ;; This file is a subdirectory. Handle them differently.
1591 (when (or (null arg) (eq 0 arg)
1592 (y-or-n-p (concat "Check " source "? ")))
1593 (setq directories (nconc directories (list source))))
1594 ;; It is an ordinary file. Decide whether to compile it.
1595 (if (and (string-match emacs-lisp-file-regexp source)
1596 (file-readable-p source)
1597 (not (auto-save-file-name-p source))
1598 (not (string-equal dir-locals-file
1599 (file-name-nondirectory source))))
1601 (pcase (byte-recompile-file source force arg)
1602 (`no-byte-compile skip-count)
1606 (message "Checking %s..." directory))
1607 (if (not (eq last-dir directory))
1608 (setq last-dir directory
1609 dir-count (1+ dir-count)))
1611 (setq directories (cdr directories))))
1612 (message "Done (Total of %d file%s compiled%s%s%s)"
1613 file-count (if (= file-count 1) "" "s")
1614 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1615 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1617 (format " in %d directories" dir-count) "")))))
1619 (defvar no-byte-compile nil
1620 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1621 This is normally set in local file variables at the end of the elisp file:
1623 \;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
1624 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1626 (defun byte-recompile-file (filename &optional force arg load)
1627 "Recompile FILENAME file if it needs recompilation.
1628 This happens when its `.elc' file is older than itself.
1630 If the `.elc' file exists and is up-to-date, normally this function
1631 *does not* compile FILENAME. If the prefix argument FORCE is non-nil,
1632 however, it compiles FILENAME even if the destination already
1633 exists and is up-to-date.
1635 If the `.elc' file does not exist, normally this function *does not*
1636 compile FILENAME. If optional argument ARG is 0, it compiles
1637 the input file even if the `.elc' file does not exist.
1638 Any other non-nil value of ARG means to ask the user.
1640 If optional argument LOAD is non-nil, loads the file after compiling.
1642 If compilation is needed, this functions returns the result of
1643 `byte-compile-file'; otherwise it returns 'no-byte-compile."
1645 (let ((file buffer-file-name)
1649 (derived-mode-p 'emacs-lisp-mode)
1650 (setq file-name (file-name-nondirectory file)
1651 file-dir (file-name-directory file)))
1652 (list (read-file-name (if current-prefix-arg
1653 "Byte compile file: "
1654 "Byte recompile file: ")
1655 file-dir file-name nil)
1656 current-prefix-arg)))
1657 (let ((dest (byte-compile-dest-file filename))
1658 ;; Expand now so we get the current buffer's defaults
1659 (filename (expand-file-name filename)))
1660 (if (if (file-exists-p dest)
1661 ;; File was already compiled
1662 ;; Compile if forced to, or filename newer
1664 (file-newer-than-file-p filename dest))
1667 (y-or-n-p (concat "Compile "
1670 (if (and noninteractive (not byte-compile-verbose))
1671 (message "Compiling %s..." filename))
1672 (byte-compile-file filename load))
1674 (load (if (file-exists-p dest) dest filename)))
1678 (defun byte-compile-file (filename &optional load)
1679 "Compile a file of Lisp code named FILENAME into a file of byte code.
1680 The output file's name is generated by passing FILENAME to the
1681 function `byte-compile-dest-file' (which see).
1682 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1683 The value is non-nil if there were no errors, nil if errors."
1684 ;; (interactive "fByte compile file: \nP")
1686 (let ((file buffer-file-name)
1690 (derived-mode-p 'emacs-lisp-mode)
1691 (setq file-name (file-name-nondirectory file)
1692 file-dir (file-name-directory file)))
1693 (list (read-file-name (if current-prefix-arg
1694 "Byte compile and load file: "
1695 "Byte compile file: ")
1696 file-dir file-name nil)
1697 current-prefix-arg)))
1698 ;; Expand now so we get the current buffer's defaults
1699 (setq filename (expand-file-name filename))
1701 ;; If we're compiling a file that's in a buffer and is modified, offer
1702 ;; to save it first.
1704 (let ((b (get-file-buffer (expand-file-name filename))))
1705 (if (and b (buffer-modified-p b)
1706 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1707 (with-current-buffer b (save-buffer)))))
1709 ;; Force logging of the file name for each file compiled.
1710 (setq byte-compile-last-logged-file nil)
1711 (let ((byte-compile-current-file filename)
1712 (byte-compile-current-group nil)
1713 (set-auto-coding-for-load t)
1714 target-file input-buffer output-buffer
1715 byte-compile-dest-file)
1716 (setq target-file (byte-compile-dest-file filename))
1717 (setq byte-compile-dest-file target-file)
1718 (with-current-buffer
1719 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1721 (setq buffer-file-coding-system nil)
1722 ;; Always compile an Emacs Lisp file as multibyte
1723 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1724 (set-buffer-multibyte t)
1725 (insert-file-contents filename)
1726 ;; Mimic the way after-insert-file-set-coding can make the
1727 ;; buffer unibyte when visiting this file.
1728 (when (or (eq last-coding-system-used 'no-conversion)
1729 (eq (coding-system-type last-coding-system-used) 5))
1730 ;; For coding systems no-conversion and raw-text...,
1731 ;; edit the buffer as unibyte.
1732 (set-buffer-multibyte nil))
1733 ;; Run hooks including the uncompression hook.
1734 ;; If they change the file name, then change it for the output also.
1735 (let ((buffer-file-name filename)
1736 (dmm (default-value 'major-mode))
1737 ;; Ignore unsafe local variables.
1738 ;; We only care about a few of them for our purposes.
1739 (enable-local-variables :safe)
1740 (enable-local-eval nil))
1743 (setq-default major-mode 'emacs-lisp-mode)
1744 ;; Arg of t means don't alter enable-local-variables.
1746 (setq-default major-mode dmm))
1747 ;; There may be a file local variable setting (bug#10419).
1748 (setq buffer-read-only nil
1749 filename buffer-file-name))
1750 ;; Set the default directory, in case an eval-when-compile uses it.
1751 (setq default-directory (file-name-directory filename)))
1752 ;; Check if the file's local variables explicitly specify not to
1753 ;; compile this file.
1754 (if (with-current-buffer input-buffer no-byte-compile)
1756 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1757 ;; (byte-compile-abbreviate-file filename)
1758 ;; (with-current-buffer input-buffer no-byte-compile))
1759 (when (file-exists-p target-file)
1760 (message "%s deleted because of `no-byte-compile: %s'"
1761 (byte-compile-abbreviate-file target-file)
1762 (buffer-local-value 'no-byte-compile input-buffer))
1763 (condition-case nil (delete-file target-file) (error nil)))
1764 ;; We successfully didn't compile this file.
1766 (when byte-compile-verbose
1767 (message "Compiling %s..." filename))
1768 (setq byte-compiler-error-flag nil)
1769 ;; It is important that input-buffer not be current at this call,
1770 ;; so that the value of point set in input-buffer
1771 ;; within byte-compile-from-buffer lingers in that buffer.
1773 (save-current-buffer
1774 (byte-compile-from-buffer input-buffer)))
1775 (if byte-compiler-error-flag
1777 (when byte-compile-verbose
1778 (message "Compiling %s...done" filename))
1779 (kill-buffer input-buffer)
1780 (with-current-buffer output-buffer
1781 (goto-char (point-max))
1782 (insert "\n") ; aaah, unix.
1783 (if (file-writable-p target-file)
1784 ;; We must disable any code conversion here.
1785 (let* ((coding-system-for-write 'no-conversion)
1786 ;; Write to a tempfile so that if another Emacs
1787 ;; process is trying to load target-file (eg in a
1788 ;; parallel bootstrap), it does not risk getting a
1789 ;; half-finished file. (Bug#4196)
1790 (tempfile (make-temp-name target-file))
1792 (cons (lambda () (ignore-errors (delete-file tempfile)))
1794 (if (memq system-type '(ms-dos 'windows-nt))
1795 (setq buffer-file-type t))
1796 (write-region (point-min) (point-max) tempfile nil 1)
1797 ;; This has the intentional side effect that any
1798 ;; hard-links to target-file continue to
1799 ;; point to the old file (this makes it possible
1800 ;; for installed files to share disk space with
1801 ;; the build tree, without causing problems when
1802 ;; emacs-lisp files in the build tree are
1803 ;; recompiled). Previously this was accomplished by
1804 ;; deleting target-file before writing it.
1805 (rename-file tempfile target-file t)
1806 (message "Wrote %s" target-file))
1807 ;; This is just to give a better error message than write-region
1809 (list "Opening output file"
1810 (if (file-exists-p target-file)
1811 "cannot overwrite file"
1812 "directory not writable or nonexistent")
1814 (kill-buffer (current-buffer)))
1815 (if (and byte-compile-generate-call-tree
1816 (or (eq t byte-compile-generate-call-tree)
1817 (y-or-n-p (format "Report call tree for %s? "
1820 (display-call-tree filename)))
1825 ;;; compiling a single function
1827 (defun compile-defun (&optional arg)
1828 "Compile and evaluate the current top-level form.
1829 Print the result in the echo area.
1830 With argument ARG, insert value in current buffer after the form."
1834 (beginning-of-defun)
1835 (let* ((byte-compile-current-file nil)
1836 (byte-compile-current-buffer (current-buffer))
1837 (byte-compile-read-position (point))
1838 (byte-compile-last-position byte-compile-read-position)
1839 (byte-compile-last-warned-form 'nothing)
1841 (let ((read-with-symbol-positions (current-buffer))
1842 (read-symbol-positions-list nil))
1843 (displaying-byte-compile-warnings
1844 (byte-compile-sexp (read (current-buffer)))))
1847 (message "Compiling from buffer... done.")
1848 (prin1 value (current-buffer))
1850 ((message "%s" (prin1-to-string value)))))))
1852 (defun byte-compile-from-buffer (inbuffer)
1853 (let ((byte-compile-current-buffer inbuffer)
1854 (byte-compile-read-position nil)
1855 (byte-compile-last-position nil)
1856 ;; Prevent truncation of flonums and lists as we read and print them
1857 (float-output-format nil)
1858 (case-fold-search nil)
1861 ;; Prevent edebug from interfering when we compile
1862 ;; and put the output into a file.
1863 ;; (edebug-all-defs nil)
1864 ;; (edebug-all-forms nil)
1865 ;; Simulate entry to byte-compile-top-level
1866 (byte-compile-constants nil)
1867 (byte-compile-variables nil)
1868 (byte-compile-tag-number 0)
1869 (byte-compile-depth 0)
1870 (byte-compile-maxdepth 0)
1871 (byte-compile-output nil)
1872 ;; This allows us to get the positions of symbols read; it's
1873 ;; new in Emacs 22.1.
1874 (read-with-symbol-positions inbuffer)
1875 (read-symbol-positions-list nil)
1876 ;; #### This is bound in b-c-close-variables.
1877 ;; (byte-compile-warnings byte-compile-warnings)
1879 (byte-compile-close-variables
1880 (with-current-buffer
1881 (setq byte-compile--outbuffer
1882 (get-buffer-create " *Compiler Output*"))
1883 (set-buffer-multibyte t)
1885 ;; (emacs-lisp-mode)
1886 (setq case-fold-search nil))
1887 (displaying-byte-compile-warnings
1888 (with-current-buffer inbuffer
1889 (and byte-compile-current-file
1890 (byte-compile-insert-header byte-compile-current-file
1891 byte-compile--outbuffer))
1892 (goto-char (point-min))
1893 ;; Should we always do this? When calling multiple files, it
1894 ;; would be useful to delay this warning until all have been
1895 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1896 ;; previous byte-compile.
1897 (setq byte-compile-unresolved-functions nil)
1899 ;; Compile the forms from the input buffer.
1901 (while (progn (skip-chars-forward " \t\n\^l")
1905 (setq byte-compile-read-position (point)
1906 byte-compile-last-position byte-compile-read-position)
1907 (let* ((old-style-backquotes nil)
1908 (form (read inbuffer)))
1909 ;; Warn about the use of old-style backquotes.
1910 (when old-style-backquotes
1911 (byte-compile-warn "!! The file uses old-style backquotes !!
1912 This functionality has been obsolete for more than 10 years already
1913 and will be removed soon. See (elisp)Backquote in the manual."))
1914 (byte-compile-toplevel-file-form form)))
1915 ;; Compile pending forms at end of file.
1916 (byte-compile-flush-pending)
1917 ;; Make warnings about unresolved functions
1918 ;; give the end of the file as their position.
1919 (setq byte-compile-last-position (point-max))
1920 (byte-compile-warn-about-unresolved-functions))
1921 ;; Fix up the header at the front of the output
1922 ;; if the buffer contains multibyte characters.
1923 (and byte-compile-current-file
1924 (with-current-buffer byte-compile--outbuffer
1925 (byte-compile-fix-header byte-compile-current-file))))
1926 byte-compile--outbuffer)))
1928 (defun byte-compile-fix-header (_filename)
1929 "If the current buffer has any multibyte characters, insert a version test."
1930 (when (< (point-max) (position-bytes (point-max)))
1931 (goto-char (point-min))
1932 ;; Find the comment that describes the version condition.
1933 (search-forward "\n;;; This file uses")
1934 (narrow-to-region (line-beginning-position) (point-max))
1935 ;; Find the first line of ballast semicolons.
1936 (search-forward ";;;;;;;;;;")
1938 (narrow-to-region (point-min) (point))
1939 (let ((old-header-end (point))
1940 (minimum-version "23")
1942 (delete-region (point-min) (point-max))
1944 ";;; This file contains utf-8 non-ASCII characters,\n"
1945 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1946 ;; Have to check if emacs-version is bound so that this works
1947 ;; in files loaded early in loadup.el.
1948 "(and (boundp 'emacs-version)\n"
1949 ;; If there is a name at the end of emacs-version,
1950 ;; don't try to check the version number.
1951 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1952 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
1953 ;; Because the header must fit in a fixed width, we cannot
1954 ;; insert arbitrary-length file names (Bug#11585).
1955 " (error \"`%s' was compiled for "
1956 (format "Emacs %s or later\" #$))\n\n" minimum-version))
1957 ;; Now compensate for any change in size, to make sure all
1958 ;; positions in the file remain valid.
1959 (setq delta (- (point-max) old-header-end))
1960 (goto-char (point-max))
1962 (delete-char delta))))
1964 (defun byte-compile-insert-header (filename outbuffer)
1965 "Insert a header at the start of OUTBUFFER.
1966 Call from the source buffer."
1967 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1968 (dynamic byte-compile-dynamic)
1969 (optimize byte-optimize))
1970 (with-current-buffer outbuffer
1971 (goto-char (point-min))
1972 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1973 ;; that is the file-format version number (18, 19, 20, or 23) as a
1974 ;; byte, followed by some nulls. The primary motivation for doing
1975 ;; this is to get some binary characters up in the first line of
1976 ;; the file so that `diff' will simply say "Binary files differ"
1977 ;; instead of actually doing a diff of two .elc files. An extra
1978 ;; benefit is that you can add this to /etc/magic:
1979 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1980 ;; >4 byte x version %d
1982 ";ELC" 23 "\000\000\000\n"
1984 (or (and (boundp 'user-mail-address) user-mail-address)
1985 (concat (user-login-name) "@" (system-name)))
1986 " on " (current-time-string) "\n"
1987 ";;; from file " filename "\n"
1988 ";;; in Emacs version " emacs-version "\n"
1991 ((eq optimize 'source) " source-level optimization only")
1992 ((eq optimize 'byte) " byte-level optimization only")
1993 (optimize " all optimizations")
1994 (t "out optimization"))
1996 (if dynamic ";;; Function definitions are lazy-loaded.\n"
1998 "\n;;; This file uses "
1999 (if dynamic-docstrings
2000 "dynamic docstrings, first added in Emacs 19.29"
2001 "opcodes that do not exist in Emacs 18")
2003 ;; Note that byte-compile-fix-header may change this.
2004 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2005 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2006 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2007 ;; can delete them so as to keep the buffer positions
2008 ;; constant for the actual compiled code.
2009 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2010 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
2012 (defun byte-compile-output-file-form (form)
2013 ;; Write the given form to the output buffer, being careful of docstrings
2014 ;; in defvar, defvaralias, defconst, autoload and
2015 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2016 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2017 ;; it does not pay to first build the defalias in defmumble and then parse
2019 (let ((print-escape-newlines t)
2024 (print-circle ; Handle circular data structures.
2025 (not byte-compile-disable-print-circle)))
2026 (if (and (memq (car-safe form) '(defvar defvaralias defconst
2027 autoload custom-declare-variable))
2028 (stringp (nth 3 form)))
2029 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
2031 '(defvaralias autoload
2032 custom-declare-variable)))
2033 (princ "\n" byte-compile--outbuffer)
2034 (prin1 form byte-compile--outbuffer)
2037 (defvar byte-compile--for-effect)
2039 (defun byte-compile-output-docform (preface name info form specindex quoted)
2040 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2041 If PREFACE and NAME are non-nil, print them too,
2042 before INFO and the FORM but after the doc string itself.
2043 If SPECINDEX is non-nil, it is the index in FORM
2044 of the function bytecode string. In that case,
2045 we output that argument and the following argument
2046 \(the constants vector) together, for lazy loading.
2047 QUOTED says that we have to put a quote before the
2048 list that represents a doc string reference.
2049 `defvaralias', `autoload' and `custom-declare-variable' need that."
2050 ;; We need to examine byte-compile-dynamic-docstrings
2051 ;; in the input buffer (now current), not in the output buffer.
2052 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2053 (with-current-buffer byte-compile--outbuffer
2056 ;; Insert the doc string, and make it a comment with #@LENGTH.
2057 (and (>= (nth 1 info) 0)
2060 ;; Make the doc string start at beginning of line
2061 ;; for make-docfile's sake.
2064 (byte-compile-output-as-comment
2065 (nth (nth 1 info) form) nil))
2066 ;; If the doc string starts with * (a user variable),
2068 (if (and (stringp (nth (nth 1 info) form))
2069 (> (length (nth (nth 1 info) form)) 0)
2070 (eq (aref (nth (nth 1 info) form) 0) ?*))
2071 (setq position (- position)))))
2076 (prin1 name byte-compile--outbuffer)))
2078 (let ((print-continuous-numbering t)
2081 ;; FIXME: The bindings below are only needed for when we're
2082 ;; called from ...-defmumble.
2083 (print-escape-newlines t)
2088 (print-circle ; Handle circular data structures.
2089 (not byte-compile-disable-print-circle)))
2090 (prin1 (car form) byte-compile--outbuffer)
2091 (while (setq form (cdr form))
2092 (setq index (1+ index))
2094 (cond ((and (numberp specindex) (= index specindex)
2095 ;; Don't handle the definition dynamically
2096 ;; if it refers (or might refer)
2097 ;; to objects already output
2098 ;; (for instance, gensyms in the arg list).
2100 (when (hash-table-p print-number-table)
2101 (maphash (lambda (_k v) (if v (setq non-nil t)))
2102 print-number-table))
2104 ;; Output the byte code and constants specially
2105 ;; for lazy dynamic loading.
2107 (byte-compile-output-as-comment
2108 (cons (car form) (nth 1 form))
2110 (princ (format "(#$ . %d) nil" position)
2111 byte-compile--outbuffer)
2112 (setq form (cdr form))
2113 (setq index (1+ index))))
2114 ((= index (nth 1 info))
2116 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2118 byte-compile--outbuffer)
2119 (let ((print-escape-newlines nil))
2120 (goto-char (prog1 (1+ (point))
2122 byte-compile--outbuffer)))
2124 (goto-char (point-max)))))
2126 (prin1 (car form) byte-compile--outbuffer)))))
2127 (insert (nth 2 info)))))
2130 (defun byte-compile-keep-pending (form &optional handler)
2131 (if (memq byte-optimize '(t source))
2132 (setq form (byte-optimize-form form t)))
2134 (let ((byte-compile--for-effect t))
2135 ;; To avoid consing up monstrously large forms at load time, we split
2136 ;; the output regularly.
2137 (and (memq (car-safe form) '(fset defalias))
2138 (nthcdr 300 byte-compile-output)
2139 (byte-compile-flush-pending))
2140 (funcall handler form)
2141 (if byte-compile--for-effect
2142 (byte-compile-discard)))
2143 (byte-compile-form form t))
2146 (defun byte-compile-flush-pending ()
2147 (if byte-compile-output
2148 (let ((form (byte-compile-out-toplevel t 'file)))
2149 (cond ((eq (car-safe form) 'progn)
2150 (mapc 'byte-compile-output-file-form (cdr form)))
2152 (byte-compile-output-file-form form)))
2153 (setq byte-compile-constants nil
2154 byte-compile-variables nil
2155 byte-compile-depth 0
2156 byte-compile-maxdepth 0
2157 byte-compile-output nil))))
2159 (defun byte-compile-preprocess (form &optional _for-effect)
2160 (setq form (macroexpand-all form byte-compile-macro-environment))
2161 ;; FIXME: We should run byte-optimize-form here, but it currently does not
2162 ;; recurse through all the code, so we'd have to fix this first.
2163 ;; Maybe a good fix would be to merge byte-optimize-form into
2165 ;; (if (memq byte-optimize '(t source))
2166 ;; (setq form (byte-optimize-form form for-effect)))
2168 (cconv-closure-convert form)
2171 ;; byte-hunk-handlers cannot call this!
2172 (defun byte-compile-toplevel-file-form (form)
2173 (let ((byte-compile-current-form nil)) ; close over this for warnings.
2174 (byte-compile-file-form (byte-compile-preprocess form t))))
2176 ;; byte-hunk-handlers can call this.
2177 (defun byte-compile-file-form (form)
2179 (cond ((and (consp form)
2180 (symbolp (car form))
2181 (setq handler (get (car form) 'byte-hunk-handler)))
2182 (cond ((setq form (funcall handler form))
2183 (byte-compile-flush-pending)
2184 (byte-compile-output-file-form form))))
2186 (byte-compile-keep-pending form)))))
2188 ;; Functions and variables with doc strings must be output separately,
2189 ;; so make-docfile can recognize them. Most other things can be output
2192 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2193 (defun byte-compile-file-form-autoload (form)
2194 (and (let ((form form))
2195 (while (if (setq form (cdr form)) (macroexp-const-p (car form))))
2196 (null form)) ;Constants only
2197 (eval (nth 5 form)) ;Macro
2198 (eval form)) ;Define the autoload.
2199 ;; Avoid undefined function warnings for the autoload.
2200 (when (and (consp (nth 1 form))
2201 (eq (car (nth 1 form)) 'quote)
2202 (consp (cdr (nth 1 form)))
2203 (symbolp (nth 1 (nth 1 form))))
2204 (push (cons (nth 1 (nth 1 form))
2205 (cons 'autoload (cdr (cdr form))))
2206 byte-compile-function-environment)
2207 ;; If an autoload occurs _before_ the first call to a function,
2208 ;; byte-compile-callargs-warn does not add an entry to
2209 ;; byte-compile-unresolved-functions. Here we mimic the logic
2210 ;; of byte-compile-callargs-warn so as not to warn if the
2211 ;; autoload comes _after_ the function call.
2212 ;; Alternatively, similar logic could go in
2213 ;; byte-compile-warn-about-unresolved-functions.
2214 (or (memq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2215 (setq byte-compile-unresolved-functions
2216 (delq (assq (nth 1 (nth 1 form))
2217 byte-compile-unresolved-functions)
2218 byte-compile-unresolved-functions))))
2219 (if (stringp (nth 3 form))
2221 ;; No doc string, so we can compile this as a normal form.
2222 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2224 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2225 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2226 (defun byte-compile-file-form-defvar (form)
2227 (when (and (symbolp (nth 1 form))
2228 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
2229 (byte-compile-warning-enabled-p 'lexical))
2230 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
2232 (push (nth 1 form) byte-compile-bound-variables)
2233 (if (eq (car form) 'defconst)
2234 (push (nth 1 form) byte-compile-const-variables))
2235 (if (and (null (cddr form)) ;No `value' provided.
2236 (eq (car form) 'defvar)) ;Just a declaration.
2238 (cond ((consp (nth 2 form))
2239 (setq form (copy-sequence form))
2240 (setcar (cdr (cdr form))
2241 (byte-compile-top-level (nth 2 form) nil 'file))))
2244 (put 'define-abbrev-table 'byte-hunk-handler
2245 'byte-compile-file-form-define-abbrev-table)
2246 (defun byte-compile-file-form-define-abbrev-table (form)
2247 (if (eq 'quote (car-safe (car-safe (cdr form))))
2248 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
2249 (byte-compile-keep-pending form))
2251 (put 'custom-declare-variable 'byte-hunk-handler
2252 'byte-compile-file-form-custom-declare-variable)
2253 (defun byte-compile-file-form-custom-declare-variable (form)
2254 (when (byte-compile-warning-enabled-p 'callargs)
2255 (byte-compile-nogroup-warn form))
2256 (push (nth 1 (nth 1 form)) byte-compile-bound-variables)
2257 (byte-compile-keep-pending form))
2259 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2260 (defun byte-compile-file-form-require (form)
2261 (let ((args (mapcar 'eval (cdr form)))
2262 (hist-orig load-history)
2264 (apply 'require args)
2265 (when (byte-compile-warning-enabled-p 'cl-functions)
2266 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2267 (if (member (car args) '("cl" cl))
2269 (byte-compile-warn "cl package required at runtime")
2270 (byte-compile-disable-warning 'cl-functions))
2271 ;; We may have required something that causes cl to be loaded, eg
2272 ;; the uncompiled version of a file that requires cl when compiling.
2273 (setq hist-new load-history)
2274 (while (and (not byte-compile-cl-functions)
2275 hist-new (not (eq hist-new hist-orig)))
2276 (and (byte-compile-cl-file-p (car (pop hist-new)))
2277 (byte-compile-find-cl-functions))))))
2278 (byte-compile-keep-pending form 'byte-compile-normal-call))
2280 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2281 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2282 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2283 (defun byte-compile-file-form-progn (form)
2284 (mapc 'byte-compile-file-form (cdr form))
2285 ;; Return nil so the forms are not output twice.
2288 (put 'with-no-warnings 'byte-hunk-handler
2289 'byte-compile-file-form-with-no-warnings)
2290 (defun byte-compile-file-form-with-no-warnings (form)
2291 ;; cf byte-compile-file-form-progn.
2292 (let (byte-compile-warnings)
2293 (mapc 'byte-compile-file-form (cdr form))
2296 ;; This handler is not necessary, but it makes the output from dont-compile
2297 ;; and similar macros cleaner.
2298 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2299 (defun byte-compile-file-form-eval (form)
2300 (if (eq (car-safe (nth 1 form)) 'quote)
2301 (nth 1 (nth 1 form))
2302 (byte-compile-keep-pending form)))
2304 (defun byte-compile-file-form-defmumble (name macro arglist body rest)
2305 "Process a `defalias' for NAME.
2306 If MACRO is non-nil, the definition is known to be a macro.
2307 ARGLIST is the list of arguments, if it was recognized or t otherwise.
2308 BODY of the definition, or t if not recognized.
2309 Return non-nil if everything went as planned, or nil to imply that it decided
2310 not to take responsibility for the actual compilation of the code."
2311 (let* ((this-kind (if macro 'byte-compile-macro-environment
2312 'byte-compile-function-environment))
2313 (that-kind (if macro 'byte-compile-function-environment
2314 'byte-compile-macro-environment))
2315 (this-one (assq name (symbol-value this-kind)))
2316 (that-one (assq name (symbol-value that-kind)))
2317 (byte-compile-current-form name)) ; For warnings.
2319 (byte-compile-set-symbol-position name)
2320 ;; When a function or macro is defined, add it to the call tree so that
2321 ;; we can tell when functions are not used.
2322 (if byte-compile-generate-call-tree
2323 (or (assq name byte-compile-call-tree)
2324 (setq byte-compile-call-tree
2325 (cons (list name nil nil) byte-compile-call-tree))))
2327 (if (byte-compile-warning-enabled-p 'redefine)
2328 (byte-compile-arglist-warn name arglist macro))
2330 (if byte-compile-verbose
2331 (message "Compiling %s... (%s)"
2332 (or byte-compile-current-file "") name))
2333 (cond ((not (or macro (listp body)))
2334 ;; We do not know positively if the definition is a macro
2335 ;; or a function, so we shouldn't emit warnings.
2336 ;; This also silences "multiple definition" warnings for defmethods.
2339 (if (and (byte-compile-warning-enabled-p 'redefine)
2340 ;; Don't warn when compiling the stubs in byte-run...
2341 (not (assq name byte-compile-initial-macro-environment)))
2343 "`%s' defined multiple times, as both function and macro"
2345 (setcdr that-one nil))
2347 (when (and (byte-compile-warning-enabled-p 'redefine)
2348 ;; Hack: Don't warn when compiling the magic internal
2349 ;; byte-compiler macros in byte-run.el...
2350 (not (assq name byte-compile-initial-macro-environment)))
2351 (byte-compile-warn "%s `%s' defined multiple times in this file"
2352 (if macro "macro" "function")
2354 ((and (fboundp name)
2355 (eq (car-safe (symbol-function name))
2356 (if macro 'lambda 'macro)))
2357 (when (byte-compile-warning-enabled-p 'redefine)
2358 (byte-compile-warn "%s `%s' being redefined as a %s"
2359 (if macro "function" "macro")
2361 (if macro "macro" "function")))
2362 ;; Shadow existing definition.
2364 (cons (cons name nil)
2365 (symbol-value this-kind))))
2368 (when (and (listp body)
2369 (stringp (car body))
2370 (symbolp (car-safe (cdr-safe body)))
2371 (car-safe (cdr-safe body))
2372 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2373 ;; FIXME: We've done that already just above, so this looks wrong!
2374 ;;(byte-compile-set-symbol-position name)
2375 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2378 (if (not (listp body))
2379 ;; The precise definition requires evaluation to find out, so it
2380 ;; will only be known at runtime.
2381 ;; For a macro, that means we can't use that macro in the same file.
2384 (push (cons name (if (listp arglist) `(declared ,arglist) t))
2385 byte-compile-function-environment))
2386 ;; Tell the caller that we didn't compile it yet.
2389 (let* ((code (byte-compile-lambda (cons arglist body) t)))
2391 ;; A definition in b-c-initial-m-e should always take precedence
2392 ;; during compilation, so don't let it be redefined. (Bug#8647)
2394 (assq name byte-compile-initial-macro-environment))
2395 (setcdr this-one code))
2397 (cons (cons name code)
2398 (symbol-value this-kind))))
2401 ;; There are additional args to `defalias' (like maybe a docstring)
2402 ;; that the code below can't handle: punt!
2404 ;; Otherwise, we have a bona-fide defun/defmacro definition, and use
2405 ;; special code to allow dynamic docstrings and byte-code.
2406 (byte-compile-flush-pending)
2408 ;; If there's no doc string, provide -1 as the "doc string
2409 ;; index" so that no element will be treated as a doc string.
2410 (if (not (stringp (car body))) -1 4)))
2411 ;; Output the form by hand, that's much simpler than having
2412 ;; b-c-output-file-form analyze the defalias.
2413 (byte-compile-output-docform
2416 (if macro `(" '(macro . #[" ,index "])") `(" #[" ,index "]"))
2417 (append code nil) ; Turn byte-code-function-p into list.
2418 (and (atom code) byte-compile-dynamic
2421 (princ ")" byte-compile--outbuffer)
2424 (defun byte-compile-output-as-comment (exp quoted)
2425 "Print Lisp object EXP in the output file, inside a comment,
2426 and return the file (byte) position it will have.
2427 If QUOTED is non-nil, print with quoting; otherwise, print without quoting."
2428 (with-current-buffer byte-compile--outbuffer
2429 (let ((position (point)))
2431 ;; Insert EXP, and make it a comment with #@LENGTH.
2434 (prin1 exp byte-compile--outbuffer)
2435 (princ exp byte-compile--outbuffer))
2436 (goto-char position)
2437 ;; Quote certain special characters as needed.
2438 ;; get_doc_string in doc.c does the unquoting.
2439 (while (search-forward "\^A" nil t)
2440 (replace-match "\^A\^A" t t))
2441 (goto-char position)
2442 (while (search-forward "\000" nil t)
2443 (replace-match "\^A0" t t))
2444 (goto-char position)
2445 (while (search-forward "\037" nil t)
2446 (replace-match "\^A_" t t))
2447 (goto-char (point-max))
2449 (goto-char position)
2450 (insert "#@" (format "%d" (- (position-bytes (point-max))
2451 (position-bytes position))))
2453 ;; Save the file position of the object.
2454 ;; Note we add 1 to skip the space that we inserted before the actual doc
2455 ;; string, and subtract point-min to convert from an 1-origin Emacs
2456 ;; position to a file position.
2458 (- (position-bytes (point)) (point-min) -1)
2459 (goto-char (point-max))))))
2461 (defun byte-compile--reify-function (fun)
2462 "Return an expression which will evaluate to a function value FUN.
2463 FUN should be either a `lambda' value or a `closure' value."
2464 (pcase-let* (((or (and `(lambda ,args . ,body) (let env nil))
2465 `(closure ,env ,args . ,body)) fun)
2467 ;; Turn the function's closed vars (if any) into local let bindings.
2468 (dolist (binding env)
2471 ;; We check shadowing by the args, so that the `let' can be moved
2472 ;; within the lambda, which can then be unfolded. FIXME: Some of those
2473 ;; bindings might be unused in `body'.
2474 (unless (memq (car binding) args) ;Shadowed.
2475 (push `(,(car binding) ',(cdr binding)) renv)))
2477 (t (push `(defvar ,binding) body))))
2479 `(lambda ,args ,@body)
2480 `(lambda ,args (let ,(nreverse renv) ,@body)))))
2483 (defun byte-compile (form)
2484 "If FORM is a symbol, byte-compile its function definition.
2485 If FORM is a lambda or a macro, byte-compile it as a function."
2486 (displaying-byte-compile-warnings
2487 (byte-compile-close-variables
2488 (let* ((lexical-binding lexical-binding)
2489 (fun (if (symbolp form)
2490 (and (fboundp form) (symbol-function form))
2492 (macro (eq (car-safe fun) 'macro)))
2494 (setq fun (cdr fun)))
2496 ;; Up until Emacs-24.1, byte-compile silently did nothing when asked to
2497 ;; compile something invalid. So let's tune down the complaint from an
2498 ;; error to a simple message for the known case where signaling an error
2500 ((byte-code-function-p fun)
2501 (message "Function %s is already compiled"
2502 (if (symbolp form) form "provided"))
2505 (when (symbolp form)
2506 (unless (memq (car-safe fun) '(closure lambda))
2507 (error "Don't know how to compile %S" fun))
2508 (setq fun (byte-compile--reify-function fun))
2509 (setq lexical-binding (eq (car fun) 'closure)))
2510 (unless (eq (car-safe fun) 'lambda)
2511 (error "Don't know how to compile %S" fun))
2513 (setq fun (byte-compile-preprocess fun))
2514 ;; Get rid of the `function' quote added by the `lambda' macro.
2515 (if (eq (car-safe fun) 'function) (setq fun (cadr fun)))
2516 (setq fun (byte-compile-lambda fun))
2517 (if macro (push 'macro fun))
2522 (defun byte-compile-sexp (sexp)
2523 "Compile and return SEXP."
2524 (displaying-byte-compile-warnings
2525 (byte-compile-close-variables
2526 (byte-compile-top-level (byte-compile-preprocess sexp)))))
2528 (defun byte-compile-check-lambda-list (list)
2529 "Check lambda-list LIST for errors."
2532 (let ((arg (car list)))
2534 (byte-compile-set-symbol-position arg))
2535 (cond ((or (not (symbolp arg))
2536 (macroexp--const-symbol-p arg t))
2537 (error "Invalid lambda variable %s" arg))
2540 (error "&rest without variable name"))
2542 (error "Garbage following &rest VAR in lambda-list")))
2543 ((eq arg '&optional)
2545 (error "Variable name missing after &optional")))
2547 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2550 (setq list (cdr list)))))
2553 (defun byte-compile-arglist-vars (arglist)
2554 "Return a list of the variables in the lambda argument list ARGLIST."
2555 (remq '&rest (remq '&optional arglist)))
2557 (defun byte-compile-make-lambda-lexenv (form)
2558 "Return a new lexical environment for a lambda expression FORM."
2559 ;; See if this is a closure or not
2560 (let ((args (byte-compile-arglist-vars (cadr form))))
2562 ;; Fill in the initial stack contents
2564 ;; Add entries for each argument
2566 (push (cons arg stackpos) lexenv)
2567 (setq stackpos (1+ stackpos)))
2568 ;; Return the new lexical environment
2571 (defun byte-compile-make-args-desc (arglist)
2574 (while (and arglist (not (memq (car arglist) '(&optional &rest))))
2575 (setq mandatory (1+ mandatory))
2576 (setq arglist (cdr arglist)))
2577 (setq nonrest mandatory)
2578 (when (eq (car arglist) '&optional)
2579 (setq arglist (cdr arglist))
2580 (while (and arglist (not (eq (car arglist) '&rest)))
2581 (setq nonrest (1+ nonrest))
2582 (setq arglist (cdr arglist))))
2585 (if (> mandatory 127)
2586 (byte-compile-report-error "Too many (>127) mandatory arguments")
2592 (defun byte-compile-lambda (fun &optional add-lambda reserved-csts)
2593 "Byte-compile a lambda-expression and return a valid function.
2594 The value is usually a compiled function but may be the original
2596 When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2597 of the list FUN and `byte-compile-set-symbol-position' is not called.
2598 Use this feature to avoid calling `byte-compile-set-symbol-position'
2599 for symbols generated by the byte compiler itself."
2601 (setq fun (cons 'lambda fun))
2602 (unless (eq 'lambda (car-safe fun))
2603 (error "Not a lambda list: %S" fun))
2604 (byte-compile-set-symbol-position 'lambda))
2605 (byte-compile-check-lambda-list (nth 1 fun))
2606 (let* ((arglist (nth 1 fun))
2607 (byte-compile-bound-variables
2608 (append (and (not lexical-binding)
2609 (byte-compile-arglist-vars arglist))
2610 byte-compile-bound-variables))
2611 (body (cdr (cdr fun)))
2612 (doc (if (stringp (car body))
2614 ;; Discard the doc string
2615 ;; unless it is the last element of the body.
2617 (setq body (cdr body))))))
2618 (int (assq 'interactive body)))
2619 ;; Process the interactive spec.
2621 (byte-compile-set-symbol-position 'interactive)
2622 ;; Skip (interactive) if it is in front (the most usual location).
2623 (if (eq int (car body))
2624 (setq body (cdr body)))
2625 (cond ((consp (cdr int))
2627 (byte-compile-warn "malformed interactive spec: %s"
2628 (prin1-to-string int)))
2629 ;; If the interactive spec is a call to `list', don't
2630 ;; compile it, because `call-interactively' looks at the
2631 ;; args of `list'. Actually, compile it to get warnings,
2632 ;; but don't use the result.
2633 (let* ((form (nth 1 int))
2634 (newform (byte-compile-top-level form)))
2635 (while (memq (car-safe form) '(let let* progn save-excursion))
2636 (while (consp (cdr form))
2637 (setq form (cdr form)))
2638 (setq form (car form)))
2639 (if (and (eq (car-safe form) 'list)
2640 ;; The spec is evalled in callint.c in dynamic-scoping
2641 ;; mode, so just leaving the form unchanged would mean
2642 ;; it won't be eval'd in the right mode.
2643 (not lexical-binding))
2645 (setq int `(interactive ,newform)))))
2647 (byte-compile-warn "malformed interactive spec: %s"
2648 (prin1-to-string int)))))
2649 ;; Process the body.
2651 (byte-compile-top-level (cons 'progn body) nil 'lambda
2652 ;; If doing lexical binding, push a new
2653 ;; lexical environment containing just the
2654 ;; args (since lambda expressions should be
2656 (and lexical-binding
2657 (byte-compile-make-lambda-lexenv fun))
2659 ;; Build the actual byte-coded function.
2660 (cl-assert (eq 'byte-code (car-safe compiled)))
2661 (apply #'make-byte-code
2663 (byte-compile-make-args-desc arglist)
2666 ;; byte-string, constants-vector, stack depth
2668 ;; optionally, the doc string.
2669 (cond (lexical-binding
2671 (list (help-add-fundoc-usage doc arglist)))
2674 ;; optionally, the interactive spec.
2676 (list (nth 1 int))))))))
2678 (defvar byte-compile-reserved-constants 0)
2680 (defun byte-compile-constants-vector ()
2681 ;; Builds the constants-vector from the current variables and constants.
2682 ;; This modifies the constants from (const . nil) to (const . offset).
2683 ;; To keep the byte-codes to look up the vector as short as possible:
2684 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2685 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2686 ;; Next variables again, to get 2-byte codes for variable lookup.
2687 ;; The rest of the constants and variables need 3-byte byte-codes.
2688 (let* ((i (1- byte-compile-reserved-constants))
2689 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2690 (other (nreverse byte-compile-constants)) ; vars often are used most.
2692 (limits '(5 ; Use the 1-byte varref codes,
2693 63 ; 1-constlim ; 1-byte byte-constant codes,
2694 255 ; 2-byte varref codes,
2695 65535 ; 3-byte codes for the rest.
2696 65535)) ; twice since we step when we swap.
2698 (while (or rest other)
2699 (setq limit (car limits))
2700 (while (and rest (< i limit))
2702 ((numberp (car rest))
2703 (cl-assert (< (car rest) byte-compile-reserved-constants)))
2704 ((setq tmp (assq (car (car rest)) ret))
2705 (setcdr (car rest) (cdr tmp)))
2707 (setcdr (car rest) (setq i (1+ i)))
2708 (setq ret (cons (car rest) ret))))
2709 (setq rest (cdr rest)))
2710 (setq limits (cdr limits) ;Step
2711 rest (prog1 other ;&Swap.
2712 (setq other rest))))
2713 (apply 'vector (nreverse (mapcar 'car ret)))))
2715 ;; Given an expression FORM, compile it and return an equivalent byte-code
2716 ;; expression (a call to the function byte-code).
2717 (defun byte-compile-top-level (form &optional for-effect output-type
2718 lexenv reserved-csts)
2719 ;; OUTPUT-TYPE advises about how form is expected to be used:
2720 ;; 'eval or nil -> a single form,
2721 ;; 'progn or t -> a list of forms,
2722 ;; 'lambda -> body of a lambda,
2723 ;; 'file -> used at file-level.
2724 (let ((byte-compile--for-effect for-effect)
2725 (byte-compile-constants nil)
2726 (byte-compile-variables nil)
2727 (byte-compile-tag-number 0)
2728 (byte-compile-depth 0)
2729 (byte-compile-maxdepth 0)
2730 (byte-compile--lexical-environment lexenv)
2731 (byte-compile-reserved-constants (or reserved-csts 0))
2732 (byte-compile-output nil))
2733 (if (memq byte-optimize '(t source))
2734 (setq form (byte-optimize-form form byte-compile--for-effect)))
2735 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2736 (setq form (nth 1 form)))
2737 ;; Set up things for a lexically-bound function.
2738 (when (and lexical-binding (eq output-type 'lambda))
2739 ;; See how many arguments there are, and set the current stack depth
2741 (setq byte-compile-depth (length byte-compile--lexical-environment))
2742 ;; If there are args, output a tag to record the initial
2743 ;; stack-depth for the optimizer.
2744 (when (> byte-compile-depth 0)
2745 (byte-compile-out-tag (byte-compile-make-tag))))
2747 (byte-compile-form form byte-compile--for-effect)
2748 (byte-compile-out-toplevel byte-compile--for-effect output-type)))
2750 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2752 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2753 (if (eq (car (car byte-compile-output)) 'byte-discard)
2754 (setq byte-compile-output (cdr byte-compile-output))
2755 (byte-compile-push-constant
2756 ;; Push any constant - preferably one which already is used, and
2757 ;; a number or symbol - ie not some big sequence. The return value
2758 ;; isn't returned, but it would be a shame if some textually large
2759 ;; constant was not optimized away because we chose to return it.
2760 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2761 (let ((tmp (reverse byte-compile-constants)))
2762 (while (and tmp (not (or (symbolp (caar tmp))
2763 (numberp (caar tmp)))))
2764 (setq tmp (cdr tmp)))
2766 (byte-compile-out 'byte-return 0)
2767 (setq byte-compile-output (nreverse byte-compile-output))
2768 (if (memq byte-optimize '(t byte))
2769 (setq byte-compile-output
2770 (byte-optimize-lapcode byte-compile-output)))
2772 ;; Decompile trivial functions:
2773 ;; only constants and variables, or a single funcall except in lambdas.
2774 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2775 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2776 ;; Note that even (quote foo) must be parsed just as any subr by the
2777 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2778 ;; What to leave uncompiled:
2779 ;; lambda -> never. we used to leave it uncompiled if the body was
2780 ;; a single atom, but that causes confusion if the docstring
2781 ;; uses the (file . pos) syntax. Besides, now that we have
2782 ;; the Lisp_Compiled type, the compiled form is faster.
2783 ;; eval -> atom, quote or (function atom atom atom)
2784 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2785 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2787 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2790 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2791 ((or (eq output-type 'lambda)
2792 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2793 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2794 (not (setq tmp (assq 'byte-return byte-compile-output)))
2796 (setq rest (nreverse
2797 (cdr (memq tmp (reverse byte-compile-output)))))
2800 ((memq (car (car rest)) '(byte-varref byte-constant))
2801 (setq tmp (car (cdr (car rest))))
2802 (if (if (eq (car (car rest)) 'byte-constant)
2805 (not (macroexp--const-symbol-p tmp)))))
2807 (setq body (cons (list 'quote tmp) body)))
2808 (setq body (cons tmp body))))
2810 ;; Allow a funcall if at most one atom follows it.
2811 (null (nthcdr 3 rest))
2812 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2813 (or (null (cdr rest))
2814 (and (memq output-type '(file progn t))
2816 (eq (car (nth 1 rest)) 'byte-discard)
2817 (progn (setq rest (cdr rest)) t))))
2818 (setq maycall nil) ; Only allow one real function call.
2819 (setq body (nreverse body))
2821 (if (and (eq tmp 'funcall)
2822 (eq (car-safe (car body)) 'quote))
2823 (cons (nth 1 (car body)) (cdr body))
2825 (or (eq output-type 'file)
2826 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2827 (setq rest (cdr rest)))
2829 (let ((byte-compile-vector (byte-compile-constants-vector)))
2830 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2831 byte-compile-vector byte-compile-maxdepth)))
2832 ;; it's a trivial function
2833 ((cdr body) (cons 'progn (nreverse body)))
2836 ;; Given BODY, compile it and return a new body.
2837 (defun byte-compile-top-level-body (body &optional for-effect)
2839 (byte-compile-top-level (cons 'progn body) for-effect t))
2840 (cond ((eq (car-safe body) 'progn)
2845 ;; Special macro-expander used during byte-compilation.
2846 (defun byte-compile-macroexpand-declare-function (fn file &rest args)
2848 (if (and (consp args) (listp (car args)))
2849 (list 'declared (car args))
2850 t)) ; Arglist not specified.
2851 byte-compile-function-environment)
2852 ;; We are stating that it _will_ be defined at runtime.
2853 (setq byte-compile-noruntime-functions
2854 (delq fn byte-compile-noruntime-functions))
2855 ;; Delegate the rest to the normal macro definition.
2856 (macroexpand `(declare-function ,fn ,file ,@args)))
2859 ;; This is the recursive entry point for compiling each subform of an
2861 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2862 ;; before terminating (ie no value will be left on the stack).
2863 ;; A byte-compile handler may, when byte-compile--for-effect is non-nil, choose
2864 ;; output code which does not leave a value on the stack, and then set
2865 ;; byte-compile--for-effect to nil (to prevent byte-compile-form from
2866 ;; outputting the byte-discard).
2867 ;; If a handler wants to call another handler, it should do so via
2868 ;; byte-compile-form, or take extreme care to handle byte-compile--for-effect
2869 ;; correctly. (Use byte-compile-form-do-effect to reset the
2870 ;; byte-compile--for-effect flag too.)
2872 (defun byte-compile-form (form &optional for-effect)
2873 (let ((byte-compile--for-effect for-effect))
2876 (cond ((or (not (symbolp form)) (macroexp--const-symbol-p form))
2877 (when (symbolp form)
2878 (byte-compile-set-symbol-position form))
2879 (byte-compile-constant form))
2880 ((and byte-compile--for-effect byte-compile-delete-errors)
2881 (when (symbolp form)
2882 (byte-compile-set-symbol-position form))
2883 (setq byte-compile--for-effect nil))
2885 (byte-compile-variable-ref form))))
2886 ((symbolp (car form))
2887 (let* ((fn (car form))
2888 (handler (get fn 'byte-compile)))
2889 (when (macroexp--const-symbol-p fn)
2890 (byte-compile-warn "`%s' called as a function" fn))
2891 (and (byte-compile-warning-enabled-p 'interactive-only)
2892 (memq fn byte-compile-interactive-only-functions)
2893 (byte-compile-warn "`%s' used from Lisp code\n\
2894 That command is designed for interactive use only" fn))
2895 (if (and (fboundp (car form))
2896 (eq (car-safe (symbol-function (car form))) 'macro))
2897 (byte-compile-log-warning
2898 (format "Forgot to expand macro %s" (car form)) nil :error))
2900 ;; Make sure that function exists.
2901 (and (functionp handler)
2902 ;; Ignore obsolete byte-compile function used by former
2903 ;; CL code to handle compiler macros (we do it
2904 ;; differently now).
2905 (not (eq handler 'cl-byte-compile-compiler-macro))))
2906 (funcall handler form)
2907 (byte-compile-normal-call form))
2908 (if (byte-compile-warning-enabled-p 'cl-functions)
2909 (byte-compile-cl-warn form))))
2910 ((and (byte-code-function-p (car form))
2911 (memq byte-optimize '(t lap)))
2912 (byte-compile-unfold-bcf form))
2913 ((and (eq (car-safe (car form)) 'lambda)
2914 ;; if the form comes out the same way it went in, that's
2915 ;; because it was malformed, and we couldn't unfold it.
2916 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2917 (byte-compile-form form byte-compile--for-effect)
2918 (setq byte-compile--for-effect nil))
2919 ((byte-compile-normal-call form)))
2920 (if byte-compile--for-effect
2921 (byte-compile-discard))))
2923 (defun byte-compile-normal-call (form)
2924 (when (and (byte-compile-warning-enabled-p 'callargs)
2925 (symbolp (car form)))
2926 (if (memq (car form)
2927 '(custom-declare-group custom-declare-variable
2928 custom-declare-face))
2929 (byte-compile-nogroup-warn form))
2930 (when (get (car form) 'byte-obsolete-info)
2931 (byte-compile-warn-obsolete (car form)))
2932 (byte-compile-callargs-warn form))
2933 (if byte-compile-generate-call-tree
2934 (byte-compile-annotate-call-tree form))
2935 (when (and byte-compile--for-effect (eq (car form) 'mapcar)
2936 (byte-compile-warning-enabled-p 'mapcar))
2937 (byte-compile-set-symbol-position 'mapcar)
2939 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
2940 (byte-compile-push-constant (car form))
2941 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2942 (byte-compile-out 'byte-call (length (cdr form))))
2945 ;; Splice the given lap code into the current instruction stream.
2946 ;; If it has any labels in it, you're responsible for making sure there
2947 ;; are no collisions, and that byte-compile-tag-number is reasonable
2948 ;; after this is spliced in. The provided list is destroyed.
2949 (defun byte-compile-inline-lapcode (lap end-depth)
2950 ;; "Replay" the operations: we used to just do
2951 ;; (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))
2952 ;; but that fails to update byte-compile-depth, so we had to assume
2953 ;; that `lap' ends up adding exactly 1 element to the stack. This
2954 ;; happens to be true for byte-code generated by bytecomp.el without
2955 ;; lexical-binding, but it's not true in general, and it's not true for
2956 ;; code output by bytecomp.el with lexical-binding.
2957 (let ((endtag (byte-compile-make-tag)))
2960 ((eq (car op) 'TAG) (byte-compile-out-tag op))
2961 ((memq (car op) byte-goto-ops) (byte-compile-goto (car op) (cdr op)))
2962 ((eq (car op) 'byte-return)
2963 (byte-compile-discard (- byte-compile-depth end-depth) t)
2964 (byte-compile-goto 'byte-goto endtag))
2965 (t (byte-compile-out (car op) (cdr op)))))
2966 (byte-compile-out-tag endtag)))
2968 (defun byte-compile-unfold-bcf (form)
2969 "Inline call to byte-code-functions."
2970 (let* ((byte-compile-bound-variables byte-compile-bound-variables)
2972 (fargs (aref fun 0))
2973 (start-depth byte-compile-depth)
2974 (fmax2 (if (numberp fargs) (lsh fargs -7))) ;2*max+rest.
2975 ;; (fmin (if (numberp fargs) (logand fargs 127)))
2976 (alen (length (cdr form)))
2978 (fetch-bytecode fun)
2979 (mapc 'byte-compile-form (cdr form))
2981 ;; Old-style byte-code.
2982 (cl-assert (listp fargs))
2985 (`&optional (setq fargs (cdr fargs)))
2986 (`&rest (setq fmax2 (+ (* 2 (length dynbinds)) 1))
2987 (push (cadr fargs) dynbinds)
2989 (_ (push (pop fargs) dynbinds))))
2990 (unless fmax2 (setq fmax2 (* 2 (length dynbinds)))))
2992 ((<= (+ alen alen) fmax2)
2993 ;; Add missing &optional (or &rest) arguments.
2994 (dotimes (_ (- (/ (1+ fmax2) 2) alen))
2995 (byte-compile-push-constant nil)))
2996 ((zerop (logand fmax2 1))
2997 (byte-compile-log-warning "Too many arguments for inlined function"
2999 (byte-compile-discard (- alen (/ fmax2 2))))
3001 ;; Turn &rest args into a list.
3002 (let ((n (- alen (/ (1- fmax2) 2))))
3003 (cl-assert (> n 0) nil "problem: fmax2=%S alen=%S n=%S" fmax2 alen n)
3006 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- n))
3008 (byte-compile-out 'byte-listN n)))))
3009 (mapc #'byte-compile-dynamic-variable-bind dynbinds)
3010 (byte-compile-inline-lapcode
3011 (byte-decompile-bytecode-1 (aref fun 1) (aref fun 2) t)
3013 ;; Unbind dynamic variables.
3015 (byte-compile-out 'byte-unbind (length dynbinds)))
3016 (cl-assert (eq byte-compile-depth (1+ start-depth))
3017 nil "Wrong depth start=%s end=%s" start-depth byte-compile-depth)))
3019 (defun byte-compile-check-variable (var access-type)
3020 "Do various error checks before a use of the variable VAR."
3022 (byte-compile-set-symbol-position var))
3023 (cond ((or (not (symbolp var)) (macroexp--const-symbol-p var))
3024 (when (byte-compile-warning-enabled-p 'constants)
3025 (byte-compile-warn (if (eq access-type 'let-bind)
3026 "attempt to let-bind %s `%s`"
3027 "variable reference to %s `%s'")
3028 (if (symbolp var) "constant" "nonvariable")
3029 (prin1-to-string var))))
3030 ((let ((od (get var 'byte-obsolete-variable)))
3032 (not (memq var byte-compile-not-obsolete-vars))
3033 (not (memq var byte-compile-global-not-obsolete-vars))
3034 (or (pcase (nth 1 od)
3035 (`set (not (eq access-type 'reference)))
3036 (`get (eq access-type 'reference))
3038 (byte-compile-warn-obsolete var))))
3040 (defsubst byte-compile-dynamic-variable-op (base-op var)
3041 (let ((tmp (assq var byte-compile-variables)))
3043 (setq tmp (list var))
3044 (push tmp byte-compile-variables))
3045 (byte-compile-out base-op tmp)))
3047 (defun byte-compile-dynamic-variable-bind (var)
3048 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3049 (byte-compile-check-variable var 'let-bind)
3050 (push var byte-compile-bound-variables)
3051 (byte-compile-dynamic-variable-op 'byte-varbind var))
3053 (defun byte-compile-variable-ref (var)
3054 "Generate code to push the value of the variable VAR on the stack."
3055 (byte-compile-check-variable var 'reference)
3056 (let ((lex-binding (assq var byte-compile--lexical-environment)))
3058 ;; VAR is lexically bound
3059 (byte-compile-stack-ref (cdr lex-binding))
3060 ;; VAR is dynamically bound
3061 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3063 (memq var byte-compile-bound-variables)
3064 (memq var byte-compile-free-references))
3065 (byte-compile-warn "reference to free variable `%S'" var)
3066 (push var byte-compile-free-references))
3067 (byte-compile-dynamic-variable-op 'byte-varref var))))
3069 (defun byte-compile-variable-set (var)
3070 "Generate code to set the variable VAR from the top-of-stack value."
3071 (byte-compile-check-variable var 'assign)
3072 (let ((lex-binding (assq var byte-compile--lexical-environment)))
3074 ;; VAR is lexically bound.
3075 (byte-compile-stack-set (cdr lex-binding))
3076 ;; VAR is dynamically bound.
3077 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3079 (memq var byte-compile-bound-variables)
3080 (memq var byte-compile-free-assignments))
3081 (byte-compile-warn "assignment to free variable `%s'" var)
3082 (push var byte-compile-free-assignments))
3083 (byte-compile-dynamic-variable-op 'byte-varset var))))
3085 (defmacro byte-compile-get-constant (const)
3086 `(or (if (stringp ,const)
3087 ;; In a string constant, treat properties as significant.
3089 (dolist (elt byte-compile-constants)
3090 (if (equal-including-properties (car elt) ,const)
3093 (assq ,const byte-compile-constants))
3094 (car (setq byte-compile-constants
3095 (cons (list ,const) byte-compile-constants)))))
3097 ;; Use this when the value of a form is a constant.
3098 ;; This obeys byte-compile--for-effect.
3099 (defun byte-compile-constant (const)
3100 (if byte-compile--for-effect
3101 (setq byte-compile--for-effect nil)
3102 (when (symbolp const)
3103 (byte-compile-set-symbol-position const))
3104 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
3106 ;; Use this for a constant that is not the value of its containing form.
3107 ;; This ignores byte-compile--for-effect.
3108 (defun byte-compile-push-constant (const)
3109 (let ((byte-compile--for-effect nil))
3110 (inline (byte-compile-constant const))))
3112 ;; Compile those primitive ordinary functions
3113 ;; which have special byte codes just for speed.
3115 (defmacro byte-defop-compiler (function &optional compile-handler)
3116 "Add a compiler-form for FUNCTION.
3117 If function is a symbol, then the variable \"byte-SYMBOL\" must name
3118 the opcode to be used. If function is a list, the first element
3119 is the function and the second element is the bytecode-symbol.
3120 The second element may be nil, meaning there is no opcode.
3121 COMPILE-HANDLER is the function to use to compile this byte-op, or
3122 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3123 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
3125 (if (symbolp function)
3126 (setq opcode (intern (concat "byte-" (symbol-name function))))
3127 (setq opcode (car (cdr function))
3128 function (car function)))
3130 (list 'put (list 'quote function) ''byte-compile
3132 (or (cdr (assq compile-handler
3133 '((0 . byte-compile-no-args)
3134 (1 . byte-compile-one-arg)
3135 (2 . byte-compile-two-args)
3136 (3 . byte-compile-three-args)
3137 (0-1 . byte-compile-zero-or-one-arg)
3138 (1-2 . byte-compile-one-or-two-args)
3139 (2-3 . byte-compile-two-or-three-args)
3142 (intern (concat "byte-compile-"
3143 (symbol-name function))))))))
3146 (list 'put (list 'quote function)
3147 ''byte-opcode (list 'quote opcode))
3148 (list 'put (list 'quote opcode)
3149 ''byte-opcode-invert (list 'quote function)))
3152 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
3153 (list 'byte-defop-compiler (list function nil) compile-handler))
3156 (put 'byte-call 'byte-opcode-invert 'funcall)
3157 (put 'byte-list1 'byte-opcode-invert 'list)
3158 (put 'byte-list2 'byte-opcode-invert 'list)
3159 (put 'byte-list3 'byte-opcode-invert 'list)
3160 (put 'byte-list4 'byte-opcode-invert 'list)
3161 (put 'byte-listN 'byte-opcode-invert 'list)
3162 (put 'byte-concat2 'byte-opcode-invert 'concat)
3163 (put 'byte-concat3 'byte-opcode-invert 'concat)
3164 (put 'byte-concat4 'byte-opcode-invert 'concat)
3165 (put 'byte-concatN 'byte-opcode-invert 'concat)
3166 (put 'byte-insertN 'byte-opcode-invert 'insert)
3168 (byte-defop-compiler point 0)
3169 ;;(byte-defop-compiler mark 0) ;; obsolete
3170 (byte-defop-compiler point-max 0)
3171 (byte-defop-compiler point-min 0)
3172 (byte-defop-compiler following-char 0)
3173 (byte-defop-compiler preceding-char 0)
3174 (byte-defop-compiler current-column 0)
3175 (byte-defop-compiler eolp 0)
3176 (byte-defop-compiler eobp 0)
3177 (byte-defop-compiler bolp 0)
3178 (byte-defop-compiler bobp 0)
3179 (byte-defop-compiler current-buffer 0)
3180 ;;(byte-defop-compiler read-char 0) ;; obsolete
3181 ;; (byte-defop-compiler interactive-p 0) ;; Obsolete.
3182 (byte-defop-compiler widen 0)
3183 (byte-defop-compiler end-of-line 0-1)
3184 (byte-defop-compiler forward-char 0-1)
3185 (byte-defop-compiler forward-line 0-1)
3186 (byte-defop-compiler symbolp 1)
3187 (byte-defop-compiler consp 1)
3188 (byte-defop-compiler stringp 1)
3189 (byte-defop-compiler listp 1)
3190 (byte-defop-compiler not 1)
3191 (byte-defop-compiler (null byte-not) 1)
3192 (byte-defop-compiler car 1)
3193 (byte-defop-compiler cdr 1)
3194 (byte-defop-compiler length 1)
3195 (byte-defop-compiler symbol-value 1)
3196 (byte-defop-compiler symbol-function 1)
3197 (byte-defop-compiler (1+ byte-add1) 1)
3198 (byte-defop-compiler (1- byte-sub1) 1)
3199 (byte-defop-compiler goto-char 1)
3200 (byte-defop-compiler char-after 0-1)
3201 (byte-defop-compiler set-buffer 1)
3202 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3203 (byte-defop-compiler forward-word 0-1)
3204 (byte-defop-compiler char-syntax 1)
3205 (byte-defop-compiler nreverse 1)
3206 (byte-defop-compiler car-safe 1)
3207 (byte-defop-compiler cdr-safe 1)
3208 (byte-defop-compiler numberp 1)
3209 (byte-defop-compiler integerp 1)
3210 (byte-defop-compiler skip-chars-forward 1-2)
3211 (byte-defop-compiler skip-chars-backward 1-2)
3212 (byte-defop-compiler eq 2)
3213 (byte-defop-compiler memq 2)
3214 (byte-defop-compiler cons 2)
3215 (byte-defop-compiler aref 2)
3216 (byte-defop-compiler set 2)
3217 (byte-defop-compiler (= byte-eqlsign) 2)
3218 (byte-defop-compiler (< byte-lss) 2)
3219 (byte-defop-compiler (> byte-gtr) 2)
3220 (byte-defop-compiler (<= byte-leq) 2)
3221 (byte-defop-compiler (>= byte-geq) 2)
3222 (byte-defop-compiler get 2)
3223 (byte-defop-compiler nth 2)
3224 (byte-defop-compiler substring 2-3)
3225 (byte-defop-compiler (move-marker byte-set-marker) 2-3)
3226 (byte-defop-compiler set-marker 2-3)
3227 (byte-defop-compiler match-beginning 1)
3228 (byte-defop-compiler match-end 1)
3229 (byte-defop-compiler upcase 1)
3230 (byte-defop-compiler downcase 1)
3231 (byte-defop-compiler string= 2)
3232 (byte-defop-compiler string< 2)
3233 (byte-defop-compiler (string-equal byte-string=) 2)
3234 (byte-defop-compiler (string-lessp byte-string<) 2)
3235 (byte-defop-compiler equal 2)
3236 (byte-defop-compiler nthcdr 2)
3237 (byte-defop-compiler elt 2)
3238 (byte-defop-compiler member 2)
3239 (byte-defop-compiler assq 2)
3240 (byte-defop-compiler (rplaca byte-setcar) 2)
3241 (byte-defop-compiler (rplacd byte-setcdr) 2)
3242 (byte-defop-compiler setcar 2)
3243 (byte-defop-compiler setcdr 2)
3244 (byte-defop-compiler buffer-substring 2)
3245 (byte-defop-compiler delete-region 2)
3246 (byte-defop-compiler narrow-to-region 2)
3247 (byte-defop-compiler (% byte-rem) 2)
3248 (byte-defop-compiler aset 3)
3250 (byte-defop-compiler max byte-compile-associative)
3251 (byte-defop-compiler min byte-compile-associative)
3252 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3253 (byte-defop-compiler (* byte-mult) byte-compile-associative)
3255 ;;####(byte-defop-compiler move-to-column 1)
3256 (byte-defop-compiler-1 interactive byte-compile-noop)
3259 (defun byte-compile-subr-wrong-args (form n)
3260 (byte-compile-set-symbol-position (car form))
3261 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3262 (car form) (length (cdr form))
3263 (if (= 1 (length (cdr form))) "" "s") n)
3264 ;; Get run-time wrong-number-of-args error.
3265 (byte-compile-normal-call form))
3267 (defun byte-compile-no-args (form)
3268 (if (not (= (length form) 1))
3269 (byte-compile-subr-wrong-args form "none")
3270 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3272 (defun byte-compile-one-arg (form)
3273 (if (not (= (length form) 2))
3274 (byte-compile-subr-wrong-args form 1)
3275 (byte-compile-form (car (cdr form))) ;; Push the argument
3276 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3278 (defun byte-compile-two-args (form)
3279 (if (not (= (length form) 3))
3280 (byte-compile-subr-wrong-args form 2)
3281 (byte-compile-form (car (cdr form))) ;; Push the arguments
3282 (byte-compile-form (nth 2 form))
3283 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3285 (defun byte-compile-three-args (form)
3286 (if (not (= (length form) 4))
3287 (byte-compile-subr-wrong-args form 3)
3288 (byte-compile-form (car (cdr form))) ;; Push the arguments
3289 (byte-compile-form (nth 2 form))
3290 (byte-compile-form (nth 3 form))
3291 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3293 (defun byte-compile-zero-or-one-arg (form)
3294 (let ((len (length form)))
3295 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3296 ((= len 2) (byte-compile-one-arg form))
3297 (t (byte-compile-subr-wrong-args form "0-1")))))
3299 (defun byte-compile-one-or-two-args (form)
3300 (let ((len (length form)))
3301 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3302 ((= len 3) (byte-compile-two-args form))
3303 (t (byte-compile-subr-wrong-args form "1-2")))))
3305 (defun byte-compile-two-or-three-args (form)
3306 (let ((len (length form)))
3307 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3308 ((= len 4) (byte-compile-three-args form))
3309 (t (byte-compile-subr-wrong-args form "2-3")))))
3311 (defun byte-compile-noop (_form)
3312 (byte-compile-constant nil))
3314 (defun byte-compile-discard (&optional num preserve-tos)
3315 "Output byte codes to discard the NUM entries at the top of the stack.
3317 If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3318 popped before discarding the num values, and then pushed back again after
3320 (if (and (null num) (not preserve-tos))
3322 (byte-compile-out 'byte-discard)
3326 (when (and preserve-tos (> num 0))
3327 ;; Preserve the top-of-stack value by writing it directly to the stack
3328 ;; location which will be at the top-of-stack after popping.
3329 (byte-compile-stack-set (1- (- byte-compile-depth num)))
3330 ;; Now we actually discard one less value, since we want to keep
3332 (setq num (1- num)))
3334 (byte-compile-out 'byte-discard)
3335 (setq num (1- num)))))
3337 (defun byte-compile-stack-ref (stack-pos)
3338 "Output byte codes to push the value at stack position STACK-POS."
3339 (let ((dist (- byte-compile-depth (1+ stack-pos))))
3341 ;; A simple optimization
3342 (byte-compile-out 'byte-dup)
3344 (byte-compile-out 'byte-stack-ref dist))))
3346 (defun byte-compile-stack-set (stack-pos)
3347 "Output byte codes to store the TOS value at stack position STACK-POS."
3348 (byte-compile-out 'byte-stack-set (- byte-compile-depth (1+ stack-pos))))
3350 (byte-defop-compiler-1 internal-make-closure byte-compile-make-closure)
3351 (byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var)
3353 (defun byte-compile-make-closure (form)
3354 "Byte-compile the special `internal-make-closure' form."
3355 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
3356 (let* ((vars (nth 1 form))
3358 (body (nthcdr 3 form))
3360 (byte-compile-lambda `(lambda ,vars . ,body) nil (length env))))
3361 (cl-assert (> (length env) 0)) ;Otherwise, we don't need a closure.
3362 (cl-assert (byte-code-function-p fun))
3363 (byte-compile-form `(make-byte-code
3364 ',(aref fun 0) ',(aref fun 1)
3365 (vconcat (vector . ,env) ',(aref fun 2))
3366 ,@(nthcdr 3 (mapcar (lambda (x) `',x) fun)))))))
3368 (defun byte-compile-get-closed-var (form)
3369 "Byte-compile the special `internal-get-closed-var' form."
3370 (if byte-compile--for-effect (setq byte-compile--for-effect nil)
3371 (byte-compile-out 'byte-constant (nth 1 form))))
3373 ;; Compile a function that accepts one or more args and is right-associative.
3374 ;; We do it by left-associativity so that the operations
3375 ;; are done in the same order as in interpreted code.
3376 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3377 ;; in order to convert markers to numbers, and trigger expected errors.
3378 (defun byte-compile-associative (form)
3380 (let ((opcode (get (car form) 'byte-opcode))
3382 (if (and (< 3 (length form))
3383 (memq opcode (list (get '+ 'byte-opcode)
3384 (get '* 'byte-opcode))))
3385 ;; Don't use binary operations for > 2 operands, as that
3386 ;; may cause overflow/truncation in float operations.
3387 (byte-compile-normal-call form)
3388 (setq args (copy-sequence (cdr form)))
3389 (byte-compile-form (car args))
3390 (setq args (cdr args))
3391 (or args (setq args '(0)
3392 opcode (get '+ 'byte-opcode)))
3394 (byte-compile-form arg)
3395 (byte-compile-out opcode 0))))
3396 (byte-compile-constant (eval form))))
3399 ;; more complicated compiler macros
3401 (byte-defop-compiler char-before)
3402 (byte-defop-compiler backward-char)
3403 (byte-defop-compiler backward-word)
3404 (byte-defop-compiler list)
3405 (byte-defop-compiler concat)
3406 (byte-defop-compiler fset)
3407 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3408 (byte-defop-compiler indent-to)
3409 (byte-defop-compiler insert)
3410 (byte-defop-compiler-1 function byte-compile-function-form)
3411 (byte-defop-compiler-1 - byte-compile-minus)
3412 (byte-defop-compiler (/ byte-quo) byte-compile-quo)
3413 (byte-defop-compiler nconc)
3415 (defun byte-compile-char-before (form)
3416 (cond ((= 2 (length form))
3417 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3419 `(1- ,(nth 1 form))))))
3420 ((= 1 (length form))
3421 (byte-compile-form '(char-after (1- (point)))))
3422 (t (byte-compile-subr-wrong-args form "0-1"))))
3424 ;; backward-... ==> forward-... with negated argument.
3425 (defun byte-compile-backward-char (form)
3426 (cond ((= 2 (length form))
3427 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3429 `(- ,(nth 1 form))))))
3430 ((= 1 (length form))
3431 (byte-compile-form '(forward-char -1)))
3432 (t (byte-compile-subr-wrong-args form "0-1"))))
3434 (defun byte-compile-backward-word (form)
3435 (cond ((= 2 (length form))
3436 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3438 `(- ,(nth 1 form))))))
3439 ((= 1 (length form))
3440 (byte-compile-form '(forward-word -1)))
3441 (t (byte-compile-subr-wrong-args form "0-1"))))
3443 (defun byte-compile-list (form)
3444 (let ((count (length (cdr form))))
3446 (byte-compile-constant nil))
3448 (mapc 'byte-compile-form (cdr form))
3450 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3452 (mapc 'byte-compile-form (cdr form))
3453 (byte-compile-out 'byte-listN count))
3454 (t (byte-compile-normal-call form)))))
3456 (defun byte-compile-concat (form)
3457 (let ((count (length (cdr form))))
3458 (cond ((and (< 1 count) (< count 5))
3459 (mapc 'byte-compile-form (cdr form))
3461 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3463 ;; Concat of one arg is not a no-op if arg is not a string.
3465 (byte-compile-form ""))
3467 (mapc 'byte-compile-form (cdr form))
3468 (byte-compile-out 'byte-concatN count))
3469 ((byte-compile-normal-call form)))))
3471 (defun byte-compile-minus (form)
3472 (let ((len (length form)))
3474 ((= 1 len) (byte-compile-constant 0))
3476 (byte-compile-form (cadr form))
3477 (byte-compile-out 'byte-negate 0))
3479 (byte-compile-form (nth 1 form))
3480 (byte-compile-form (nth 2 form))
3481 (byte-compile-out 'byte-diff 0))
3482 ;; Don't use binary operations for > 2 operands, as that may
3483 ;; cause overflow/truncation in float operations.
3484 (t (byte-compile-normal-call form)))))
3486 (defun byte-compile-quo (form)
3487 (let ((len (length form)))
3489 (byte-compile-subr-wrong-args form "2 or more"))
3491 (byte-compile-two-args form))
3493 ;; Don't use binary operations for > 2 operands, as that
3494 ;; may cause overflow/truncation in float operations.
3495 (byte-compile-normal-call form)))))
3497 (defun byte-compile-nconc (form)
3498 (let ((len (length form)))
3500 (byte-compile-constant nil))
3502 ;; nconc of one arg is a noop, even if that arg isn't a list.
3503 (byte-compile-form (nth 1 form)))
3505 (byte-compile-form (car (setq form (cdr form))))
3506 (while (setq form (cdr form))
3507 (byte-compile-form (car form))
3508 (byte-compile-out 'byte-nconc 0))))))
3510 (defun byte-compile-fset (form)
3511 ;; warn about forms like (fset 'foo '(lambda () ...))
3512 ;; (where the lambda expression is non-trivial...)
3513 (let ((fn (nth 2 form))
3515 (if (and (eq (car-safe fn) 'quote)
3516 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3518 (setq body (cdr (cdr fn)))
3519 (if (stringp (car body)) (setq body (cdr body)))
3520 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3521 (if (and (consp (car body))
3522 (not (eq 'byte-code (car (car body)))))
3524 "A quoted lambda form is the second argument of `fset'. This is probably
3525 not what you want, as that lambda cannot be compiled. Consider using
3526 the syntax #'(lambda (...) ...) instead.")))))
3527 (byte-compile-two-args form))
3529 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3530 ;; Otherwise it will be incompatible with the interpreter,
3531 ;; and (funcall (function foo)) will lose with autoloads.
3533 (defun byte-compile-function-form (form)
3534 (byte-compile-constant (if (eq 'lambda (car-safe (nth 1 form)))
3535 (byte-compile-lambda (nth 1 form))
3538 (defun byte-compile-indent-to (form)
3539 (let ((len (length form)))
3541 (byte-compile-form (car (cdr form)))
3542 (byte-compile-out 'byte-indent-to 0))
3544 ;; no opcode for 2-arg case.
3545 (byte-compile-normal-call form))
3547 (byte-compile-subr-wrong-args form "1-2")))))
3549 (defun byte-compile-insert (form)
3550 (cond ((null (cdr form))
3551 (byte-compile-constant nil))
3552 ((<= (length form) 256)
3553 (mapc 'byte-compile-form (cdr form))
3554 (if (cdr (cdr form))
3555 (byte-compile-out 'byte-insertN (length (cdr form)))
3556 (byte-compile-out 'byte-insert 0)))
3557 ((memq t (mapcar 'consp (cdr (cdr form))))
3558 (byte-compile-normal-call form))
3559 ;; We can split it; there is no function call after inserting 1st arg.
3561 (while (setq form (cdr form))
3562 (byte-compile-form (car form))
3563 (byte-compile-out 'byte-insert 0)
3565 (byte-compile-discard))))))
3568 (byte-defop-compiler-1 setq)
3569 (byte-defop-compiler-1 setq-default)
3570 (byte-defop-compiler-1 quote)
3572 (defun byte-compile-setq (form)
3573 (let ((args (cdr form)))
3576 (byte-compile-form (car (cdr args)))
3577 (or byte-compile--for-effect (cdr (cdr args))
3578 (byte-compile-out 'byte-dup 0))
3579 (byte-compile-variable-set (car args))
3580 (setq args (cdr (cdr args))))
3581 ;; (setq), with no arguments.
3582 (byte-compile-form nil byte-compile--for-effect))
3583 (setq byte-compile--for-effect nil)))
3585 (defun byte-compile-setq-default (form)
3586 (setq form (cdr form))
3587 (if (null form) ; (setq-default), with no arguments
3588 (byte-compile-form nil byte-compile--for-effect)
3589 (if (> (length form) 2)
3592 (push `(setq-default ,(pop form) ,(pop form)) setters))
3593 (byte-compile-form (cons 'progn (nreverse setters))))
3594 (let ((var (car form)))
3595 (and (or (not (symbolp var))
3596 (macroexp--const-symbol-p var t))
3597 (byte-compile-warning-enabled-p 'constants)
3599 "variable assignment to %s `%s'"
3600 (if (symbolp var) "constant" "nonvariable")
3601 (prin1-to-string var)))
3602 (byte-compile-normal-call `(set-default ',var ,@(cdr form)))))))
3604 (byte-defop-compiler-1 set-default)
3605 (defun byte-compile-set-default (form)
3606 (let ((varexp (car-safe (cdr-safe form))))
3607 (if (eq (car-safe varexp) 'quote)
3608 ;; If the varexp is constant, compile it as a setq-default
3609 ;; so we get more warnings.
3610 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3612 (byte-compile-normal-call form))))
3614 (defun byte-compile-quote (form)
3615 (byte-compile-constant (car (cdr form))))
3617 ;;; control structures
3619 (defun byte-compile-body (body &optional for-effect)
3621 (byte-compile-form (car body) t)
3622 (setq body (cdr body)))
3623 (byte-compile-form (car body) for-effect))
3625 (defsubst byte-compile-body-do-effect (body)
3626 (byte-compile-body body byte-compile--for-effect)
3627 (setq byte-compile--for-effect nil))
3629 (defsubst byte-compile-form-do-effect (form)
3630 (byte-compile-form form byte-compile--for-effect)
3631 (setq byte-compile--for-effect nil))
3633 (byte-defop-compiler-1 inline byte-compile-progn)
3634 (byte-defop-compiler-1 progn)
3635 (byte-defop-compiler-1 prog1)
3636 (byte-defop-compiler-1 prog2)
3637 (byte-defop-compiler-1 if)
3638 (byte-defop-compiler-1 cond)
3639 (byte-defop-compiler-1 and)
3640 (byte-defop-compiler-1 or)
3641 (byte-defop-compiler-1 while)
3642 (byte-defop-compiler-1 funcall)
3643 (byte-defop-compiler-1 let)
3644 (byte-defop-compiler-1 let* byte-compile-let)
3646 (defun byte-compile-progn (form)
3647 (byte-compile-body-do-effect (cdr form)))
3649 (defun byte-compile-prog1 (form)
3650 (byte-compile-form-do-effect (car (cdr form)))
3651 (byte-compile-body (cdr (cdr form)) t))
3653 (defun byte-compile-prog2 (form)
3654 (byte-compile-form (nth 1 form) t)
3655 (byte-compile-form-do-effect (nth 2 form))
3656 (byte-compile-body (cdr (cdr (cdr form))) t))
3658 (defmacro byte-compile-goto-if (cond discard tag)
3661 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3662 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3665 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3666 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3667 (defun byte-compile-find-bound-condition (condition-param
3669 &optional only-if-not-present)
3673 (if (memq (car-safe condition-param) pred-list)
3674 ;; The condition appears by itself.
3675 (list condition-param)
3676 ;; If the condition is an `and', look for matches among the
3678 (when (eq 'and (car-safe condition-param))
3679 (cdr condition-param)))))
3681 (dolist (crt cond-list)
3682 (when (and (memq (car-safe crt) pred-list)
3683 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3684 ;; Ignore if the symbol is already on the unresolved
3686 (not (assq (nth 1 nth-one) ; the relevant symbol
3687 only-if-not-present)))
3688 (push (nth 1 (nth 1 crt)) result)))
3691 (defmacro byte-compile-maybe-guarded (condition &rest body)
3692 "Execute forms in BODY, potentially guarded by CONDITION.
3693 CONDITION is a variable whose value is a test in an `if' or `cond'.
3694 BODY is the code to compile in the first arm of the if or the body of
3695 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3696 or (boundp 'foo), the relevant warnings from BODY about foo's
3697 being undefined (or obsolete) will be suppressed.
3699 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3700 that suppresses all warnings during execution of BODY."
3701 (declare (indent 1) (debug t))
3702 `(let* ((fbound-list (byte-compile-find-bound-condition
3703 ,condition (list 'fboundp)
3704 byte-compile-unresolved-functions))
3705 (bound-list (byte-compile-find-bound-condition
3706 ,condition (list 'boundp 'default-boundp)))
3707 ;; Maybe add to the bound list.
3708 (byte-compile-bound-variables
3709 (append bound-list byte-compile-bound-variables)))
3711 ;; If things not being bound at all is ok, so must them being
3712 ;; obsolete. Note that we add to the existing lists since Tramp
3713 ;; (ab)uses this feature.
3714 (let ((byte-compile-not-obsolete-vars
3715 (append byte-compile-not-obsolete-vars bound-list))
3716 (byte-compile-not-obsolete-funcs
3717 (append byte-compile-not-obsolete-funcs fbound-list)))
3719 ;; Maybe remove the function symbol from the unresolved list.
3720 (dolist (fbound fbound-list)
3722 (setq byte-compile-unresolved-functions
3723 (delq (assq fbound byte-compile-unresolved-functions)
3724 byte-compile-unresolved-functions)))))))
3726 (defun byte-compile-if (form)
3727 (byte-compile-form (car (cdr form)))
3728 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3729 ;; and avoid warnings about the relevant symbols in the consequent.
3730 (let ((clause (nth 1 form))
3731 (donetag (byte-compile-make-tag)))
3732 (if (null (nthcdr 3 form))
3735 (byte-compile-goto-if nil byte-compile--for-effect donetag)
3736 (byte-compile-maybe-guarded clause
3737 (byte-compile-form (nth 2 form) byte-compile--for-effect))
3738 (byte-compile-out-tag donetag))
3739 (let ((elsetag (byte-compile-make-tag)))
3740 (byte-compile-goto 'byte-goto-if-nil elsetag)
3741 (byte-compile-maybe-guarded clause
3742 (byte-compile-form (nth 2 form) byte-compile--for-effect))
3743 (byte-compile-goto 'byte-goto donetag)
3744 (byte-compile-out-tag elsetag)
3745 (byte-compile-maybe-guarded (list 'not clause)
3746 (byte-compile-body (cdr (cdr (cdr form))) byte-compile--for-effect))
3747 (byte-compile-out-tag donetag))))
3748 (setq byte-compile--for-effect nil))
3750 (defun byte-compile-cond (clauses)
3751 (let ((donetag (byte-compile-make-tag))
3753 (while (setq clauses (cdr clauses))
3754 (setq clause (car clauses))
3755 (cond ((or (eq (car clause) t)
3756 (and (eq (car-safe (car clause)) 'quote)
3757 (car-safe (cdr-safe (car clause)))))
3758 ;; Unconditional clause
3759 (setq clause (cons t clause)
3762 (byte-compile-form (car clause))
3763 (if (null (cdr clause))
3764 ;; First clause is a singleton.
3765 (byte-compile-goto-if t byte-compile--for-effect donetag)
3766 (setq nexttag (byte-compile-make-tag))
3767 (byte-compile-goto 'byte-goto-if-nil nexttag)
3768 (byte-compile-maybe-guarded (car clause)
3769 (byte-compile-body (cdr clause) byte-compile--for-effect))
3770 (byte-compile-goto 'byte-goto donetag)
3771 (byte-compile-out-tag nexttag)))))
3773 (let ((guard (car clause)))
3774 (and (cdr clause) (not (eq guard t))
3775 (progn (byte-compile-form guard)
3776 (byte-compile-goto-if nil byte-compile--for-effect donetag)
3777 (setq clause (cdr clause))))
3778 (byte-compile-maybe-guarded guard
3779 (byte-compile-body-do-effect clause)))
3780 (byte-compile-out-tag donetag)))
3782 (defun byte-compile-and (form)
3783 (let ((failtag (byte-compile-make-tag))
3786 (byte-compile-form-do-effect t)
3787 (byte-compile-and-recursion args failtag))))
3789 ;; Handle compilation of a nontrivial `and' call.
3790 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3791 (defun byte-compile-and-recursion (rest failtag)
3794 (byte-compile-form (car rest))
3795 (byte-compile-goto-if nil byte-compile--for-effect failtag)
3796 (byte-compile-maybe-guarded (car rest)
3797 (byte-compile-and-recursion (cdr rest) failtag)))
3798 (byte-compile-form-do-effect (car rest))
3799 (byte-compile-out-tag failtag)))
3801 (defun byte-compile-or (form)
3802 (let ((wintag (byte-compile-make-tag))
3805 (byte-compile-form-do-effect nil)
3806 (byte-compile-or-recursion args wintag))))
3808 ;; Handle compilation of a nontrivial `or' call.
3809 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3810 (defun byte-compile-or-recursion (rest wintag)
3813 (byte-compile-form (car rest))
3814 (byte-compile-goto-if t byte-compile--for-effect wintag)
3815 (byte-compile-maybe-guarded (list 'not (car rest))
3816 (byte-compile-or-recursion (cdr rest) wintag)))
3817 (byte-compile-form-do-effect (car rest))
3818 (byte-compile-out-tag wintag)))
3820 (defun byte-compile-while (form)
3821 (let ((endtag (byte-compile-make-tag))
3822 (looptag (byte-compile-make-tag)))
3823 (byte-compile-out-tag looptag)
3824 (byte-compile-form (car (cdr form)))
3825 (byte-compile-goto-if nil byte-compile--for-effect endtag)
3826 (byte-compile-body (cdr (cdr form)) t)
3827 (byte-compile-goto 'byte-goto looptag)
3828 (byte-compile-out-tag endtag)
3829 (setq byte-compile--for-effect nil)))
3831 (defun byte-compile-funcall (form)
3832 (mapc 'byte-compile-form (cdr form))
3833 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3838 (defun byte-compile-push-binding-init (clause)
3839 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
3840 Return the offset in the form (VAR . OFFSET)."
3841 (let* ((var (if (consp clause) (car clause) clause)))
3842 ;; We record the stack position even of dynamic bindings and
3843 ;; variables in non-stack lexical environments; we'll put
3844 ;; them in the proper place below.
3845 (prog1 (cons var byte-compile-depth)
3847 (byte-compile-form (cadr clause))
3848 (byte-compile-push-constant nil)))))
3850 (defun byte-compile-not-lexical-var-p (var)
3851 (or (not (symbolp var))
3852 (special-variable-p var)
3853 (memq var byte-compile-bound-variables)
3857 (defun byte-compile-bind (var init-lexenv)
3858 "Emit byte-codes to bind VAR and update `byte-compile--lexical-environment'.
3859 INIT-LEXENV should be a lexical-environment alist describing the
3860 positions of the init value that have been pushed on the stack.
3861 Return non-nil if the TOS value was popped."
3862 ;; The presence of lexical bindings mean that we may have to
3863 ;; juggle things on the stack, to move them to TOS for
3865 (cond ((not (byte-compile-not-lexical-var-p var))
3866 ;; VAR is a simple stack-allocated lexical variable
3867 (push (assq var init-lexenv)
3868 byte-compile--lexical-environment)
3870 ((eq var (caar init-lexenv))
3871 ;; VAR is dynamic and is on the top of the
3872 ;; stack, so we can just bind it like usual
3873 (byte-compile-dynamic-variable-bind var)
3876 ;; VAR is dynamic, but we have to get its
3877 ;; value out of the middle of the stack
3878 (let ((stack-pos (cdr (assq var init-lexenv))))
3879 (byte-compile-stack-ref stack-pos)
3880 (byte-compile-dynamic-variable-bind var)
3881 ;; Now we have to store nil into its temporary
3882 ;; stack position to avoid problems with GC
3883 (byte-compile-push-constant nil)
3884 (byte-compile-stack-set stack-pos))
3887 (defun byte-compile-unbind (clauses init-lexenv
3888 &optional preserve-body-value)
3889 "Emit byte-codes to unbind the variables bound by CLAUSES.
3890 CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3891 lexical-environment alist describing the positions of the init value that
3892 have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3893 then an additional value on the top of the stack, above any lexical binding
3894 slots, is preserved, so it will be on the top of the stack after all
3895 binding slots have been popped."
3896 ;; Unbind dynamic variables
3897 (let ((num-dynamic-bindings 0))
3898 (dolist (clause clauses)
3899 (unless (assq (if (consp clause) (car clause) clause)
3900 byte-compile--lexical-environment)
3901 (setq num-dynamic-bindings (1+ num-dynamic-bindings))))
3902 (unless (zerop num-dynamic-bindings)
3903 (byte-compile-out 'byte-unbind num-dynamic-bindings)))
3904 ;; Pop lexical variables off the stack, possibly preserving the
3905 ;; return value of the body.
3907 ;; INIT-LEXENV contains all init values left on the stack
3908 (byte-compile-discard (length init-lexenv) preserve-body-value)))
3910 (defun byte-compile-let (form)
3911 "Generate code for the `let' form FORM."
3912 (let ((clauses (cadr form))
3914 (when (eq (car form) 'let)
3915 ;; First compute the binding values in the old scope.
3916 (dolist (var clauses)
3917 (push (byte-compile-push-binding-init var) init-lexenv)))
3919 (let ((byte-compile-bound-variables byte-compile-bound-variables)
3920 (byte-compile--lexical-environment
3921 byte-compile--lexical-environment))
3922 ;; Bind the variables.
3923 ;; For `let', do it in reverse order, because it makes no
3924 ;; semantic difference, but it is a lot more efficient since the
3925 ;; values are now in reverse order on the stack.
3926 (dolist (var (if (eq (car form) 'let) (reverse clauses) clauses))
3927 (unless (eq (car form) 'let)
3928 (push (byte-compile-push-binding-init var) init-lexenv))
3929 (let ((var (if (consp var) (car var) var)))
3930 (cond ((null lexical-binding)
3931 ;; If there are no lexical bindings, we can do things simply.
3932 (byte-compile-dynamic-variable-bind var))
3933 ((byte-compile-bind var init-lexenv)
3934 (pop init-lexenv)))))
3936 (let ((init-stack-depth byte-compile-depth))
3937 (byte-compile-body-do-effect (cdr (cdr form)))
3938 ;; Unbind the variables.
3940 ;; Unbind both lexical and dynamic variables.
3942 (cl-assert (or (eq byte-compile-depth init-stack-depth)
3943 (eq byte-compile-depth (1+ init-stack-depth))))
3944 (byte-compile-unbind clauses init-lexenv (> byte-compile-depth
3946 ;; Unbind dynamic variables.
3947 (byte-compile-out 'byte-unbind (length clauses)))))))
3951 (byte-defop-compiler-1 /= byte-compile-negated)
3952 (byte-defop-compiler-1 atom byte-compile-negated)
3953 (byte-defop-compiler-1 nlistp byte-compile-negated)
3955 (put '/= 'byte-compile-negated-op '=)
3956 (put 'atom 'byte-compile-negated-op 'consp)
3957 (put 'nlistp 'byte-compile-negated-op 'listp)
3959 (defun byte-compile-negated (form)
3960 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3962 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3963 (defun byte-compile-negation-optimizer (form)
3964 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3965 (byte-compile-set-symbol-position (car form))
3967 (cons (or (get (car form) 'byte-compile-negated-op)
3969 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3973 ;;; other tricky macro-like special-forms
3975 (byte-defop-compiler-1 catch)
3976 (byte-defop-compiler-1 unwind-protect)
3977 (byte-defop-compiler-1 condition-case)
3978 (byte-defop-compiler-1 save-excursion)
3979 (byte-defop-compiler-1 save-current-buffer)
3980 (byte-defop-compiler-1 save-restriction)
3981 ;; (byte-defop-compiler-1 save-window-excursion) ;Obsolete: now a macro.
3982 ;; (byte-defop-compiler-1 with-output-to-temp-buffer) ;Obsolete: now a macro.
3983 (byte-defop-compiler-1 track-mouse)
3985 (defun byte-compile-catch (form)
3986 (byte-compile-form (car (cdr form)))
3989 (byte-compile-form `(list 'funcall ,f)))
3991 (byte-compile-push-constant
3992 (byte-compile-top-level (cons 'progn body) byte-compile--for-effect))))
3993 (byte-compile-out 'byte-catch 0))
3995 (defun byte-compile-unwind-protect (form)
3998 (byte-compile-form `(list (list 'funcall ,f))))
4000 (byte-compile-push-constant
4001 (byte-compile-top-level-body handlers t))))
4002 (byte-compile-out 'byte-unwind-protect 0)
4003 (byte-compile-form-do-effect (car (cdr form)))
4004 (byte-compile-out 'byte-unbind 1))
4006 (defun byte-compile-track-mouse (form)
4009 (`(,_ :fun-body ,f) `(eval (list 'track-mouse (list 'funcall ,f))))
4010 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form))))))))
4012 (defun byte-compile-condition-case (form)
4013 (let* ((var (nth 1 form))
4014 (fun-bodies (eq var :fun-body))
4015 (byte-compile-bound-variables
4016 (if (and var (not fun-bodies))
4017 (cons var byte-compile-bound-variables)
4018 byte-compile-bound-variables)))
4019 (byte-compile-set-symbol-position 'condition-case)
4020 (unless (symbolp var)
4022 "`%s' is not a variable-name or nil (in condition-case)" var))
4023 (if fun-bodies (setq var (make-symbol "err")))
4024 (byte-compile-push-constant var)
4026 (byte-compile-form `(list 'funcall ,(nth 2 form)))
4027 (byte-compile-push-constant
4028 (byte-compile-top-level (nth 2 form) byte-compile--for-effect)))
4029 (let ((compiled-clauses
4032 (let ((condition (car clause)))
4033 (cond ((not (or (symbolp condition)
4034 (and (listp condition)
4036 (dolist (sym condition)
4037 (if (not (symbolp sym))
4041 "`%S' is not a condition name or list of such (in condition-case)"
4043 ;; (not (or (eq condition 't)
4044 ;; (and (stringp (get condition 'error-message))
4045 ;; (consp (get condition
4046 ;; 'error-conditions)))))
4047 ;; (byte-compile-warn
4048 ;; "`%s' is not a known condition name
4049 ;; (in condition-case)"
4053 `(list ',condition (list 'funcall ,(cadr clause) ',var))
4055 (byte-compile-top-level-body
4056 (cdr clause) byte-compile--for-effect)))))
4057 (cdr (cdr (cdr form))))))
4059 (byte-compile-form `(list ,@compiled-clauses))
4060 (byte-compile-push-constant compiled-clauses)))
4061 (byte-compile-out 'byte-condition-case 0)))
4064 (defun byte-compile-save-excursion (form)
4065 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
4066 (byte-compile-warning-enabled-p 'suspicious))
4068 "Use `with-current-buffer' rather than save-excursion+set-buffer"))
4069 (byte-compile-out 'byte-save-excursion 0)
4070 (byte-compile-body-do-effect (cdr form))
4071 (byte-compile-out 'byte-unbind 1))
4073 (defun byte-compile-save-restriction (form)
4074 (byte-compile-out 'byte-save-restriction 0)
4075 (byte-compile-body-do-effect (cdr form))
4076 (byte-compile-out 'byte-unbind 1))
4078 (defun byte-compile-save-current-buffer (form)
4079 (byte-compile-out 'byte-save-current-buffer 0)
4080 (byte-compile-body-do-effect (cdr form))
4081 (byte-compile-out 'byte-unbind 1))
4083 ;;; top-level forms elsewhere
4085 (byte-defop-compiler-1 defvar)
4086 (byte-defop-compiler-1 defconst byte-compile-defvar)
4087 (byte-defop-compiler-1 autoload)
4088 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
4090 ;; If foo.el declares `toto' as obsolete, it is likely that foo.el will
4091 ;; actually use `toto' in order for this obsolete variable to still work
4092 ;; correctly, so paradoxically, while byte-compiling foo.el, the presence
4093 ;; of a make-obsolete-variable call for `toto' is an indication that `toto'
4094 ;; should not trigger obsolete-warnings in foo.el.
4095 (byte-defop-compiler-1 make-obsolete-variable)
4096 (defun byte-compile-make-obsolete-variable (form)
4097 (when (eq 'quote (car-safe (nth 1 form)))
4098 (push (nth 1 (nth 1 form)) byte-compile-global-not-obsolete-vars))
4099 (byte-compile-normal-call form))
4101 (defconst byte-compile-tmp-var (make-symbol "def-tmp-var"))
4103 (defun byte-compile-defvar (form)
4104 ;; This is not used for file-level defvar/consts.
4105 (when (and (symbolp (nth 1 form))
4106 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4107 (byte-compile-warning-enabled-p 'lexical))
4108 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4110 (let ((fun (nth 0 form))
4112 (value (nth 2 form))
4113 (string (nth 3 form)))
4114 (byte-compile-set-symbol-position fun)
4115 (when (or (> (length form) 4)
4116 (and (eq fun 'defconst) (null (cddr form))))
4117 (let ((ncall (length (cdr form))))
4119 "`%s' called with %d argument%s, but %s %s"
4121 (if (= 1 ncall) "" "s")
4122 (if (< ncall 2) "requires" "accepts only")
4124 (push var byte-compile-bound-variables)
4125 (if (eq fun 'defconst)
4126 (push var byte-compile-const-variables))
4127 (when (and string (not (stringp string)))
4128 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4130 (byte-compile-form-do-effect
4131 (if (cddr form) ; `value' provided
4132 ;; Quote with `quote' to prevent byte-compiling the body,
4133 ;; which would lead to an inf-loop.
4134 `(funcall '(lambda (,byte-compile-tmp-var)
4135 (,fun ,var ,byte-compile-tmp-var ,@(nthcdr 3 form)))
4137 (if (eq fun 'defconst)
4138 ;; This will signal an appropriate error at runtime.
4140 ;; A simple (defvar foo) just returns foo.
4143 (defun byte-compile-autoload (form)
4144 (byte-compile-set-symbol-position 'autoload)
4145 (and (macroexp-const-p (nth 1 form))
4146 (macroexp-const-p (nth 5 form))
4147 (eval (nth 5 form)) ; macro-p
4148 (not (fboundp (eval (nth 1 form))))
4150 "The compiler ignores `autoload' except at top level. You should
4151 probably put the autoload of the macro `%s' at top-level."
4152 (eval (nth 1 form))))
4153 (byte-compile-normal-call form))
4155 ;; Lambdas in valid places are handled as special cases by various code.
4156 ;; The ones that remain are errors.
4157 (defun byte-compile-lambda-form (_form)
4158 (byte-compile-set-symbol-position 'lambda)
4159 (error "`lambda' used as function name is invalid"))
4161 ;; Compile normally, but deal with warnings for the function being defined.
4162 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
4163 ;; Used for eieio--defalias as well.
4164 (defun byte-compile-file-form-defalias (form)
4165 ;; For the compilation itself, we could largely get rid of this hunk-handler,
4166 ;; if it weren't for the fact that we need to figure out when a defalias
4167 ;; defines a macro, so as to add it to byte-compile-macro-environment.
4169 ;; FIXME: we also use this hunk-handler to implement the function's dynamic
4170 ;; docstring feature. We could actually implement it more elegantly in
4171 ;; byte-compile-lambda so it applies to all lambdas, but the problem is that
4172 ;; the resulting .elc format will not be recognized by make-docfile, so
4173 ;; either we stop using DOC for the docstrings of preloaded elc files (at the
4174 ;; cost of around 24KB on 32bit hosts, double on 64bit hosts) or we need to
4175 ;; build DOC in a more clever way (e.g. handle anonymous elements).
4176 (let ((byte-compile-free-references nil)
4177 (byte-compile-free-assignments nil))
4179 ;; Decompose `form' into:
4180 ;; - `name' is the name of the defined function.
4181 ;; - `arg' is the expression to which it is defined.
4182 ;; - `rest' is the rest of the arguments.
4183 (`(,_ ',name ,arg . ,rest)
4185 ;; `macro' is non-nil if it defines a macro.
4186 ;; `fun' is the function part of `arg' (defaults to `arg').
4187 (((or (and (or `(cons 'macro ,fun) `'(macro . ,fun)) (let macro t))
4188 (and (let fun arg) (let macro nil)))
4190 ;; `lam' is the lambda expression in `fun' (or nil if not
4192 ((or `(,(or `quote `function) ,lam) (let lam nil))
4194 ;; `arglist' is the list of arguments (or t if not recognized).
4195 ;; `body' is the body of `lam' (or t if not recognized).
4196 ((or `(lambda ,arglist . ,body)
4197 ;; `(closure ,_ ,arglist . ,body)
4198 (and `(internal-make-closure ,arglist . ,_) (let body t))
4199 (and (let arglist t) (let body t)))
4201 (unless (byte-compile-file-form-defmumble
4202 name macro arglist body rest)
4203 (byte-compile-keep-pending form))))
4205 ;; We used to just do: (byte-compile-normal-call form)
4206 ;; But it turns out that this fails to optimize the code.
4207 ;; So instead we now do the same as what other byte-hunk-handlers do,
4208 ;; which is to call back byte-compile-file-form and then return nil.
4209 ;; Except that we can't just call byte-compile-file-form since it would
4210 ;; call us right back.
4211 (t (byte-compile-keep-pending form)))))
4213 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
4214 (defun byte-compile-no-warnings (form)
4215 (let (byte-compile-warnings)
4216 (byte-compile-form (cons 'progn (cdr form)))))
4218 ;; Warn about misuses of make-variable-buffer-local.
4219 (byte-defop-compiler-1 make-variable-buffer-local
4220 byte-compile-make-variable-buffer-local)
4221 (defun byte-compile-make-variable-buffer-local (form)
4222 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
4223 (byte-compile-warning-enabled-p 'make-local))
4225 "`make-variable-buffer-local' should be called at toplevel"))
4226 (byte-compile-normal-call form))
4227 (put 'make-variable-buffer-local
4228 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4229 (defun byte-compile-form-make-variable-buffer-local (form)
4230 (byte-compile-keep-pending form 'byte-compile-normal-call))
4232 (byte-defop-compiler-1 add-to-list byte-compile-add-to-list)
4233 (defun byte-compile-add-to-list (form)
4234 ;; FIXME: This could be used for `set' as well, except that it's got
4235 ;; its own opcode, so the final `byte-compile-normal-call' needs to
4236 ;; be replaced with something else.
4239 (byte-compile-check-variable var 'assign)
4240 (if (assq var byte-compile--lexical-environment)
4241 (byte-compile-log-warning
4242 (format "%s cannot use lexical var `%s'" fun var)
4244 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
4246 (memq var byte-compile-bound-variables)
4247 (memq var byte-compile-free-references))
4248 (byte-compile-warn "assignment to free variable `%S'" var)
4249 (push var byte-compile-free-references)))))
4250 (byte-compile-normal-call form))
4254 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4255 ;; optimization to have the 'TAG as a part of the tag.
4256 ;; Tags will be (TAG . (tag-number . stack-depth)).
4257 (defun byte-compile-make-tag ()
4258 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4261 (defun byte-compile-out-tag (tag)
4262 (setq byte-compile-output (cons tag byte-compile-output))
4265 ;; ## remove this someday
4266 (and byte-compile-depth
4267 (not (= (cdr (cdr tag)) byte-compile-depth))
4268 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
4269 (setq byte-compile-depth (cdr (cdr tag))))
4270 (setcdr (cdr tag) byte-compile-depth)))
4272 (defun byte-compile-goto (opcode tag)
4273 (push (cons opcode tag) byte-compile-output)
4274 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4275 (1- byte-compile-depth)
4276 byte-compile-depth))
4277 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4278 (1- byte-compile-depth))))
4280 (defun byte-compile-stack-adjustment (op operand)
4281 "Return the amount by which an operation adjusts the stack.
4282 OP and OPERAND are as passed to `byte-compile-out'."
4283 (if (memq op '(byte-call byte-discardN byte-discardN-preserve-tos))
4284 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4285 ;; elements, and the push the result, for a total of -OPERAND.
4286 ;; For discardN*, of course, we just pop OPERAND elements.
4288 (or (aref byte-stack+-info (symbol-value op))
4289 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4290 ;; that take OPERAND values off the stack and push a result, for
4291 ;; a total of 1 - OPERAND
4294 (defun byte-compile-out (op &optional operand)
4295 (push (cons op operand) byte-compile-output)
4296 (if (eq op 'byte-return)
4297 ;; This is actually an unnecessary case, because there should be no
4298 ;; more ops behind byte-return.
4299 (setq byte-compile-depth nil)
4300 (setq byte-compile-depth
4301 (+ byte-compile-depth (byte-compile-stack-adjustment op operand)))
4302 (setq byte-compile-maxdepth (max byte-compile-depth byte-compile-maxdepth))
4303 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4308 (defun byte-compile-annotate-call-tree (form)
4310 ;; annotate the current call
4311 (if (setq entry (assq (car form) byte-compile-call-tree))
4312 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4314 (cons byte-compile-current-form (nth 1 entry))))
4315 (setq byte-compile-call-tree
4316 (cons (list (car form) (list byte-compile-current-form) nil)
4317 byte-compile-call-tree)))
4318 ;; annotate the current function
4319 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4320 (or (memq (car form) (nth 2 entry)) ;called
4321 (setcar (cdr (cdr entry))
4322 (cons (car form) (nth 2 entry))))
4323 (setq byte-compile-call-tree
4324 (cons (list byte-compile-current-form nil (list (car form)))
4325 byte-compile-call-tree)))
4328 ;; Renamed from byte-compile-report-call-tree
4329 ;; to avoid interfering with completion of byte-compile-file.
4331 (defun display-call-tree (&optional filename)
4332 "Display a call graph of a specified file.
4333 This lists which functions have been called, what functions called
4334 them, and what functions they call. The list includes all functions
4335 whose definitions have been compiled in this Emacs session, as well as
4336 all functions called by those functions.
4338 The call graph does not include macros, inline functions, or
4339 primitives that the byte-code interpreter knows about directly \(eq,
4342 The call tree also lists those functions which are not known to be called
4343 \(that is, to which no calls have been compiled\), and which cannot be
4344 invoked interactively."
4346 (message "Generating call tree...")
4347 (with-output-to-temp-buffer "*Call-Tree*"
4348 (set-buffer "*Call-Tree*")
4350 (message "Generating call tree... (sorting on %s)"
4351 byte-compile-call-tree-sort)
4352 (insert "Call tree for "
4353 (cond ((null byte-compile-current-file) (or filename "???"))
4354 ((stringp byte-compile-current-file)
4355 byte-compile-current-file)
4356 (t (buffer-name byte-compile-current-file)))
4358 (prin1-to-string byte-compile-call-tree-sort)
4360 (if byte-compile-call-tree-sort
4361 (setq byte-compile-call-tree
4362 (sort byte-compile-call-tree
4363 (pcase byte-compile-call-tree-sort
4365 (lambda (x y) (< (length (nth 1 x))
4366 (length (nth 1 y)))))
4368 (lambda (x y) (< (length (nth 2 x))
4369 (length (nth 2 y)))))
4371 (lambda (x y) (< (+ (length (nth 1 x))
4373 (+ (length (nth 1 y))
4374 (length (nth 2 y))))))
4376 (lambda (x y) (string< (car x) (car y))))
4377 (_ (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4378 byte-compile-call-tree-sort))))))
4379 (message "Generating call tree...")
4380 (let ((rest byte-compile-call-tree)
4381 (b (current-buffer))
4385 (prin1 (car (car rest)) b)
4386 (setq callers (nth 1 (car rest))
4387 calls (nth 2 (car rest)))
4389 (cond ((not (fboundp (setq f (car (car rest)))))
4391 " <top level>";; shouldn't insert nil then, actually -sk
4393 ((subrp (setq f (symbol-function f)))
4396 (format " ==> %s" f))
4397 ((byte-code-function-p f)
4398 "<compiled function>")
4400 "<malformed function>")
4401 ((eq 'macro (car f))
4402 (if (or (byte-code-function-p (cdr f))
4403 (assq 'byte-code (cdr (cdr (cdr f)))))
4406 ((assq 'byte-code (cdr (cdr f)))
4407 "<compiled lambda>")
4408 ((eq 'lambda (car f))
4411 (format " (%d callers + %d calls = %d)"
4412 ;; Does the optimizer eliminate common subexpressions?-sk
4415 (+ (length callers) (length calls)))
4419 (insert " called by:\n")
4421 (insert " " (if (car callers)
4422 (mapconcat 'symbol-name callers ", ")
4424 (let ((fill-prefix " "))
4425 (fill-region-as-paragraph p (point)))
4426 (unless (= 0 (current-column))
4430 (insert " calls:\n")
4432 (insert " " (mapconcat 'symbol-name calls ", "))
4433 (let ((fill-prefix " "))
4434 (fill-region-as-paragraph p (point)))
4435 (unless (= 0 (current-column))
4437 (setq rest (cdr rest)))
4439 (message "Generating call tree...(finding uncalled functions...)")
4440 (setq rest byte-compile-call-tree)
4443 (or (nth 1 (car rest))
4444 (null (setq f (caar rest)))
4446 (setq def (byte-compile-fdefinition f t))
4447 (and (eq (car-safe def) 'macro)
4448 (eq (car-safe (cdr-safe def)) 'lambda)
4449 (setq def (cdr def)))
4452 (setq def (byte-compile-fdefinition f nil))
4453 (and (eq (car-safe def) 'macro)
4454 (eq (car-safe (cdr-safe def)) 'lambda)
4455 (setq def (cdr def)))
4457 (setq uncalled (cons f uncalled)))
4458 (setq rest (cdr rest)))
4460 (let ((fill-prefix " "))
4461 (insert "Noninteractive functions not known to be called:\n ")
4463 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4464 (fill-region-as-paragraph p (point))))))
4465 (message "Generating call tree...done.")))
4469 (defun batch-byte-compile-if-not-done ()
4470 "Like `byte-compile-file' but doesn't recompile if already up to date.
4471 Use this from the command line, with `-batch';
4472 it won't work in an interactive Emacs."
4473 (batch-byte-compile t))
4475 ;;; by crl@newton.purdue.edu
4476 ;;; Only works noninteractively.
4478 (defun batch-byte-compile (&optional noforce)
4479 "Run `byte-compile-file' on the files remaining on the command line.
4480 Use this from the command line, with `-batch';
4481 it won't work in an interactive Emacs.
4482 Each file is processed even if an error occurred previously.
4483 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4484 If NOFORCE is non-nil, don't recompile a file that seems to be
4485 already up-to-date."
4486 ;; command-line-args-left is what is left of the command line, from
4488 (defvar command-line-args-left) ;Avoid 'free variable' warning
4489 (if (not noninteractive)
4490 (error "`batch-byte-compile' is to be used only with -batch"))
4492 (while command-line-args-left
4493 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4494 ;; Directory as argument.
4496 (dolist (file (directory-files (car command-line-args-left)))
4497 (if (and (string-match emacs-lisp-file-regexp file)
4498 (not (auto-save-file-name-p file))
4500 (expand-file-name file
4501 (car command-line-args-left)))
4502 (setq dest (byte-compile-dest-file source))
4503 (file-exists-p dest)
4504 (file-newer-than-file-p source dest))
4505 (if (null (batch-byte-compile-file source))
4507 ;; Specific file argument
4508 (if (or (not noforce)
4509 (let* ((source (car command-line-args-left))
4510 (dest (byte-compile-dest-file source)))
4511 (or (not (file-exists-p dest))
4512 (file-newer-than-file-p source dest))))
4513 (if (null (batch-byte-compile-file (car command-line-args-left)))
4515 (setq command-line-args-left (cdr command-line-args-left)))
4516 (kill-emacs (if error 1 0))))
4518 (defun batch-byte-compile-file (file)
4519 (let ((byte-compile-root-dir (or byte-compile-root-dir default-directory)))
4521 (byte-compile-file file)
4523 (byte-compile-file file)
4525 (message (if (cdr err)
4526 ">>Error occurred processing %s: %s (%s)"
4527 ">>Error occurred processing %s: %s")
4529 (get (car err) 'error-message)
4530 (prin1-to-string (cdr err)))
4531 (let ((destfile (byte-compile-dest-file file)))
4532 (if (file-exists-p destfile)
4533 (delete-file destfile)))
4536 (message (if (cdr err)
4537 ">>Error occurred processing %s: %s (%s)"
4538 ">>Error occurred processing %s: %s")
4540 (get (car err) 'error-message)
4541 (prin1-to-string (cdr err)))
4544 (defun byte-compile-refresh-preloaded ()
4545 "Reload any Lisp file that was changed since Emacs was dumped.
4547 (let* ((argv0 (car command-line-args))
4548 (emacs-file (executable-find argv0)))
4549 (if (not (and emacs-file (file-executable-p emacs-file)))
4550 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4551 (dolist (f (reverse load-history))
4553 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4554 (when (and (file-readable-p f)
4555 (file-newer-than-file-p f emacs-file)
4556 ;; Don't reload the source version of the files below
4557 ;; because that causes subsequent byte-compilation to
4558 ;; be a lot slower and need a higher max-lisp-eval-depth,
4559 ;; so it can cause recompilation to fail.
4560 (not (member (file-name-nondirectory f)
4561 '("pcase.el" "bytecomp.el" "macroexp.el"
4562 "cconv.el" "byte-opt.el"))))
4563 (message "Reloading stale %s" (file-name-nondirectory f))
4565 (load f 'noerror nil 'nosuffix)
4566 ;; Probably shouldn't happen, but in case of an error, it seems
4567 ;; at least as useful to ignore it as it is to stop compilation.
4571 (defun batch-byte-recompile-directory (&optional arg)
4572 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4573 Must be used only with `-batch', and kills Emacs on completion.
4574 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4576 Optional argument ARG is passed as second argument ARG to
4577 `byte-recompile-directory'; see there for its possible values
4578 and corresponding effects."
4579 ;; command-line-args-left is what is left of the command line (startup.el)
4580 (defvar command-line-args-left) ;Avoid 'free variable' warning
4581 (if (not noninteractive)
4582 (error "batch-byte-recompile-directory is to be used only with -batch"))
4583 (or command-line-args-left
4584 (setq command-line-args-left '(".")))
4585 (while command-line-args-left
4586 (byte-recompile-directory (car command-line-args-left) arg)
4587 (setq command-line-args-left (cdr command-line-args-left)))
4590 ;;; Core compiler macros.
4592 (put 'featurep 'compiler-macro
4593 (lambda (form feature &rest _ignore)
4594 ;; Emacs-21's byte-code doesn't run under XEmacs or SXEmacs anyway, so
4595 ;; we can safely optimize away this test.
4596 (if (member feature '('xemacs 'sxemacs 'emacs))
4600 (provide 'byte-compile)
4604 ;;; report metering (see the hacks in bytecode.c)
4606 (defvar byte-code-meter)
4607 (defun byte-compile-report-ops ()
4608 (or (boundp 'byte-metering-on)
4609 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4610 (with-output-to-temp-buffer "*Meter*"
4611 (set-buffer "*Meter*")
4612 (let ((i 0) n op off)
4614 (setq n (aref (aref byte-code-meter 0) i)
4616 (if t ;(not (zerop n))
4620 (cond ((< op byte-nth)
4621 (setq off (logand op 7))
4622 (setq op (logand op 248)))
4623 ((>= op byte-constant)
4624 (setq off (- op byte-constant)
4626 (setq op (aref byte-code-vector op))
4627 (insert (format "%-4d" i))
4628 (insert (symbol-name op))
4629 (if off (insert " [" (int-to-string off) "]"))
4631 (insert (int-to-string n) "\n")))
4634 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4635 ;; itself, compile some of its most used recursive functions (at load time).
4638 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4639 (assq 'byte-code (symbol-function 'byte-compile-form))
4640 (let ((byte-optimize nil) ; do it fast
4641 (byte-compile-warnings nil))
4643 (or noninteractive (message "compiling %s..." x))
4645 (or noninteractive (message "compiling %s...done" x)))
4646 '(byte-compile-normal-call
4649 ;; Inserted some more than necessary, to speed it up.
4650 byte-compile-top-level
4651 byte-compile-out-toplevel
4652 byte-compile-constant
4653 byte-compile-variable-ref))))
4656 (run-hooks 'bytecomp-load-hook)
4658 ;;; bytecomp.el ends here