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