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