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