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