1 ;;; bytecomp.el --- compilation of Lisp code into byte code -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
30 ;; of p-code (`lapcode') which takes up less space and can be interpreted
31 ;; faster. [`LAP' == `Lisp Assembly Program'.]
32 ;; The user entry points are byte-compile-file and byte-recompile-directory.
36 ;; ========================================================================
38 ;; byte-recompile-directory, byte-compile-file,
39 ;; byte-recompile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables: M-x customize-group bytecomp
75 ;; o The form `defsubst' is just like `defun', except that the function
76 ;; generated will be open-coded in compiled code which uses it. This
77 ;; means that no function call will be generated, it will simply be
78 ;; spliced in. Lisp functions calls are very slow, so this can be a
81 ;; You can generally accomplish the same thing with `defmacro', but in
82 ;; that case, the defined procedure can't be used as an argument to
85 ;; o You can also open-code one particular call to a function without
86 ;; open-coding all calls. Use the 'inline' form to do this, like so:
88 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
90 ;; (inline ;; `foo' and `baz' will be
91 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
94 ;; o It is possible to open-code a function in the same file it is defined
95 ;; in without having to load that file before compiling it. The
96 ;; byte-compiler has been modified to remember function definitions in
97 ;; the compilation environment in the same way that it remembers macro
100 ;; o Forms like ((lambda ...) ...) are open-coded.
102 ;; o The form `eval-when-compile' is like progn, except that the body
103 ;; is evaluated at compile-time. When it appears at top-level, this
104 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
105 ;; When it does not appear at top-level, it is similar to the
106 ;; Common Lisp #. reader macro (but not in interpreted code).
108 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
109 ;; the whole form is evalled both at compile-time and at run-time.
111 ;; o The command compile-defun is analogous to eval-defun.
113 ;; o If you run byte-compile-file on a filename which is visited in a
114 ;; buffer, and that buffer is modified, you are asked whether you want
115 ;; to save the buffer before compiling.
117 ;; o byte-compiled files now start with the string `;ELC'.
118 ;; Some versions of `file' can be customized to recognize that.
123 (eval-when-compile (require 'cl
))
125 (or (fboundp 'defsubst
)
126 ;; This really ought to be loaded already!
129 ;; The feature of compiling in a specific target Emacs version
130 ;; has been turned off because compile time options are a bad idea.
131 (defgroup bytecomp nil
132 "Emacs Lisp byte-compiler."
135 (defcustom emacs-lisp-file-regexp
"\\.el\\'"
136 "Regexp which matches Emacs Lisp source files.
137 If you change this, you might want to set `byte-compile-dest-file-function'."
141 (defcustom byte-compile-dest-file-function nil
142 "Function for the function `byte-compile-dest-file' to call.
143 It should take one argument, the name of an Emacs Lisp source
144 file name, and return the name of the compiled file."
146 :type
'(choice (const nil
) function
)
149 ;; This enables file name handlers such as jka-compr
150 ;; to remove parts of the file name that should not be copied
151 ;; through to the output file name.
152 (defun byte-compiler-base-file-name (filename)
153 (let ((handler (find-file-name-handler filename
154 'byte-compiler-base-file-name
)))
156 (funcall handler
'byte-compiler-base-file-name filename
)
159 (or (fboundp 'byte-compile-dest-file
)
160 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
161 ;; so only define it if it is undefined.
162 ;; Note - redefining this function is obsolete as of 23.2.
163 ;; Customize byte-compile-dest-file-function instead.
164 (defun byte-compile-dest-file (filename)
165 "Convert an Emacs Lisp source file name to a compiled file name.
166 If `byte-compile-dest-file-function' is non-nil, uses that
167 function to do the work. Otherwise, if FILENAME matches
168 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
169 adds `c' to it; otherwise adds `.elc'."
170 (if byte-compile-dest-file-function
171 (funcall byte-compile-dest-file-function filename
)
172 (setq filename
(file-name-sans-versions
173 (byte-compiler-base-file-name filename
)))
174 (cond ((string-match emacs-lisp-file-regexp filename
)
175 (concat (substring filename
0 (match-beginning 0)) ".elc"))
176 (t (concat filename
".elc"))))))
178 ;; This can be the 'byte-compile property of any symbol.
179 (autoload 'byte-compile-inline-expand
"byte-opt")
181 ;; This is the entrypoint to the lapcode optimizer pass1.
182 (autoload 'byte-optimize-form
"byte-opt")
183 ;; This is the entrypoint to the lapcode optimizer pass2.
184 (autoload 'byte-optimize-lapcode
"byte-opt")
185 (autoload 'byte-compile-unfold-lambda
"byte-opt")
187 ;; This is the entry point to the decompiler, which is used by the
188 ;; disassembler. The disassembler just requires 'byte-compile, but
189 ;; that doesn't define this function, so this seems to be a reasonable
191 (autoload 'byte-decompile-bytecode
"byte-opt")
193 (defcustom byte-compile-verbose
194 (and (not noninteractive
) (> baud-rate search-slow-speed
))
195 "Non-nil means print messages describing progress of byte-compiler."
199 (defcustom byte-optimize t
200 "Enable optimization in the byte compiler.
202 nil - no optimization
203 t - all optimizations
204 `source' - source-level optimizations only
205 `byte' - code-level optimizations only"
207 :type
'(choice (const :tag
"none" nil
)
209 (const :tag
"source-level" source
)
210 (const :tag
"byte-level" byte
)))
212 (defcustom byte-compile-delete-errors nil
213 "If non-nil, the optimizer may delete forms that may signal an error.
214 This includes variable references and calls to functions such as `car'."
218 (defvar byte-compile-dynamic nil
219 "If non-nil, compile function bodies so they load lazily.
220 They are hidden in comments in the compiled file,
221 and each one is brought into core when the
224 To enable this option, make it a file-local variable
225 in the source file you want it to apply to.
226 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
228 When this option is true, if you load the compiled file and then move it,
229 the functions you loaded will not be able to run.")
230 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
232 (defvar byte-compile-disable-print-circle nil
233 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
234 (make-obsolete-variable 'byte-compile-disable-print-circle nil
"24.1")
235 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
237 (defcustom byte-compile-dynamic-docstrings t
238 "If non-nil, compile doc strings for lazy access.
239 We bury the doc strings of functions and variables inside comments in
240 the file, and bring them into core only when they are actually needed.
242 When this option is true, if you load the compiled file and then move it,
243 you won't be able to find the documentation of anything in that file.
245 To disable this option for a certain file, make it a file-local variable
246 in the source file. For example, add this to the first line:
247 -*-byte-compile-dynamic-docstrings:nil;-*-
248 You can also set the variable globally.
250 This option is enabled by default because it reduces Emacs memory usage."
253 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
255 (defconst byte-compile-log-buffer
"*Compile-Log*"
256 "Name of the byte-compiler's log buffer.")
258 (defcustom byte-optimize-log nil
259 "If non-nil, the byte-compiler will log its optimizations.
260 If this is 'source, then only source-level optimizations will be logged.
261 If it is 'byte, then only byte-level optimizations will be logged.
262 The information is logged to `byte-compile-log-buffer'."
264 :type
'(choice (const :tag
"none" nil
)
266 (const :tag
"source-level" source
)
267 (const :tag
"byte-level" byte
)))
269 (defcustom byte-compile-error-on-warn nil
270 "If true, the byte-compiler reports warnings with `error'."
274 (defconst byte-compile-warning-types
275 '(redefine callargs free-vars unresolved
276 obsolete noruntime cl-functions interactive-only
277 make-local mapcar constants suspicious lexical
)
278 "The list of warning types used when `byte-compile-warnings' is t.")
279 (defcustom byte-compile-warnings t
280 "List of warnings that the byte-compiler should issue (t for all).
282 Elements of the list may be:
284 free-vars references to variables not in the current lexical scope.
285 unresolved calls to unknown functions.
286 callargs function calls with args that don't match the definition.
287 redefine function name redefined from a macro to ordinary function or vice
288 versa, or redefined to take a different number of arguments.
289 obsolete obsolete variables and functions.
290 noruntime functions that may not be defined at runtime (typically
291 defined only under `eval-when-compile').
292 cl-functions calls to runtime functions from the CL package (as
293 distinguished from macros and aliases).
295 commands that normally shouldn't be called from Lisp code.
296 make-local calls to make-variable-buffer-local that may be incorrect.
297 mapcar mapcar called for effect.
298 constants let-binding of, or assignment to, constants/nonvariables.
299 suspicious constructs that usually don't do what the coder wanted.
301 If the list begins with `not', then the remaining elements specify warnings to
302 suppress. For example, (not mapcar) will suppress warnings about mapcar."
304 :type
`(choice (const :tag
"All" t
)
305 (set :menu-tag
"Some"
306 ,@(mapcar (lambda (x) `(const ,x
))
307 byte-compile-warning-types
))))
310 (put 'byte-compile-warnings
'safe-local-variable
313 (null (delq nil
(mapcar (lambda (x) (not (symbolp x
))) v
))))))
315 (defun byte-compile-warning-enabled-p (warning)
316 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
317 (or (eq byte-compile-warnings t
)
318 (if (eq (car byte-compile-warnings
) 'not
)
319 (not (memq warning byte-compile-warnings
))
320 (memq warning byte-compile-warnings
))))
323 (defun byte-compile-disable-warning (warning)
324 "Change `byte-compile-warnings' to disable WARNING.
325 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
326 Otherwise, if the first element is `not', add WARNING, else remove it.
327 Normally you should let-bind `byte-compile-warnings' before calling this,
328 else the global value will be modified."
329 (setq byte-compile-warnings
330 (cond ((eq byte-compile-warnings t
)
332 ((eq (car byte-compile-warnings
) 'not
)
333 (if (memq warning byte-compile-warnings
)
334 byte-compile-warnings
335 (append byte-compile-warnings
(list warning
))))
337 (delq warning byte-compile-warnings
)))))
340 (defun byte-compile-enable-warning (warning)
341 "Change `byte-compile-warnings' to enable WARNING.
342 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
343 first element is `not', remove WARNING, else add it.
344 Normally you should let-bind `byte-compile-warnings' before calling this,
345 else the global value will be modified."
346 (or (eq byte-compile-warnings t
)
347 (setq byte-compile-warnings
348 (cond ((eq (car byte-compile-warnings
) 'not
)
349 (delq warning byte-compile-warnings
))
350 ((memq warning byte-compile-warnings
)
351 byte-compile-warnings
)
353 (append byte-compile-warnings
(list warning
)))))))
355 (defvar byte-compile-interactive-only-functions
356 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
357 insert-file insert-buffer insert-file-literally previous-line next-line
358 goto-line comint-run delete-backward-char
)
359 "List of commands that are not meant to be called from Lisp.")
361 (defvar byte-compile-not-obsolete-vars nil
362 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
364 (defvar byte-compile-not-obsolete-funcs nil
365 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
367 (defcustom byte-compile-generate-call-tree nil
368 "Non-nil means collect call-graph information when compiling.
369 This records which functions were called and from where.
370 If the value is t, compilation displays the call graph when it finishes.
371 If the value is neither t nor nil, compilation asks you whether to display
374 The call tree only lists functions called, not macros used. Those functions
375 which the byte-code interpreter knows about directly (eq, cons, etc.) are
378 The call tree also lists those functions which are not known to be called
379 \(that is, to which no calls have been compiled). Functions which can be
380 invoked interactively are excluded from this list."
382 :type
'(choice (const :tag
"Yes" t
) (const :tag
"No" nil
)
383 (other :tag
"Ask" lambda
)))
385 (defvar byte-compile-call-tree nil
386 "Alist of functions and their call tree.
387 Each element looks like
389 \(FUNCTION CALLERS CALLS\)
391 where CALLERS is a list of functions that call FUNCTION, and CALLS
392 is a list of functions for which calls were generated while compiling
395 (defcustom byte-compile-call-tree-sort
'name
396 "If non-nil, sort the call tree.
397 The values `name', `callers', `calls', `calls+callers'
398 specify different fields to sort on."
400 :type
'(choice (const name
) (const callers
) (const calls
)
401 (const calls
+callers
) (const nil
)))
403 (defvar byte-compile-debug nil
)
404 (defvar byte-compile-constants nil
405 "List of all constants encountered during compilation of this form.")
406 (defvar byte-compile-variables nil
407 "List of all variables encountered during compilation of this form.")
408 (defvar byte-compile-bound-variables nil
409 "List of dynamic variables bound in the context of the current form.
410 This list lives partly on the stack.")
411 (defvar byte-compile-const-variables nil
412 "List of variables declared as constants during compilation of this file.")
413 (defvar byte-compile-free-references
)
414 (defvar byte-compile-free-assignments
)
416 (defvar byte-compiler-error-flag
)
418 (defconst byte-compile-initial-macro-environment
420 ;; (byte-compiler-options . (lambda (&rest forms)
421 ;; (apply 'byte-compiler-options-handler forms)))
422 (declare-function . byte-compile-macroexpand-declare-function
)
423 (eval-when-compile .
(lambda (&rest body
)
427 (byte-compile-top-level
428 (byte-compile-preprocess (cons 'progn body
)))))))
429 (eval-and-compile .
(lambda (&rest body
)
430 (byte-compile-eval-before-compile (cons 'progn body
))
431 (cons 'progn body
))))
432 "The default macro-environment passed to macroexpand by the compiler.
433 Placing a macro here will cause a macro to have different semantics when
434 expanded by the compiler as when expanded by the interpreter.")
436 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
437 "Alist of macros defined in the file being compiled.
438 Each element looks like (MACRONAME . DEFINITION). It is
439 \(MACRONAME . nil) when a macro is redefined as a function.")
441 (defvar byte-compile-function-environment nil
442 "Alist of functions defined in the file being compiled.
443 This is so we can inline them when necessary.
444 Each element looks like (FUNCTIONNAME . DEFINITION). It is
445 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
446 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
447 and we don't know the definition. For an autoloaded function, DEFINITION
448 has the form (autoload . FILENAME).")
450 (defvar byte-compile-unresolved-functions nil
451 "Alist of undefined functions to which calls have been compiled.
452 This variable is only significant whilst compiling an entire buffer.
453 Used for warnings when a function is not known to be defined or is later
454 defined with incorrect args.")
456 (defvar byte-compile-noruntime-functions nil
457 "Alist of functions called that may not be defined when the compiled code is run.
458 Used for warnings about calling a function that is defined during compilation
459 but won't necessarily be defined when the compiled file is loaded.")
461 ;; Variables for lexical binding
462 (defvar byte-compile--lexical-environment nil
463 "The current lexical environment.")
465 (defvar byte-compile-tag-number
0)
466 (defvar byte-compile-output nil
467 "Alist describing contents to put in byte code string.
468 Each element is (INDEX . VALUE)")
469 (defvar byte-compile-depth
0 "Current depth of execution stack.")
470 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
473 ;;; The byte codes; this information is duplicated in bytecomp.c
475 (defvar byte-code-vector nil
476 "An array containing byte-code names indexed by byte-code values.")
478 (defvar byte-stack
+-info nil
479 "An array with the stack adjustment for each byte-code.")
481 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
482 ;; This is a speed-hack for building the byte-code-vector at compile-time.
483 ;; We fill in the vector at macroexpand-time, and then after the last call
484 ;; to byte-defop, we write the vector out as a constant instead of writing
485 ;; out a bunch of calls to aset.
486 ;; Actually, we don't fill in the vector itself, because that could make
487 ;; it problematic to compile big changes to this compiler; we store the
488 ;; values on its plist, and remove them later in -extrude.
489 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
490 (put 'byte-code-vector
'tmp-compile-time-value
491 (make-vector 256 nil
))))
492 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
493 (put 'byte-stack
+-info
'tmp-compile-time-value
494 (make-vector 256 nil
)))))
495 (aset v1 opcode opname
)
496 (aset v2 opcode stack-adjust
))
498 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
499 (list 'defconst opname opcode
)))
501 (defmacro byte-extrude-byte-code-vectors
()
502 (prog1 (list 'setq
'byte-code-vector
503 (get 'byte-code-vector
'tmp-compile-time-value
)
505 (get 'byte-stack
+-info
'tmp-compile-time-value
))
506 (put 'byte-code-vector
'tmp-compile-time-value nil
)
507 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
510 ;; These opcodes are special in that they pack their argument into the
513 (byte-defop 0 1 byte-stack-ref
"for stack reference")
514 (byte-defop 8 1 byte-varref
"for variable reference")
515 (byte-defop 16 -
1 byte-varset
"for setting a variable")
516 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
517 (byte-defop 32 0 byte-call
"for calling a function")
518 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
519 ;; codes 8-47 are consumed by the preceding opcodes
523 (byte-defop 56 -
1 byte-nth
)
524 (byte-defop 57 0 byte-symbolp
)
525 (byte-defop 58 0 byte-consp
)
526 (byte-defop 59 0 byte-stringp
)
527 (byte-defop 60 0 byte-listp
)
528 (byte-defop 61 -
1 byte-eq
)
529 (byte-defop 62 -
1 byte-memq
)
530 (byte-defop 63 0 byte-not
)
531 (byte-defop 64 0 byte-car
)
532 (byte-defop 65 0 byte-cdr
)
533 (byte-defop 66 -
1 byte-cons
)
534 (byte-defop 67 0 byte-list1
)
535 (byte-defop 68 -
1 byte-list2
)
536 (byte-defop 69 -
2 byte-list3
)
537 (byte-defop 70 -
3 byte-list4
)
538 (byte-defop 71 0 byte-length
)
539 (byte-defop 72 -
1 byte-aref
)
540 (byte-defop 73 -
2 byte-aset
)
541 (byte-defop 74 0 byte-symbol-value
)
542 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
543 (byte-defop 76 -
1 byte-set
)
544 (byte-defop 77 -
1 byte-fset
) ; this was commented out
545 (byte-defop 78 -
1 byte-get
)
546 (byte-defop 79 -
2 byte-substring
)
547 (byte-defop 80 -
1 byte-concat2
)
548 (byte-defop 81 -
2 byte-concat3
)
549 (byte-defop 82 -
3 byte-concat4
)
550 (byte-defop 83 0 byte-sub1
)
551 (byte-defop 84 0 byte-add1
)
552 (byte-defop 85 -
1 byte-eqlsign
)
553 (byte-defop 86 -
1 byte-gtr
)
554 (byte-defop 87 -
1 byte-lss
)
555 (byte-defop 88 -
1 byte-leq
)
556 (byte-defop 89 -
1 byte-geq
)
557 (byte-defop 90 -
1 byte-diff
)
558 (byte-defop 91 0 byte-negate
)
559 (byte-defop 92 -
1 byte-plus
)
560 (byte-defop 93 -
1 byte-max
)
561 (byte-defop 94 -
1 byte-min
)
562 (byte-defop 95 -
1 byte-mult
) ; v19 only
563 (byte-defop 96 1 byte-point
)
564 (byte-defop 98 0 byte-goto-char
)
565 (byte-defop 99 0 byte-insert
)
566 (byte-defop 100 1 byte-point-max
)
567 (byte-defop 101 1 byte-point-min
)
568 (byte-defop 102 0 byte-char-after
)
569 (byte-defop 103 1 byte-following-char
)
570 (byte-defop 104 1 byte-preceding-char
)
571 (byte-defop 105 1 byte-current-column
)
572 (byte-defop 106 0 byte-indent-to
)
573 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
574 (byte-defop 108 1 byte-eolp
)
575 (byte-defop 109 1 byte-eobp
)
576 (byte-defop 110 1 byte-bolp
)
577 (byte-defop 111 1 byte-bobp
)
578 (byte-defop 112 1 byte-current-buffer
)
579 (byte-defop 113 0 byte-set-buffer
)
580 (byte-defop 114 0 byte-save-current-buffer
581 "To make a binding to record the current buffer")
582 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
583 (byte-defop 116 1 byte-interactive-p-OBSOLETE
)
585 ;; These ops are new to v19
586 (byte-defop 117 0 byte-forward-char
)
587 (byte-defop 118 0 byte-forward-word
)
588 (byte-defop 119 -
1 byte-skip-chars-forward
)
589 (byte-defop 120 -
1 byte-skip-chars-backward
)
590 (byte-defop 121 0 byte-forward-line
)
591 (byte-defop 122 0 byte-char-syntax
)
592 (byte-defop 123 -
1 byte-buffer-substring
)
593 (byte-defop 124 -
1 byte-delete-region
)
594 (byte-defop 125 -
1 byte-narrow-to-region
)
595 (byte-defop 126 1 byte-widen
)
596 (byte-defop 127 0 byte-end-of-line
)
600 ;; These store their argument in the next two bytes
601 (byte-defop 129 1 byte-constant2
602 "for reference to a constant with vector index >= byte-constant-limit")
603 (byte-defop 130 0 byte-goto
"for unconditional jump")
604 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
605 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
606 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
607 "to examine top-of-stack, jump and don't pop it if it's nil,
609 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
610 "to examine top-of-stack, jump and don't pop it if it's non nil,
613 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
614 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
615 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
617 (byte-defop 138 0 byte-save-excursion
618 "to make a binding to record the buffer, point and mark")
619 (byte-defop 139 0 byte-save-window-excursion-OBSOLETE
620 "to make a binding to record entire window configuration")
621 (byte-defop 140 0 byte-save-restriction
622 "to make a binding to record the current buffer clipping restrictions")
623 (byte-defop 141 -
1 byte-catch
624 "for catch. Takes, on stack, the tag and an expression for the body")
625 (byte-defop 142 -
1 byte-unwind-protect
626 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
628 ;; For condition-case. Takes, on stack, the variable to bind,
629 ;; an expression for the body, and a list of clauses.
630 (byte-defop 143 -
2 byte-condition-case
)
632 (byte-defop 144 0 byte-temp-output-buffer-setup-OBSOLETE
)
633 (byte-defop 145 -
1 byte-temp-output-buffer-show-OBSOLETE
)
635 ;; these ops are new to v19
637 ;; To unbind back to the beginning of this frame.
638 ;; Not used yet, but will be needed for tail-recursion elimination.
639 (byte-defop 146 0 byte-unbind-all
)
641 ;; these ops are new to v19
642 (byte-defop 147 -
2 byte-set-marker
)
643 (byte-defop 148 0 byte-match-beginning
)
644 (byte-defop 149 0 byte-match-end
)
645 (byte-defop 150 0 byte-upcase
)
646 (byte-defop 151 0 byte-downcase
)
647 (byte-defop 152 -
1 byte-string
=)
648 (byte-defop 153 -
1 byte-string
<)
649 (byte-defop 154 -
1 byte-equal
)
650 (byte-defop 155 -
1 byte-nthcdr
)
651 (byte-defop 156 -
1 byte-elt
)
652 (byte-defop 157 -
1 byte-member
)
653 (byte-defop 158 -
1 byte-assq
)
654 (byte-defop 159 0 byte-nreverse
)
655 (byte-defop 160 -
1 byte-setcar
)
656 (byte-defop 161 -
1 byte-setcdr
)
657 (byte-defop 162 0 byte-car-safe
)
658 (byte-defop 163 0 byte-cdr-safe
)
659 (byte-defop 164 -
1 byte-nconc
)
660 (byte-defop 165 -
1 byte-quo
)
661 (byte-defop 166 -
1 byte-rem
)
662 (byte-defop 167 0 byte-numberp
)
663 (byte-defop 168 0 byte-integerp
)
666 (byte-defop 175 nil byte-listN
)
667 (byte-defop 176 nil byte-concatN
)
668 (byte-defop 177 nil byte-insertN
)
670 (byte-defop 178 -
1 byte-stack-set
) ; Stack offset in following one byte.
671 (byte-defop 179 -
1 byte-stack-set2
) ; Stack offset in following two bytes.
673 ;; If (following one byte & 0x80) == 0
674 ;; discard (following one byte & 0x7F) stack entries
676 ;; discard (following one byte & 0x7F) stack entries _underneath_ TOS
677 ;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
678 (byte-defop 182 nil byte-discardN
)
679 ;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
680 ;; `byte-discardN' with the high bit in the operand set (by
681 ;; `byte-compile-lapcode').
682 (defconst byte-discardN-preserve-tos byte-discardN
)
686 (byte-defop 192 1 byte-constant
"for reference to a constant")
687 ;; codes 193-255 are consumed by byte-constant.
688 (defconst byte-constant-limit
64
689 "Exclusive maximum index usable in the `byte-constant' opcode.")
691 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
692 byte-goto-if-nil-else-pop
693 byte-goto-if-not-nil-else-pop
)
694 "List of byte-codes whose offset is a pc.")
696 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
698 (byte-extrude-byte-code-vectors)
700 ;;; lapcode generator
702 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
703 ;; source -> bytecode, because it's a lot easier to make optimizations
704 ;; on lapcode than on bytecode.
706 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
707 ;; where instruction is a symbol naming a byte-code instruction,
708 ;; and parameter is an argument to that instruction, if any.
710 ;; The instruction can be the pseudo-op TAG, which means that this position
711 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
712 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
713 ;; parameter for some goto op.
715 ;; If the operation is varbind, varref, varset or push-constant, then the
716 ;; parameter is (variable/constant . index_in_constant_vector).
718 ;; First, the source code is macroexpanded and optimized in various ways.
719 ;; Then the resultant code is compiled into lapcode. Another set of
720 ;; optimizations are then run over the lapcode. Then the variables and
721 ;; constants referenced by the lapcode are collected and placed in the
722 ;; constants-vector. (This happens now so that variables referenced by dead
723 ;; code don't consume space.) And finally, the lapcode is transformed into
724 ;; compacted byte-code.
726 ;; A distinction is made between variables and constants because the variable-
727 ;; referencing instructions are more sensitive to the variables being near the
728 ;; front of the constants-vector than the constant-referencing instructions.
729 ;; Also, this lets us notice references to free variables.
731 (defmacro byte-compile-push-bytecodes
(&rest args
)
732 "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
733 ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
734 BYTES and PC are updated after evaluating all the arguments."
735 (let ((byte-exprs (butlast args
2))
736 (bytes-var (car (last args
2)))
737 (pc-var (car (last args
))))
738 `(setq ,bytes-var
,(if (null (cdr byte-exprs
))
739 `(progn (assert (<= 0 ,(car byte-exprs
)))
740 (cons ,@byte-exprs
,bytes-var
))
741 `(nconc (list ,@(reverse byte-exprs
)) ,bytes-var
))
742 ,pc-var
(+ ,(length byte-exprs
) ,pc-var
))))
744 (defmacro byte-compile-push-bytecode-const2
(opcode const2 bytes pc
)
745 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
746 CONST2 may be evaulated multiple times."
747 `(byte-compile-push-bytecodes ,opcode
(logand ,const2
255) (lsh ,const2 -
8)
750 (defun byte-compile-lapcode (lap)
751 "Turns lapcode into bytecode. The lapcode is destroyed."
752 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
753 (let ((pc 0) ; Program counter
754 op off
; Operation & offset
755 opcode
; numeric value of OP
756 (bytes '()) ; Put the output bytes here
757 (patchlist nil
)) ; List of gotos to patch
758 (dolist (lap-entry lap
)
759 (setq op
(car lap-entry
)
763 (error "Non-symbolic opcode `%s'" op
))
768 (if (eq op
'byte-discardN-preserve-tos
)
769 ;; byte-discardN-preserve-tos is a pseudo op, which
770 ;; is actually the same as byte-discardN
771 ;; with a modified argument.
774 (cond ((memq op byte-goto-ops
)
776 (byte-compile-push-bytecodes opcode nil
(cdr off
) bytes pc
)
777 (push bytes patchlist
))
778 ((or (and (consp off
)
779 ;; Variable or constant reference
782 (eq op
'byte-constant
)))
783 (and (eq op
'byte-constant
)
786 (if (< off byte-constant-limit
)
787 (byte-compile-push-bytecodes (+ byte-constant off
)
789 (byte-compile-push-bytecode-const2 byte-constant2 off
791 ((and (= opcode byte-stack-set
)
793 ;; Use the two-byte version of byte-stack-set if the
794 ;; offset is too large for the normal version.
795 (byte-compile-push-bytecode-const2 byte-stack-set2 off
797 ((and (>= opcode byte-listN
)
798 (< opcode byte-discardN
))
799 ;; These insns all put their operand into one extra byte.
800 (byte-compile-push-bytecodes opcode off bytes pc
))
801 ((= opcode byte-discardN
)
802 ;; byte-discardN is weird in that it encodes a flag in the
803 ;; top bit of its one-byte argument. If the argument is
804 ;; too large to fit in 7 bits, the opcode can be repeated.
805 (let ((flag (if (eq op
'byte-discardN-preserve-tos
) #x80
0)))
807 (byte-compile-push-bytecodes opcode
(logior #x7f flag
)
809 (setq off
(- off
#x7f
)))
810 (byte-compile-push-bytecodes opcode
(logior off flag
)
813 ;; opcode that doesn't use OFF
814 (byte-compile-push-bytecodes opcode bytes pc
))
815 ((and (eq opcode byte-stack-ref
) (eq off
0))
816 ;; (stack-ref 0) is really just another name for `dup'.
817 (debug) ;FIXME: When would this happen?
818 (byte-compile-push-bytecodes byte-dup bytes pc
))
819 ;; The following three cases are for the special
820 ;; insns that encode their operand into 0, 1, or 2
821 ;; extra bytes depending on its magnitude.
823 (byte-compile-push-bytecodes (+ opcode off
) bytes pc
))
825 (byte-compile-push-bytecodes (+ opcode
6) off bytes pc
))
827 (byte-compile-push-bytecode-const2 (+ opcode
7) off
829 ;;(if (not (= pc (length bytes)))
830 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
831 ;; Patch tag PCs into absolute jumps.
832 (dolist (bytes-tail patchlist
)
833 (setq pc
(caar bytes-tail
)) ; Pick PC from goto's tag.
834 (setcar (cdr bytes-tail
) (logand pc
255))
835 (setcar bytes-tail
(lsh pc -
8))
836 ;; FIXME: Replace this by some workaround.
837 (if (> (car bytes
) 255) (error "Bytecode overflow")))
839 (apply 'unibyte-string
(nreverse bytes
))))
842 ;;; compile-time evaluation
844 (defun byte-compile-cl-file-p (file)
845 "Return non-nil if FILE is one of the CL files."
847 (string-match "^cl\\>" (file-name-nondirectory file
))))
849 (defun byte-compile-eval (form)
850 "Eval FORM and mark the functions defined therein.
851 Each function's symbol gets added to `byte-compile-noruntime-functions'."
852 (let ((hist-orig load-history
)
853 (hist-nil-orig current-load-list
))
854 (prog1 (eval form lexical-binding
)
855 (when (byte-compile-warning-enabled-p 'noruntime
)
856 (let ((hist-new load-history
)
857 (hist-nil-new current-load-list
))
858 ;; Go through load-history, look for newly loaded files
859 ;; and mark all the functions defined therein.
860 (while (and hist-new
(not (eq hist-new hist-orig
)))
861 (let ((xs (pop hist-new
))
863 ;; Make sure the file was not already loaded before.
864 (unless (or (assoc (car xs
) hist-orig
)
865 ;; Don't give both the "noruntime" and
866 ;; "cl-functions" warning for the same function.
867 ;; FIXME This seems incorrect - these are two
868 ;; independent warnings. For example, you may be
869 ;; choosing to see the cl warnings but ignore them.
870 ;; You probably don't want to ignore noruntime in the
872 (and (byte-compile-warning-enabled-p 'cl-functions
)
873 (byte-compile-cl-file-p (car xs
))))
877 (unless (memq s old-autoloads
)
878 (push s byte-compile-noruntime-functions
)))
879 ((and (consp s
) (eq t
(car s
)))
880 (push (cdr s
) old-autoloads
))
881 ((and (consp s
) (eq 'autoload
(car s
)))
882 (push (cdr s
) byte-compile-noruntime-functions
)))))))
883 ;; Go through current-load-list for the locally defined funs.
885 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
886 (let ((s (pop hist-nil-new
)))
887 (when (and (symbolp s
) (not (memq s old-autoloads
)))
888 (push s byte-compile-noruntime-functions
))
889 (when (and (consp s
) (eq t
(car s
)))
890 (push (cdr s
) old-autoloads
)))))))
891 (when (byte-compile-warning-enabled-p 'cl-functions
)
892 (let ((hist-new load-history
))
893 ;; Go through load-history, looking for the cl files.
894 ;; Since new files are added at the start of load-history,
895 ;; we scan the new history until the tail matches the old.
896 (while (and (not byte-compile-cl-functions
)
897 hist-new
(not (eq hist-new hist-orig
)))
898 ;; We used to check if the file had already been loaded,
899 ;; but it is better to check non-nil byte-compile-cl-functions.
900 (and (byte-compile-cl-file-p (car (pop hist-new
)))
901 (byte-compile-find-cl-functions))))))))
903 (defun byte-compile-eval-before-compile (form)
904 "Evaluate FORM for `eval-and-compile'."
905 (let ((hist-nil-orig current-load-list
))
906 (prog1 (eval form lexical-binding
)
907 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
908 ;; FIXME Why does it do that - just as a hack?
909 ;; There are other ways to do this nowadays.
910 (let ((tem current-load-list
))
911 (while (not (eq tem hist-nil-orig
))
912 (when (equal (car tem
) '(require . cl
))
913 (byte-compile-disable-warning 'cl-functions
))
914 (setq tem
(cdr tem
)))))))
916 ;;; byte compiler messages
918 (defvar byte-compile-current-form nil
)
919 (defvar byte-compile-dest-file nil
)
920 (defvar byte-compile-current-file nil
)
921 (defvar byte-compile-current-group nil
)
922 (defvar byte-compile-current-buffer nil
)
924 ;; Log something that isn't a warning.
925 (defmacro byte-compile-log
(format-string &rest args
)
928 (memq byte-optimize-log
'(t source
))
929 (let ((print-escape-newlines t
)
936 (lambda (x) (if (symbolp x
) (list 'prin1-to-string x
) x
))
939 ;; Log something that isn't a warning.
940 (defun byte-compile-log-1 (string)
941 (with-current-buffer byte-compile-log-buffer
942 (let ((inhibit-read-only t
))
943 (goto-char (point-max))
944 (byte-compile-warning-prefix nil nil
)
945 (cond (noninteractive
946 (message " %s" string
))
948 (insert (format "%s\n" string
)))))))
950 (defvar byte-compile-read-position nil
951 "Character position we began the last `read' from.")
952 (defvar byte-compile-last-position nil
953 "Last known character position in the input.")
955 ;; copied from gnus-util.el
956 (defsubst byte-compile-delete-first
(elt list
)
957 (if (eq (car list
) elt
)
960 (while (and (cdr list
)
961 (not (eq (cadr list
) elt
)))
962 (setq list
(cdr list
)))
964 (setcdr list
(cddr list
)))
967 ;; The purpose of this function is to iterate through the
968 ;; `read-symbol-positions-list'. Each time we process, say, a
969 ;; function definition (`defun') we remove `defun' from
970 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
971 ;; to that symbol's character position. Similarly, if we encounter a
972 ;; variable reference, like in (1+ foo), we remove `foo' from the
973 ;; list. If our current position is after the symbol's position, we
974 ;; assume we've already passed that point, and look for the next
975 ;; occurrence of the symbol.
977 ;; This function should not be called twice for the same occurrence of
978 ;; a symbol, and it should not be called for symbols generated by the
979 ;; byte compiler itself; because rather than just fail looking up the
980 ;; symbol, we may find an occurrence of the symbol further ahead, and
981 ;; then `byte-compile-last-position' as advanced too far.
983 ;; So your're probably asking yourself: Isn't this function a
984 ;; gross hack? And the answer, of course, would be yes.
985 (defun byte-compile-set-symbol-position (sym &optional allow-previous
)
986 (when byte-compile-read-position
989 (setq last byte-compile-last-position
990 entry
(assq sym read-symbol-positions-list
))
992 (setq byte-compile-last-position
993 (+ byte-compile-read-position
(cdr entry
))
994 read-symbol-positions-list
995 (byte-compile-delete-first
996 entry read-symbol-positions-list
)))
997 (or (and allow-previous
998 (not (= last byte-compile-last-position
)))
999 (> last byte-compile-last-position
)))))))
1001 (defvar byte-compile-last-warned-form nil
)
1002 (defvar byte-compile-last-logged-file nil
)
1004 ;; This is used as warning-prefix for the compiler.
1005 ;; It is always called with the warnings buffer current.
1006 (defun byte-compile-warning-prefix (level entry
)
1007 (let* ((inhibit-read-only t
)
1008 (dir default-directory
)
1009 (file (cond ((stringp byte-compile-current-file
)
1010 (format "%s:" (file-relative-name
1011 byte-compile-current-file dir
)))
1012 ((bufferp byte-compile-current-file
)
1013 (format "Buffer %s:"
1014 (buffer-name byte-compile-current-file
)))
1016 (pos (if (and byte-compile-current-file
1017 (integerp byte-compile-read-position
))
1018 (with-current-buffer byte-compile-current-buffer
1021 (goto-char byte-compile-last-position
)
1022 (1+ (count-lines (point-min) (point-at-bol))))
1024 (goto-char byte-compile-last-position
)
1025 (1+ (current-column)))))
1027 (form (if (eq byte-compile-current-form
:end
) "end of data"
1028 (or byte-compile-current-form
"toplevel form"))))
1029 (when (or (and byte-compile-current-file
1030 (not (equal byte-compile-current-file
1031 byte-compile-last-logged-file
)))
1032 (and byte-compile-current-form
1033 (not (eq byte-compile-current-form
1034 byte-compile-last-warned-form
))))
1035 (insert (format "\nIn %s:\n" form
)))
1037 (insert (format "%s%s" file pos
))))
1038 (setq byte-compile-last-logged-file byte-compile-current-file
1039 byte-compile-last-warned-form byte-compile-current-form
)
1042 ;; This no-op function is used as the value of warning-series
1043 ;; to tell inner calls to displaying-byte-compile-warnings
1044 ;; not to bind warning-series.
1045 (defun byte-compile-warning-series (&rest _ignore
)
1048 ;; (compile-mode) will cause this to be loaded.
1049 (declare-function compilation-forget-errors
"compile" ())
1051 ;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
1052 ;; Return the position of the start of the page in the log buffer.
1053 ;; But do nothing in batch mode.
1054 (defun byte-compile-log-file ()
1055 (and (not (equal byte-compile-current-file byte-compile-last-logged-file
))
1056 (not noninteractive
)
1057 (with-current-buffer (get-buffer-create byte-compile-log-buffer
)
1058 (goto-char (point-max))
1059 (let* ((inhibit-read-only t
)
1060 (dir (and byte-compile-current-file
1061 (file-name-directory byte-compile-current-file
)))
1062 (was-same (equal default-directory dir
))
1066 (insert (format "Leaving directory `%s'\n" default-directory
))))
1069 (setq pt
(point-marker))
1070 (if byte-compile-current-file
1071 (insert "\f\nCompiling "
1072 (if (stringp byte-compile-current-file
)
1073 (concat "file " byte-compile-current-file
)
1075 (buffer-name byte-compile-current-file
)))
1076 " at " (current-time-string) "\n")
1077 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1079 (setq default-directory dir
)
1081 (insert (format "Entering directory `%s'\n"
1082 default-directory
))))
1083 (setq byte-compile-last-logged-file byte-compile-current-file
1084 byte-compile-last-warned-form nil
)
1085 ;; Do this after setting default-directory.
1086 (unless (derived-mode-p 'compilation-mode
) (compilation-mode))
1087 (compilation-forget-errors)
1090 ;; Log a message STRING in `byte-compile-log-buffer'.
1091 ;; Also log the current function and file if not already done.
1092 (defun byte-compile-log-warning (string &optional fill level
)
1093 (let ((warning-prefix-function 'byte-compile-warning-prefix
)
1094 (warning-type-format "")
1095 (warning-fill-prefix (if fill
" "))
1096 (inhibit-read-only t
))
1097 (display-warning 'bytecomp string level byte-compile-log-buffer
)))
1099 (defun byte-compile-warn (format &rest args
)
1100 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1101 (setq format
(apply 'format format args
))
1102 (if byte-compile-error-on-warn
1103 (error "%s" format
) ; byte-compile-file catches and logs it
1104 (byte-compile-log-warning format t
:warning
)))
1106 (defun byte-compile-warn-obsolete (symbol)
1107 "Warn that SYMBOL (a variable or function) is obsolete."
1108 (when (byte-compile-warning-enabled-p 'obsolete
)
1109 (let* ((funcp (get symbol
'byte-obsolete-info
))
1110 (obsolete (or funcp
(get symbol
'byte-obsolete-variable
)))
1111 (instead (car obsolete
))
1112 (asof (if funcp
(nth 2 obsolete
) (cdr obsolete
))))
1113 (unless (and funcp
(memq symbol byte-compile-not-obsolete-funcs
))
1114 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1115 (if funcp
"function" "variable")
1116 (if asof
(concat " (as of Emacs " asof
")") "")
1117 (cond ((stringp instead
)
1118 (concat "; " instead
))
1120 (format "; use `%s' instead." instead
))
1123 (defun byte-compile-report-error (error-info)
1124 "Report Lisp error in compilation. ERROR-INFO is the error data."
1125 (setq byte-compiler-error-flag t
)
1126 (byte-compile-log-warning
1127 (error-message-string error-info
)
1130 ;;; sanity-checking arglists
1132 (defun byte-compile-fdefinition (name macro-p
)
1133 ;; If a function has an entry saying (FUNCTION . t).
1134 ;; that means we know it is defined but we don't know how.
1135 ;; If a function has an entry saying (FUNCTION . nil),
1136 ;; that means treat it as not defined.
1137 (let* ((list (if macro-p
1138 byte-compile-macro-environment
1139 byte-compile-function-environment
))
1140 (env (cdr (assq name list
))))
1143 (while (and (symbolp fn
)
1145 (or (symbolp (symbol-function fn
))
1146 (consp (symbol-function fn
))
1148 (byte-code-function-p (symbol-function fn
)))))
1149 (setq fn
(symbol-function fn
)))
1150 (let ((advertised (gethash (if (and (symbolp fn
) (fboundp fn
))
1152 (symbol-function fn
)
1154 advertised-signature-table t
)))
1158 `(macro lambda
,advertised
)
1159 `(lambda ,advertised
)))
1160 ((and (not macro-p
) (byte-code-function-p fn
)) fn
)
1161 ((not (consp fn
)) nil
)
1162 ((eq 'macro
(car fn
)) (cdr fn
))
1164 ((eq 'autoload
(car fn
)) nil
)
1167 (defun byte-compile-arglist-signature (arglist)
1168 (if (integerp arglist
)
1169 ;; New style byte-code arglist.
1170 (cons (logand arglist
127) ;Mandatory.
1171 (if (zerop (logand arglist
128)) ;No &rest.
1172 (lsh arglist -
8))) ;Nonrest.
1173 ;; Old style byte-code, or interpreted function.
1178 (cond ((eq (car arglist
) '&optional
)
1179 (or opts
(setq opts
0)))
1180 ((eq (car arglist
) '&rest
)
1186 (setq opts
(1+ opts
))
1187 (setq args
(1+ args
)))))
1188 (setq arglist
(cdr arglist
)))
1189 (cons args
(if restp nil
(if opts
(+ args opts
) args
))))))
1192 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1194 (> (car new
) (car old
)) ; requires more args now
1195 (and (null (cdr old
)) ; took rest-args, doesn't any more
1197 (and (cdr new
) (cdr old
) ; can't take as many args now
1198 (< (cdr new
) (cdr old
)))
1201 (defun byte-compile-arglist-signature-string (signature)
1202 (cond ((null (cdr signature
))
1203 (format "%d+" (car signature
)))
1204 ((= (car signature
) (cdr signature
))
1205 (format "%d" (car signature
)))
1206 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1209 ;; Warn if the form is calling a function with the wrong number of arguments.
1210 (defun byte-compile-callargs-warn (form)
1211 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1212 (byte-compile-fdefinition (car form
) t
)))
1213 (sig (if (and def
(not (eq def t
)))
1215 (and (eq (car-safe def
) 'macro
)
1216 (eq (car-safe (cdr-safe def
)) 'lambda
)
1217 (setq def
(cdr def
)))
1218 (byte-compile-arglist-signature
1219 (if (memq (car-safe def
) '(declared lambda
))
1221 (if (byte-code-function-p def
)
1224 (if (and (fboundp (car form
))
1225 (subrp (symbol-function (car form
))))
1226 (subr-arity (symbol-function (car form
))))))
1227 (ncall (length (cdr form
))))
1228 ;; Check many or unevalled from subr-arity.
1229 (if (and (cdr-safe sig
)
1230 (not (numberp (cdr sig
))))
1233 (when (or (< ncall
(car sig
))
1234 (and (cdr sig
) (> ncall
(cdr sig
))))
1235 (byte-compile-set-symbol-position (car form
))
1237 "%s called with %d argument%s, but %s %s"
1239 (if (= 1 ncall
) "" "s")
1240 (if (< ncall
(car sig
))
1243 (byte-compile-arglist-signature-string sig
))))
1244 (byte-compile-format-warn form
)
1245 ;; Check to see if the function will be available at runtime
1246 ;; and/or remember its arity if it's unknown.
1247 (or (and (or def
(fboundp (car form
))) ; might be a subr or autoload.
1248 (not (memq (car form
) byte-compile-noruntime-functions
)))
1249 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1251 ;; It's a currently-undefined function.
1252 ;; Remember number of args in call.
1253 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1254 (n (length (cdr form
))))
1256 (or (memq n
(cdr cons
))
1257 (setcdr cons
(cons n
(cdr cons
))))
1258 (push (list (car form
) n
)
1259 byte-compile-unresolved-functions
))))))
1261 (defun byte-compile-format-warn (form)
1262 "Warn if FORM is `format'-like with inconsistent args.
1263 Applies if head of FORM is a symbol with non-nil property
1264 `byte-compile-format-like' and first arg is a constant string.
1265 Then check the number of format fields matches the number of
1267 (when (and (symbolp (car form
))
1268 (stringp (nth 1 form
))
1269 (get (car form
) 'byte-compile-format-like
))
1270 (let ((nfields (with-temp-buffer
1271 (insert (nth 1 form
))
1272 (goto-char (point-min))
1274 (while (re-search-forward "%." nil t
)
1275 (unless (eq ?%
(char-after (1+ (match-beginning 0))))
1278 (nargs (- (length form
) 2)))
1279 (unless (= nargs nfields
)
1281 "`%s' called with %d args to fill %d format field(s)" (car form
)
1284 (dolist (elt '(format message error
))
1285 (put elt
'byte-compile-format-like t
))
1287 ;; Warn if a custom definition fails to specify :group.
1288 (defun byte-compile-nogroup-warn (form)
1289 (if (and (memq (car form
) '(custom-declare-face custom-declare-variable
))
1290 byte-compile-current-group
)
1291 ;; The group will be provided implicitly.
1293 (let ((keyword-args (cdr (cdr (cdr (cdr form
)))))
1295 (or (not (eq (car-safe name
) 'quote
))
1296 (and (eq (car form
) 'custom-declare-group
)
1297 (equal name
''emacs
))
1298 (plist-get keyword-args
:group
)
1299 (not (and (consp name
) (eq (car name
) 'quote
)))
1301 "%s for `%s' fails to specify containing group"
1302 (cdr (assq (car form
)
1303 '((custom-declare-group . defgroup
)
1304 (custom-declare-face . defface
)
1305 (custom-declare-variable . defcustom
))))
1307 ;; Update the current group, if needed.
1308 (if (and byte-compile-current-file
;Only when compiling a whole file.
1309 (eq (car form
) 'custom-declare-group
)
1310 (eq (car-safe name
) 'quote
))
1311 (setq byte-compile-current-group
(cadr name
))))))
1313 ;; Warn if the function or macro is being redefined with a different
1314 ;; number of arguments.
1315 (defun byte-compile-arglist-warn (form macrop
)
1316 (let* ((name (nth 1 form
))
1317 (old (byte-compile-fdefinition name macrop
)))
1318 (if (and old
(not (eq old t
)))
1320 (and (eq 'macro
(car-safe old
))
1321 (eq 'lambda
(car-safe (cdr-safe old
)))
1322 (setq old
(cdr old
)))
1323 (let ((sig1 (byte-compile-arglist-signature
1325 (`(lambda ,args .
,_
) args
)
1326 (`(closure ,_
,args .
,_
) args
)
1327 ((pred byte-code-function-p
) (aref old
0))
1329 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1330 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1331 (byte-compile-set-symbol-position name
)
1333 "%s %s used to take %s %s, now takes %s"
1334 (if (eq (car form
) 'defun
) "function" "macro")
1336 (byte-compile-arglist-signature-string sig1
)
1337 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1338 (byte-compile-arglist-signature-string sig2
)))))
1339 ;; This is the first definition. See if previous calls are compatible.
1340 (let ((calls (assq name byte-compile-unresolved-functions
))
1343 (when (and (symbolp name
)
1344 (eq (get name
'byte-optimizer
)
1345 'byte-compile-inline-expand
))
1346 (byte-compile-warn "defsubst `%s' was used before it was defined"
1348 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1349 nums
(sort (copy-sequence (cdr calls
)) (function <))
1351 max
(car (nreverse nums
)))
1352 (when (or (< min
(car sig
))
1353 (and (cdr sig
) (> max
(cdr sig
))))
1354 (byte-compile-set-symbol-position name
)
1356 "%s being defined to take %s%s, but was previously called with %s"
1358 (byte-compile-arglist-signature-string sig
)
1359 (if (equal sig
'(1 .
1)) " arg" " args")
1360 (byte-compile-arglist-signature-string (cons min max
))))
1362 (setq byte-compile-unresolved-functions
1363 (delq calls byte-compile-unresolved-functions
)))))))
1365 (defvar byte-compile-cl-functions nil
1366 "List of functions defined in CL.")
1368 ;; Can't just add this to cl-load-hook, because that runs just before
1369 ;; the forms from cl.el get added to load-history.
1370 (defun byte-compile-find-cl-functions ()
1371 (unless byte-compile-cl-functions
1372 (dolist (elt load-history
)
1373 (and (byte-compile-cl-file-p (car elt
))
1374 (dolist (e (cdr elt
))
1375 ;; Includes the cl-foo functions that cl autoloads.
1376 (when (memq (car-safe e
) '(autoload defun
))
1377 (push (cdr e
) byte-compile-cl-functions
)))))))
1379 (defun byte-compile-cl-warn (form)
1380 "Warn if FORM is a call of a function from the CL package."
1381 (let ((func (car-safe form
)))
1382 (if (and byte-compile-cl-functions
1383 (memq func byte-compile-cl-functions
)
1384 ;; Aliases which won't have been expanded at this point.
1385 ;; These aren't all aliases of subrs, so not trivial to
1386 ;; avoid hardwiring the list.
1388 '(cl-block-wrapper cl-block-throw
1389 multiple-value-call nth-value
1390 copy-seq first second rest endp cl-member
1391 ;; These are included in generated code
1392 ;; that can't be called except at compile time
1393 ;; or unless cl is loaded anyway.
1394 cl-defsubst-expand cl-struct-setf-expander
1395 ;; These would sometimes be warned about
1396 ;; but such warnings are never useful,
1397 ;; so don't warn about them.
1398 macroexpand cl-macroexpand-all
1399 cl-compiling-file
))))
1400 (byte-compile-warn "function `%s' from cl package called at runtime"
1404 (defun byte-compile-print-syms (str1 strn syms
)
1406 (byte-compile-set-symbol-position (car syms
) t
))
1407 (cond ((and (cdr syms
) (not noninteractive
))
1412 (setq s
(symbol-name (pop syms
))
1413 L
(+ L
(length s
) 2))
1414 (if (< L
(1- fill-column
))
1415 (setq str
(concat str
" " s
(and syms
",")))
1416 (setq str
(concat str
"\n " s
(and syms
","))
1417 L
(+ (length s
) 4))))
1418 (byte-compile-warn "%s" str
)))
1420 (byte-compile-warn "%s %s"
1422 (mapconcat #'symbol-name syms
", ")))
1425 (byte-compile-warn str1
(car syms
)))))
1427 ;; If we have compiled any calls to functions which are not known to be
1428 ;; defined, issue a warning enumerating them.
1429 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1430 (defun byte-compile-warn-about-unresolved-functions ()
1431 (when (byte-compile-warning-enabled-p 'unresolved
)
1432 (let ((byte-compile-current-form :end
)
1435 ;; Separate the functions that will not be available at runtime
1436 ;; from the truly unresolved ones.
1437 (dolist (f byte-compile-unresolved-functions
)
1439 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1440 ;; Complain about the no-run-time functions
1441 (byte-compile-print-syms
1442 "the function `%s' might not be defined at runtime."
1443 "the following functions might not be defined at runtime:"
1445 ;; Complain about the unresolved functions
1446 (byte-compile-print-syms
1447 "the function `%s' is not known to be defined."
1448 "the following functions are not known to be defined:"
1453 (defsubst byte-compile-const-symbol-p
(symbol &optional any-value
)
1454 "Non-nil if SYMBOL is constant.
1455 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1457 (or (memq symbol
'(nil t
))
1460 (or (memq symbol byte-compile-const-variables
)
1461 ;; FIXME: We should provide a less intrusive way to find out
1462 ;; if a variable is "constant".
1463 (and (boundp symbol
)
1465 (progn (set symbol
(symbol-value symbol
)) nil
)
1466 (setting-constant t
)))))))
1468 (defmacro byte-compile-constp
(form)
1469 "Return non-nil if FORM is a constant."
1470 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1471 ((not (symbolp ,form
)))
1472 ((byte-compile-const-symbol-p ,form
))))
1474 (defmacro byte-compile-close-variables
(&rest body
)
1478 ;; Close over these variables to encapsulate the
1479 ;; compilation state
1481 (byte-compile-macro-environment
1482 ;; Copy it because the compiler may patch into the
1483 ;; macroenvironment.
1484 (copy-alist byte-compile-initial-macro-environment
))
1485 (byte-compile-function-environment nil
)
1486 (byte-compile-bound-variables nil
)
1487 (byte-compile-const-variables nil
)
1488 (byte-compile-free-references nil
)
1489 (byte-compile-free-assignments nil
)
1491 ;; Close over these variables so that `byte-compiler-options'
1492 ;; can change them on a per-file basis.
1494 (byte-compile-verbose byte-compile-verbose
)
1495 (byte-optimize byte-optimize
)
1496 (byte-compile-dynamic byte-compile-dynamic
)
1497 (byte-compile-dynamic-docstrings
1498 byte-compile-dynamic-docstrings
)
1499 ;; (byte-compile-generate-emacs19-bytecodes
1500 ;; byte-compile-generate-emacs19-bytecodes)
1501 (byte-compile-warnings byte-compile-warnings
)
1505 (defmacro displaying-byte-compile-warnings
(&rest body
)
1507 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body
))
1508 (warning-series-started
1509 (and (markerp warning-series
)
1510 (eq (marker-buffer warning-series
)
1511 (get-buffer byte-compile-log-buffer
)))))
1512 (byte-compile-find-cl-functions)
1513 (if (or (eq warning-series
'byte-compile-warning-series
)
1514 warning-series-started
)
1515 ;; warning-series does come from compilation,
1516 ;; so don't bind it, but maybe do set it.
1518 ;; Log the file name. Record position of that text.
1519 (setq tem
(byte-compile-log-file))
1520 (unless warning-series-started
1521 (setq warning-series
(or tem
'byte-compile-warning-series
)))
1522 (if byte-compile-debug
1523 (funcall --displaying-byte-compile-warnings-fn
)
1524 (condition-case error-info
1525 (funcall --displaying-byte-compile-warnings-fn
)
1526 (error (byte-compile-report-error error-info
)))))
1527 ;; warning-series does not come from compilation, so bind it.
1528 (let ((warning-series
1529 ;; Log the file name. Record position of that text.
1530 (or (byte-compile-log-file) 'byte-compile-warning-series
)))
1531 (if byte-compile-debug
1532 (funcall --displaying-byte-compile-warnings-fn
)
1533 (condition-case error-info
1534 (funcall --displaying-byte-compile-warnings-fn
)
1535 (error (byte-compile-report-error error-info
))))))))
1538 (defun byte-force-recompile (directory)
1539 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1540 Files in subdirectories of DIRECTORY are processed also."
1541 (interactive "DByte force recompile (directory): ")
1542 (byte-recompile-directory directory nil t
))
1545 (defun byte-recompile-directory (directory &optional arg force
)
1546 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1547 This happens when a `.elc' file exists but is older than the `.el' file.
1548 Files in subdirectories of DIRECTORY are processed also.
1550 If the `.elc' file does not exist, normally this function *does not*
1551 compile the corresponding `.el' file. However, if the prefix argument
1552 ARG is 0, that means do compile all those files. A nonzero
1553 ARG means ask the user, for each such `.el' file, whether to
1554 compile it. A nonzero ARG also means ask about each subdirectory
1557 If the third argument FORCE is non-nil, recompile every `.el' file
1558 that already has a `.elc' file."
1559 (interactive "DByte recompile directory: \nP")
1560 (if arg
(setq arg
(prefix-numeric-value arg
)))
1564 (force-mode-line-update))
1565 (with-current-buffer (get-buffer-create byte-compile-log-buffer
)
1566 (setq default-directory
(expand-file-name directory
))
1567 ;; compilation-mode copies value of default-directory.
1568 (unless (eq major-mode
'compilation-mode
)
1570 (let ((directories (list default-directory
))
1571 (default-directory default-directory
)
1577 (displaying-byte-compile-warnings
1579 (setq directory
(car directories
))
1580 (message "Checking %s..." directory
)
1581 (dolist (file (directory-files directory
))
1582 (let ((source (expand-file-name file directory
)))
1583 (if (and (not (member file
'("RCS" "CVS")))
1584 (not (eq ?\.
(aref file
0)))
1585 (file-directory-p source
)
1586 (not (file-symlink-p source
)))
1587 ;; This file is a subdirectory. Handle them differently.
1588 (when (or (null arg
) (eq 0 arg
)
1589 (y-or-n-p (concat "Check " source
"? ")))
1590 (setq directories
(nconc directories
(list source
))))
1591 ;; It is an ordinary file. Decide whether to compile it.
1592 (if (and (string-match emacs-lisp-file-regexp source
)
1593 (file-readable-p source
)
1594 (not (auto-save-file-name-p source
))
1595 (not (string-equal dir-locals-file
1596 (file-name-nondirectory source
))))
1597 (progn (case (byte-recompile-file source force arg
)
1598 (no-byte-compile (setq skip-count
(1+ skip-count
)))
1599 ((t) (setq file-count
(1+ file-count
)))
1600 ((nil) (setq fail-count
(1+ fail-count
))))
1602 (message "Checking %s..." directory
))
1603 (if (not (eq last-dir directory
))
1604 (setq last-dir directory
1605 dir-count
(1+ dir-count
)))
1607 (setq directories
(cdr directories
))))
1608 (message "Done (Total of %d file%s compiled%s%s%s)"
1609 file-count
(if (= file-count
1) "" "s")
1610 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1611 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1613 (format " in %d directories" dir-count
) "")))))
1615 (defvar no-byte-compile nil
1616 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1617 This is normally set in local file variables at the end of the elisp file:
1619 \;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
1620 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1622 (defun byte-recompile-file (filename &optional force arg load
)
1623 "Recompile FILENAME file if it needs recompilation.
1624 This happens when its `.elc' file is older than itself.
1626 If the `.elc' file exists and is up-to-date, normally this
1627 function *does not* compile FILENAME. However, if the
1628 prefix argument FORCE is set, that means do compile
1629 FILENAME even if the destination already exists and is
1632 If the `.elc' file does not exist, normally this function *does
1633 not* compile FILENAME. If ARG is 0, that means
1634 compile the file even if it has never been compiled before.
1635 A nonzero ARG means ask the user.
1637 If LOAD is set, `load' the file after compiling.
1639 The value returned is the value returned by `byte-compile-file',
1640 or 'no-byte-compile if the file did not need recompilation."
1642 (let ((file buffer-file-name
)
1646 (derived-mode-p 'emacs-lisp-mode
)
1647 (setq file-name
(file-name-nondirectory file
)
1648 file-dir
(file-name-directory file
)))
1649 (list (read-file-name (if current-prefix-arg
1650 "Byte compile file: "
1651 "Byte recompile file: ")
1652 file-dir file-name nil
)
1653 current-prefix-arg
)))
1654 (let ((dest (byte-compile-dest-file filename
))
1655 ;; Expand now so we get the current buffer's defaults
1656 (filename (expand-file-name filename
)))
1657 (if (if (file-exists-p dest
)
1658 ;; File was already compiled
1659 ;; Compile if forced to, or filename newer
1661 (file-newer-than-file-p filename dest
))
1664 (y-or-n-p (concat "Compile "
1667 (if (and noninteractive
(not byte-compile-verbose
))
1668 (message "Compiling %s..." filename
))
1669 (byte-compile-file filename load
))
1670 (when load
(load filename
))
1674 (defun byte-compile-file (filename &optional load
)
1675 "Compile a file of Lisp code named FILENAME into a file of byte code.
1676 The output file's name is generated by passing FILENAME to the
1677 function `byte-compile-dest-file' (which see).
1678 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1679 The value is non-nil if there were no errors, nil if errors."
1680 ;; (interactive "fByte compile file: \nP")
1682 (let ((file buffer-file-name
)
1686 (derived-mode-p 'emacs-lisp-mode
)
1687 (setq file-name
(file-name-nondirectory file
)
1688 file-dir
(file-name-directory file
)))
1689 (list (read-file-name (if current-prefix-arg
1690 "Byte compile and load file: "
1691 "Byte compile file: ")
1692 file-dir file-name nil
)
1693 current-prefix-arg
)))
1694 ;; Expand now so we get the current buffer's defaults
1695 (setq filename
(expand-file-name filename
))
1697 ;; If we're compiling a file that's in a buffer and is modified, offer
1698 ;; to save it first.
1700 (let ((b (get-file-buffer (expand-file-name filename
))))
1701 (if (and b
(buffer-modified-p b
)
1702 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1703 (with-current-buffer b
(save-buffer)))))
1705 ;; Force logging of the file name for each file compiled.
1706 (setq byte-compile-last-logged-file nil
)
1707 (let ((byte-compile-current-file filename
)
1708 (byte-compile-current-group nil
)
1709 (set-auto-coding-for-load t
)
1710 target-file input-buffer output-buffer
1711 byte-compile-dest-file
)
1712 (setq target-file
(byte-compile-dest-file filename
))
1713 (setq byte-compile-dest-file target-file
)
1714 (with-current-buffer
1715 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1717 (setq buffer-file-coding-system nil
)
1718 ;; Always compile an Emacs Lisp file as multibyte
1719 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1720 (set-buffer-multibyte t
)
1721 (insert-file-contents filename
)
1722 ;; Mimic the way after-insert-file-set-coding can make the
1723 ;; buffer unibyte when visiting this file.
1724 (when (or (eq last-coding-system-used
'no-conversion
)
1725 (eq (coding-system-type last-coding-system-used
) 5))
1726 ;; For coding systems no-conversion and raw-text...,
1727 ;; edit the buffer as unibyte.
1728 (set-buffer-multibyte nil
))
1729 ;; Run hooks including the uncompression hook.
1730 ;; If they change the file name, then change it for the output also.
1731 (letf ((buffer-file-name filename
)
1732 ((default-value 'major-mode
) 'emacs-lisp-mode
)
1733 ;; Ignore unsafe local variables.
1734 ;; We only care about a few of them for our purposes.
1735 (enable-local-variables :safe
)
1736 (enable-local-eval nil
))
1737 ;; Arg of t means don't alter enable-local-variables.
1739 (setq filename buffer-file-name
))
1740 ;; Set the default directory, in case an eval-when-compile uses it.
1741 (setq default-directory
(file-name-directory filename
)))
1742 ;; Check if the file's local variables explicitly specify not to
1743 ;; compile this file.
1744 (if (with-current-buffer input-buffer no-byte-compile
)
1746 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1747 ;; (file-relative-name filename)
1748 ;; (with-current-buffer input-buffer no-byte-compile))
1749 (when (file-exists-p target-file
)
1750 (message "%s deleted because of `no-byte-compile: %s'"
1751 (file-relative-name target-file
)
1752 (buffer-local-value 'no-byte-compile input-buffer
))
1753 (condition-case nil
(delete-file target-file
) (error nil
)))
1754 ;; We successfully didn't compile this file.
1756 (when byte-compile-verbose
1757 (message "Compiling %s..." filename
))
1758 (setq byte-compiler-error-flag nil
)
1759 ;; It is important that input-buffer not be current at this call,
1760 ;; so that the value of point set in input-buffer
1761 ;; within byte-compile-from-buffer lingers in that buffer.
1763 (save-current-buffer
1764 (byte-compile-from-buffer input-buffer
)))
1765 (if byte-compiler-error-flag
1767 (when byte-compile-verbose
1768 (message "Compiling %s...done" filename
))
1769 (kill-buffer input-buffer
)
1770 (with-current-buffer output-buffer
1771 (goto-char (point-max))
1772 (insert "\n") ; aaah, unix.
1773 (if (file-writable-p target-file
)
1774 ;; We must disable any code conversion here.
1775 (let* ((coding-system-for-write 'no-conversion
)
1776 ;; Write to a tempfile so that if another Emacs
1777 ;; process is trying to load target-file (eg in a
1778 ;; parallel bootstrap), it does not risk getting a
1779 ;; half-finished file. (Bug#4196)
1780 (tempfile (make-temp-name target-file
))
1782 (cons (lambda () (ignore-errors (delete-file tempfile
)))
1784 (if (memq system-type
'(ms-dos 'windows-nt
))
1785 (setq buffer-file-type t
))
1786 (write-region (point-min) (point-max) tempfile nil
1)
1787 ;; This has the intentional side effect that any
1788 ;; hard-links to target-file continue to
1789 ;; point to the old file (this makes it possible
1790 ;; for installed files to share disk space with
1791 ;; the build tree, without causing problems when
1792 ;; emacs-lisp files in the build tree are
1793 ;; recompiled). Previously this was accomplished by
1794 ;; deleting target-file before writing it.
1795 (rename-file tempfile target-file t
)
1796 (message "Wrote %s" target-file
))
1797 ;; This is just to give a better error message than write-region
1799 (list "Opening output file"
1800 (if (file-exists-p target-file
)
1801 "cannot overwrite file"
1802 "directory not writable or nonexistent")
1804 (kill-buffer (current-buffer)))
1805 (if (and byte-compile-generate-call-tree
1806 (or (eq t byte-compile-generate-call-tree
)
1807 (y-or-n-p (format "Report call tree for %s? "
1810 (display-call-tree filename
)))
1815 ;;; compiling a single function
1817 (defun compile-defun (&optional arg
)
1818 "Compile and evaluate the current top-level form.
1819 Print the result in the echo area.
1820 With argument ARG, insert value in current buffer after the form."
1824 (beginning-of-defun)
1825 (let* ((byte-compile-current-file nil
)
1826 (byte-compile-current-buffer (current-buffer))
1827 (byte-compile-read-position (point))
1828 (byte-compile-last-position byte-compile-read-position
)
1829 (byte-compile-last-warned-form 'nothing
)
1831 (let ((read-with-symbol-positions (current-buffer))
1832 (read-symbol-positions-list nil
))
1833 (displaying-byte-compile-warnings
1834 (byte-compile-sexp (read (current-buffer)))))
1837 (message "Compiling from buffer... done.")
1838 (prin1 value
(current-buffer))
1840 ((message "%s" (prin1-to-string value
)))))))
1842 ;; Dynamically bound in byte-compile-from-buffer.
1843 ;; NB also used in cl.el and cl-macs.el.
1844 (defvar byte-compile--outbuffer
)
1846 (defun byte-compile-from-buffer (inbuffer)
1847 (let (byte-compile--outbuffer
1848 (byte-compile-current-buffer inbuffer
)
1849 (byte-compile-read-position nil
)
1850 (byte-compile-last-position nil
)
1851 ;; Prevent truncation of flonums and lists as we read and print them
1852 (float-output-format nil
)
1853 (case-fold-search nil
)
1856 ;; Prevent edebug from interfering when we compile
1857 ;; and put the output into a file.
1858 ;; (edebug-all-defs nil)
1859 ;; (edebug-all-forms nil)
1860 ;; Simulate entry to byte-compile-top-level
1861 (byte-compile-constants nil
)
1862 (byte-compile-variables nil
)
1863 (byte-compile-tag-number 0)
1864 (byte-compile-depth 0)
1865 (byte-compile-maxdepth 0)
1866 (byte-compile-output nil
)
1867 ;; This allows us to get the positions of symbols read; it's
1868 ;; new in Emacs 22.1.
1869 (read-with-symbol-positions inbuffer
)
1870 (read-symbol-positions-list nil
)
1871 ;; #### This is bound in b-c-close-variables.
1872 ;; (byte-compile-warnings byte-compile-warnings)
1874 (byte-compile-close-variables
1875 (with-current-buffer
1876 (setq byte-compile--outbuffer
1877 (get-buffer-create " *Compiler Output*"))
1878 (set-buffer-multibyte t
)
1880 ;; (emacs-lisp-mode)
1881 (setq case-fold-search nil
))
1882 (displaying-byte-compile-warnings
1883 (with-current-buffer inbuffer
1884 (and byte-compile-current-file
1885 (byte-compile-insert-header byte-compile-current-file
1886 byte-compile--outbuffer
))
1887 (goto-char (point-min))
1888 ;; Should we always do this? When calling multiple files, it
1889 ;; would be useful to delay this warning until all have been
1890 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1891 ;; previous byte-compile.
1892 (setq byte-compile-unresolved-functions nil
)
1894 ;; Compile the forms from the input buffer.
1896 (while (progn (skip-chars-forward " \t\n\^l")
1900 (setq byte-compile-read-position
(point)
1901 byte-compile-last-position byte-compile-read-position
)
1902 (let* ((old-style-backquotes nil
)
1903 (form (read inbuffer
)))
1904 ;; Warn about the use of old-style backquotes.
1905 (when old-style-backquotes
1906 (byte-compile-warn "!! The file uses old-style backquotes !!
1907 This functionality has been obsolete for more than 10 years already
1908 and will be removed soon. See (elisp)Backquote in the manual."))
1909 (byte-compile-toplevel-file-form form
)))
1910 ;; Compile pending forms at end of file.
1911 (byte-compile-flush-pending)
1912 ;; Make warnings about unresolved functions
1913 ;; give the end of the file as their position.
1914 (setq byte-compile-last-position
(point-max))
1915 (byte-compile-warn-about-unresolved-functions))
1916 ;; Fix up the header at the front of the output
1917 ;; if the buffer contains multibyte characters.
1918 (and byte-compile-current-file
1919 (with-current-buffer byte-compile--outbuffer
1920 (byte-compile-fix-header byte-compile-current-file
)))))
1921 byte-compile--outbuffer
))
1923 (defun byte-compile-fix-header (filename)
1924 "If the current buffer has any multibyte characters, insert a version test."
1925 (when (< (point-max) (position-bytes (point-max)))
1926 (goto-char (point-min))
1927 ;; Find the comment that describes the version condition.
1928 (search-forward "\n;;; This file uses")
1929 (narrow-to-region (line-beginning-position) (point-max))
1930 ;; Find the first line of ballast semicolons.
1931 (search-forward ";;;;;;;;;;")
1933 (narrow-to-region (point-min) (point))
1934 (let ((old-header-end (point))
1935 (minimum-version "23")
1937 (delete-region (point-min) (point-max))
1939 ";;; This file contains utf-8 non-ASCII characters,\n"
1940 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1941 ;; Have to check if emacs-version is bound so that this works
1942 ;; in files loaded early in loadup.el.
1943 "(and (boundp 'emacs-version)\n"
1944 ;; If there is a name at the end of emacs-version,
1945 ;; don't try to check the version number.
1946 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1947 (format " (string-lessp emacs-version \"%s\")\n" minimum-version
)
1949 ;; prin1-to-string is used to quote backslashes.
1950 (substring (prin1-to-string (file-name-nondirectory filename
))
1952 (format "' was compiled for Emacs %s or later\"))\n\n"
1954 ;; Now compensate for any change in size, to make sure all
1955 ;; positions in the file remain valid.
1956 (setq delta
(- (point-max) old-header-end
))
1957 (goto-char (point-max))
1959 (delete-char delta
))))
1961 (defun byte-compile-insert-header (filename outbuffer
)
1962 "Insert a header at the start of OUTBUFFER.
1963 Call from the source buffer."
1964 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
1965 (dynamic byte-compile-dynamic
)
1966 (optimize byte-optimize
))
1967 (with-current-buffer outbuffer
1968 (goto-char (point-min))
1969 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1970 ;; that is the file-format version number (18, 19, 20, or 23) as a
1971 ;; byte, followed by some nulls. The primary motivation for doing
1972 ;; this is to get some binary characters up in the first line of
1973 ;; the file so that `diff' will simply say "Binary files differ"
1974 ;; instead of actually doing a diff of two .elc files. An extra
1975 ;; benefit is that you can add this to /etc/magic:
1976 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1977 ;; >4 byte x version %d
1979 ";ELC" 23 "\000\000\000\n"
1981 (or (and (boundp 'user-mail-address
) user-mail-address
)
1982 (concat (user-login-name) "@" (system-name)))
1983 " on " (current-time-string) "\n"
1984 ";;; from file " filename
"\n"
1985 ";;; in Emacs version " emacs-version
"\n"
1988 ((eq optimize
'source
) " source-level optimization only")
1989 ((eq optimize
'byte
) " byte-level optimization only")
1990 (optimize " all optimizations")
1991 (t "out optimization"))
1993 (if dynamic
";;; Function definitions are lazy-loaded.\n"
1995 "\n;;; This file uses "
1996 (if dynamic-docstrings
1997 "dynamic docstrings, first added in Emacs 19.29"
1998 "opcodes that do not exist in Emacs 18")
2000 ;; Note that byte-compile-fix-header may change this.
2001 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2002 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2003 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2004 ;; can delete them so as to keep the buffer positions
2005 ;; constant for the actual compiled code.
2006 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2007 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
2009 (defun byte-compile-output-file-form (form)
2010 ;; writes the given form to the output buffer, being careful of docstrings
2011 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
2012 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2013 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2014 ;; it does not pay to first build the defalias in defmumble and then parse
2016 (if (and (memq (car-safe form
) '(defun defmacro defvar defvaralias defconst
2017 autoload custom-declare-variable
))
2018 (stringp (nth 3 form
)))
2019 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
2021 '(defvaralias autoload
2022 custom-declare-variable
)))
2023 (let ((print-escape-newlines t
)
2028 (print-circle ; handle circular data structures
2029 (not byte-compile-disable-print-circle
)))
2030 (princ "\n" byte-compile--outbuffer
)
2031 (prin1 form byte-compile--outbuffer
)
2034 (defvar print-gensym-alist
) ;Used before print-circle existed.
2035 (defvar byte-compile--for-effect
)
2037 (defun byte-compile-output-docform (preface name info form specindex quoted
)
2038 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2039 If PREFACE and NAME are non-nil, print them too,
2040 before INFO and the FORM but after the doc string itself.
2041 If SPECINDEX is non-nil, it is the index in FORM
2042 of the function bytecode string. In that case,
2043 we output that argument and the following argument
2044 \(the constants vector) together, for lazy loading.
2045 QUOTED says that we have to put a quote before the
2046 list that represents a doc string reference.
2047 `defvaralias', `autoload' and `custom-declare-variable' need that."
2048 ;; We need to examine byte-compile-dynamic-docstrings
2049 ;; in the input buffer (now current), not in the output buffer.
2050 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
2051 (with-current-buffer byte-compile--outbuffer
2054 ;; Insert the doc string, and make it a comment with #@LENGTH.
2055 (and (>= (nth 1 info
) 0)
2058 ;; Make the doc string start at beginning of line
2059 ;; for make-docfile's sake.
2062 (byte-compile-output-as-comment
2063 (nth (nth 1 info
) form
) nil
))
2064 (setq position
(- (position-bytes position
) (point-min) -
1))
2065 ;; If the doc string starts with * (a user variable),
2067 (if (and (stringp (nth (nth 1 info
) form
))
2068 (> (length (nth (nth 1 info
) form
)) 0)
2069 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
2070 (setq position
(- position
)))))
2075 (prin1 name byte-compile--outbuffer
)))
2077 (let ((print-escape-newlines t
)
2079 ;; For compatibility with code before print-circle,
2080 ;; use a cons cell to say that we want
2081 ;; print-gensym-alist not to be cleared
2082 ;; between calls to print functions.
2084 (print-circle ; handle circular data structures
2085 (not byte-compile-disable-print-circle
))
2086 print-gensym-alist
; was used before print-circle existed.
2087 (print-continuous-numbering t
)
2090 (prin1 (car form
) byte-compile--outbuffer
)
2091 (while (setq form
(cdr form
))
2092 (setq index
(1+ index
))
2094 (cond ((and (numberp specindex
) (= index specindex
)
2095 ;; Don't handle the definition dynamically
2096 ;; if it refers (or might refer)
2097 ;; to objects already output
2098 ;; (for instance, gensyms in the arg list).
2100 (when (hash-table-p print-number-table
)
2101 (maphash (lambda (_k v
) (if v
(setq non-nil t
)))
2102 print-number-table
))
2104 ;; Output the byte code and constants specially
2105 ;; for lazy dynamic loading.
2107 (byte-compile-output-as-comment
2108 (cons (car form
) (nth 1 form
))
2110 (setq position
(- (position-bytes position
)
2112 (princ (format "(#$ . %d) nil" position
)
2113 byte-compile--outbuffer
)
2114 (setq form
(cdr form
))
2115 (setq index
(1+ index
))))
2116 ((= index
(nth 1 info
))
2118 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
2120 byte-compile--outbuffer
)
2121 (let ((print-escape-newlines nil
))
2122 (goto-char (prog1 (1+ (point))
2124 byte-compile--outbuffer
)))
2126 (goto-char (point-max)))))
2128 (prin1 (car form
) byte-compile--outbuffer
)))))
2129 (insert (nth 2 info
)))))
2132 (defun byte-compile-keep-pending (form &optional handler
)
2133 (if (memq byte-optimize
'(t source
))
2134 (setq form
(byte-optimize-form form t
)))
2136 (let ((byte-compile--for-effect t
))
2137 ;; To avoid consing up monstrously large forms at load time, we split
2138 ;; the output regularly.
2139 (and (memq (car-safe form
) '(fset defalias
))
2140 (nthcdr 300 byte-compile-output
)
2141 (byte-compile-flush-pending))
2142 (funcall handler form
)
2143 (if byte-compile--for-effect
2144 (byte-compile-discard)))
2145 (byte-compile-form form t
))
2148 (defun byte-compile-flush-pending ()
2149 (if byte-compile-output
2150 (let ((form (byte-compile-out-toplevel t
'file
)))
2151 (cond ((eq (car-safe form
) 'progn
)
2152 (mapc 'byte-compile-output-file-form
(cdr form
)))
2154 (byte-compile-output-file-form form
)))
2155 (setq byte-compile-constants nil
2156 byte-compile-variables nil
2157 byte-compile-depth
0
2158 byte-compile-maxdepth
0
2159 byte-compile-output nil
))))
2161 (defun byte-compile-preprocess (form &optional _for-effect
)
2162 (setq form
(macroexpand-all form byte-compile-macro-environment
))
2163 ;; FIXME: We should run byte-optimize-form here, but it currently does not
2164 ;; recurse through all the code, so we'd have to fix this first.
2165 ;; Maybe a good fix would be to merge byte-optimize-form into
2167 ;; (if (memq byte-optimize '(t source))
2168 ;; (setq form (byte-optimize-form form for-effect)))
2170 (cconv-closure-convert form
)
2173 ;; byte-hunk-handlers cannot call this!
2174 (defun byte-compile-toplevel-file-form (form)
2175 (let ((byte-compile-current-form nil
)) ; close over this for warnings.
2176 (byte-compile-file-form (byte-compile-preprocess form t
))))
2178 ;; byte-hunk-handlers can call this.
2179 (defun byte-compile-file-form (form)
2181 (cond ((and (consp form
)
2182 (symbolp (car form
))
2183 (setq handler
(get (car form
) 'byte-hunk-handler
)))
2184 (cond ((setq form
(funcall handler form
))
2185 (byte-compile-flush-pending)
2186 (byte-compile-output-file-form form
))))
2188 (byte-compile-keep-pending form
)))))
2190 ;; Functions and variables with doc strings must be output separately,
2191 ;; so make-docfile can recognise them. Most other things can be output
2194 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
2195 (defun byte-compile-file-form-autoload (form)
2196 (and (let ((form form
))
2197 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
2198 (null form
)) ;Constants only
2199 (eval (nth 5 form
)) ;Macro
2200 (eval form
)) ;Define the autoload.
2201 ;; Avoid undefined function warnings for the autoload.
2202 (when (and (consp (nth 1 form
))
2203 (eq (car (nth 1 form
)) 'quote
)
2204 (consp (cdr (nth 1 form
)))
2205 (symbolp (nth 1 (nth 1 form
))))
2206 (push (cons (nth 1 (nth 1 form
))
2207 (cons 'autoload
(cdr (cdr form
))))
2208 byte-compile-function-environment
)
2209 ;; If an autoload occurs _before_ the first call to a function,
2210 ;; byte-compile-callargs-warn does not add an entry to
2211 ;; byte-compile-unresolved-functions. Here we mimic the logic
2212 ;; of byte-compile-callargs-warn so as not to warn if the
2213 ;; autoload comes _after_ the function call.
2214 ;; Alternatively, similar logic could go in
2215 ;; byte-compile-warn-about-unresolved-functions.
2216 (or (memq (nth 1 (nth 1 form
)) byte-compile-noruntime-functions
)
2217 (setq byte-compile-unresolved-functions
2218 (delq (assq (nth 1 (nth 1 form
))
2219 byte-compile-unresolved-functions
)
2220 byte-compile-unresolved-functions
))))
2221 (if (stringp (nth 3 form
))
2223 ;; No doc string, so we can compile this as a normal form.
2224 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
2226 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2227 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2228 (defun byte-compile-file-form-defvar (form)
2229 (if (null (nth 3 form
))
2230 ;; Since there is no doc string, we can compile this as a normal form,
2231 ;; and not do a file-boundary.
2232 (byte-compile-keep-pending form
)
2233 (when (and (symbolp (nth 1 form
))
2234 (not (string-match "[-*/:$]" (symbol-name (nth 1 form
))))
2235 (byte-compile-warning-enabled-p 'lexical
))
2236 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
2238 (push (nth 1 form
) byte-compile-bound-variables
)
2239 (if (eq (car form
) 'defconst
)
2240 (push (nth 1 form
) byte-compile-const-variables
))
2241 (cond ((consp (nth 2 form
))
2242 (setq form
(copy-sequence form
))
2243 (setcar (cdr (cdr form
))
2244 (byte-compile-top-level (nth 2 form
) nil
'file
))))
2247 (put 'define-abbrev-table
'byte-hunk-handler
2248 'byte-compile-file-form-define-abbrev-table
)
2249 (defun byte-compile-file-form-define-abbrev-table (form)
2250 (if (eq 'quote
(car-safe (car-safe (cdr form
))))
2251 (push (car-safe (cdr (cadr form
))) byte-compile-bound-variables
))
2252 (byte-compile-keep-pending form
))
2254 (put 'custom-declare-variable
'byte-hunk-handler
2255 'byte-compile-file-form-custom-declare-variable
)
2256 (defun byte-compile-file-form-custom-declare-variable (form)
2257 (when (byte-compile-warning-enabled-p 'callargs
)
2258 (byte-compile-nogroup-warn form
))
2259 (push (nth 1 (nth 1 form
)) byte-compile-bound-variables
)
2260 ;; Don't compile the expression because it may be displayed to the user.
2261 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2262 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2263 ;; ;; final value already, we can byte-compile it.
2264 ;; (setcar (cdr (nth 2 form))
2265 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2266 (let ((tail (nthcdr 4 form
)))
2268 (unless (keywordp (car tail
)) ;No point optimizing keywords.
2269 ;; Compile the keyword arguments.
2270 (setcar tail
(byte-compile-top-level (car tail
) nil
'file
)))
2271 (setq tail
(cdr tail
))))
2274 (put 'require
'byte-hunk-handler
'byte-compile-file-form-require
)
2275 (defun byte-compile-file-form-require (form)
2276 (let ((args (mapcar 'eval
(cdr form
)))
2277 (hist-orig load-history
)
2279 (apply 'require args
)
2280 (when (byte-compile-warning-enabled-p 'cl-functions
)
2281 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2282 (if (member (car args
) '("cl" cl
))
2284 (byte-compile-warn "cl package required at runtime")
2285 (byte-compile-disable-warning 'cl-functions
))
2286 ;; We may have required something that causes cl to be loaded, eg
2287 ;; the uncompiled version of a file that requires cl when compiling.
2288 (setq hist-new load-history
)
2289 (while (and (not byte-compile-cl-functions
)
2290 hist-new
(not (eq hist-new hist-orig
)))
2291 (and (byte-compile-cl-file-p (car (pop hist-new
)))
2292 (byte-compile-find-cl-functions))))))
2293 (byte-compile-keep-pending form
'byte-compile-normal-call
))
2295 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
2296 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
2297 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
2298 (defun byte-compile-file-form-progn (form)
2299 (mapc 'byte-compile-file-form
(cdr form
))
2300 ;; Return nil so the forms are not output twice.
2303 (put 'with-no-warnings
'byte-hunk-handler
2304 'byte-compile-file-form-with-no-warnings
)
2305 (defun byte-compile-file-form-with-no-warnings (form)
2306 ;; cf byte-compile-file-form-progn.
2307 (let (byte-compile-warnings)
2308 (mapc 'byte-compile-file-form
(cdr form
))
2311 ;; This handler is not necessary, but it makes the output from dont-compile
2312 ;; and similar macros cleaner.
2313 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
2314 (defun byte-compile-file-form-eval (form)
2315 (if (eq (car-safe (nth 1 form
)) 'quote
)
2316 (nth 1 (nth 1 form
))
2317 (byte-compile-keep-pending form
)))
2319 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
2320 (defun byte-compile-file-form-defun (form)
2321 (byte-compile-file-form-defmumble form nil
))
2323 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
2324 (defun byte-compile-file-form-defmacro (form)
2325 (byte-compile-file-form-defmumble form t
))
2327 (defun byte-compile-defmacro-declaration (form)
2328 "Generate code for declarations in macro definitions.
2329 Remove declarations from the body of the macro definition
2331 (let ((tail (nthcdr 2 form
))
2333 (when (stringp (car (cdr tail
)))
2334 (setq tail
(cdr tail
)))
2335 (while (and (consp (car (cdr tail
)))
2336 (eq (car (car (cdr tail
))) 'declare
))
2337 (let ((declaration (car (cdr tail
))))
2338 (setcdr tail
(cdr (cdr tail
)))
2339 (push `(if macro-declaration-function
2340 (funcall macro-declaration-function
2341 ',(car (cdr form
)) ',declaration
))
2345 (defun byte-compile-file-form-defmumble (form macrop
)
2346 (let* ((name (car (cdr form
)))
2347 (this-kind (if macrop
'byte-compile-macro-environment
2348 'byte-compile-function-environment
))
2349 (that-kind (if macrop
'byte-compile-function-environment
2350 'byte-compile-macro-environment
))
2351 (this-one (assq name
(symbol-value this-kind
)))
2352 (that-one (assq name
(symbol-value that-kind
)))
2353 (byte-compile-free-references nil
)
2354 (byte-compile-free-assignments nil
))
2355 (byte-compile-set-symbol-position name
)
2356 ;; When a function or macro is defined, add it to the call tree so that
2357 ;; we can tell when functions are not used.
2358 (if byte-compile-generate-call-tree
2359 (or (assq name byte-compile-call-tree
)
2360 (setq byte-compile-call-tree
2361 (cons (list name nil nil
) byte-compile-call-tree
))))
2363 (setq byte-compile-current-form name
) ; for warnings
2364 (if (byte-compile-warning-enabled-p 'redefine
)
2365 (byte-compile-arglist-warn form macrop
))
2366 (if byte-compile-verbose
2367 (message "Compiling %s... (%s)"
2368 (or byte-compile-current-file
"") (nth 1 form
)))
2370 (if (and (byte-compile-warning-enabled-p 'redefine
)
2371 ;; don't warn when compiling the stubs in byte-run...
2372 (not (assq (nth 1 form
)
2373 byte-compile-initial-macro-environment
)))
2375 "`%s' defined multiple times, as both function and macro"
2377 (setcdr that-one nil
))
2379 (when (and (byte-compile-warning-enabled-p 'redefine
)
2380 ;; hack: don't warn when compiling the magic internal
2381 ;; byte-compiler macros in byte-run.el...
2382 (not (assq (nth 1 form
)
2383 byte-compile-initial-macro-environment
)))
2384 (byte-compile-warn "%s `%s' defined multiple times in this file"
2385 (if macrop
"macro" "function")
2387 ((and (fboundp name
)
2388 (eq (car-safe (symbol-function name
))
2389 (if macrop
'lambda
'macro
)))
2390 (when (byte-compile-warning-enabled-p 'redefine
)
2391 (byte-compile-warn "%s `%s' being redefined as a %s"
2392 (if macrop
"function" "macro")
2394 (if macrop
"macro" "function")))
2395 ;; shadow existing definition
2397 (cons (cons name nil
)
2398 (symbol-value this-kind
))))
2400 (let ((body (nthcdr 3 form
)))
2401 (when (and (stringp (car body
))
2402 (symbolp (car-safe (cdr-safe body
)))
2403 (car-safe (cdr-safe body
))
2404 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
2405 (byte-compile-set-symbol-position (nth 1 form
))
2406 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2409 ;; Generate code for declarations in macro definitions.
2410 ;; Remove declarations from the body of the macro definition.
2412 (dolist (decl (byte-compile-defmacro-declaration form
))
2413 (prin1 decl byte-compile--outbuffer
)))
2415 (let* ((code (byte-compile-lambda (nthcdr 2 form
) t
)))
2417 (setcdr this-one code
)
2419 (cons (cons name code
)
2420 (symbol-value this-kind
))))
2421 (byte-compile-flush-pending)
2422 (if (not (stringp (nth 3 form
)))
2423 ;; No doc string. Provide -1 as the "doc string index"
2424 ;; so that no element will be treated as a doc string.
2425 (byte-compile-output-docform
2428 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]"))
2429 (append code nil
) ; Turn byte-code-function-p into list.
2430 (and (atom code
) byte-compile-dynamic
2433 ;; Output the form by hand, that's much simpler than having
2434 ;; b-c-output-file-form analyze the defalias.
2435 (byte-compile-output-docform
2438 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]"))
2439 (append code nil
) ; Turn byte-code-function-p into list.
2440 (and (atom code
) byte-compile-dynamic
2443 (princ ")" byte-compile--outbuffer
)
2446 ;; Print Lisp object EXP in the output file, inside a comment,
2447 ;; and return the file position it will have.
2448 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2449 (defun byte-compile-output-as-comment (exp quoted
)
2450 (let ((position (point)))
2451 (with-current-buffer byte-compile--outbuffer
2453 ;; Insert EXP, and make it a comment with #@LENGTH.
2456 (prin1 exp byte-compile--outbuffer
)
2457 (princ exp byte-compile--outbuffer
))
2458 (goto-char position
)
2459 ;; Quote certain special characters as needed.
2460 ;; get_doc_string in doc.c does the unquoting.
2461 (while (search-forward "\^A" nil t
)
2462 (replace-match "\^A\^A" t t
))
2463 (goto-char position
)
2464 (while (search-forward "\000" nil t
)
2465 (replace-match "\^A0" t t
))
2466 (goto-char position
)
2467 (while (search-forward "\037" nil t
)
2468 (replace-match "\^A_" t t
))
2469 (goto-char (point-max))
2471 (goto-char position
)
2472 (insert "#@" (format "%d" (- (position-bytes (point-max))
2473 (position-bytes position
))))
2475 ;; Save the file position of the object.
2476 ;; Note we should add 1 to skip the space
2477 ;; that we inserted before the actual doc string,
2478 ;; and subtract 1 to convert from an 1-origin Emacs position
2479 ;; to a file position; they cancel.
2480 (setq position
(point))
2481 (goto-char (point-max)))
2487 (defun byte-compile (form)
2488 "If FORM is a symbol, byte-compile its function definition.
2489 If FORM is a lambda or a macro, byte-compile it as a function."
2490 (displaying-byte-compile-warnings
2491 (byte-compile-close-variables
2492 (let* ((fun (if (symbolp form
)
2493 (and (fboundp form
) (symbol-function form
))
2495 (macro (eq (car-safe fun
) 'macro
)))
2497 (setq fun
(cdr fun
)))
2498 (cond ((eq (car-safe fun
) 'lambda
)
2500 (setq fun
(byte-compile-preprocess fun
))
2501 ;; Get rid of the `function' quote added by the `lambda' macro.
2502 (if (eq (car-safe fun
) 'function
) (setq fun
(cadr fun
)))
2504 (cons 'macro
(byte-compile-lambda fun
))
2505 (byte-compile-lambda fun
)))
2510 (defun byte-compile-sexp (sexp)
2511 "Compile and return SEXP."
2512 (displaying-byte-compile-warnings
2513 (byte-compile-close-variables
2514 (byte-compile-top-level (byte-compile-preprocess sexp
)))))
2516 (defun byte-compile-check-lambda-list (list)
2517 "Check lambda-list LIST for errors."
2520 (let ((arg (car list
)))
2522 (byte-compile-set-symbol-position arg
))
2523 (cond ((or (not (symbolp arg
))
2524 (byte-compile-const-symbol-p arg t
))
2525 (error "Invalid lambda variable %s" arg
))
2528 (error "&rest without variable name"))
2530 (error "Garbage following &rest VAR in lambda-list")))
2531 ((eq arg
'&optional
)
2533 (error "Variable name missing after &optional")))
2535 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2538 (setq list
(cdr list
)))))
2541 (defun byte-compile-arglist-vars (arglist)
2542 "Return a list of the variables in the lambda argument list ARGLIST."
2543 (remq '&rest
(remq '&optional arglist
)))
2545 (defun byte-compile-make-lambda-lexenv (form)
2546 "Return a new lexical environment for a lambda expression FORM."
2547 ;; See if this is a closure or not
2548 (let ((args (byte-compile-arglist-vars (cadr form
))))
2550 ;; Fill in the initial stack contents
2552 ;; Add entries for each argument
2554 (push (cons arg stackpos
) lexenv
)
2555 (setq stackpos
(1+ stackpos
)))
2556 ;; Return the new lexical environment
2559 (defun byte-compile-make-args-desc (arglist)
2562 (while (and arglist
(not (memq (car arglist
) '(&optional
&rest
))))
2563 (setq mandatory
(1+ mandatory
))
2564 (setq arglist
(cdr arglist
)))
2565 (setq nonrest mandatory
)
2566 (when (eq (car arglist
) '&optional
)
2567 (setq arglist
(cdr arglist
))
2568 (while (and arglist
(not (eq (car arglist
) '&rest
)))
2569 (setq nonrest
(1+ nonrest
))
2570 (setq arglist
(cdr arglist
))))
2573 (if (> mandatory
127)
2574 (byte-compile-report-error "Too many (>127) mandatory arguments")
2579 ;; Byte-compile a lambda-expression and return a valid function.
2580 ;; The value is usually a compiled function but may be the original
2581 ;; lambda-expression.
2582 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2583 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2584 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2585 ;; for symbols generated by the byte compiler itself.
2586 (defun byte-compile-lambda (fun &optional add-lambda reserved-csts
)
2588 (setq fun
(cons 'lambda fun
))
2589 (unless (eq 'lambda
(car-safe fun
))
2590 (error "Not a lambda list: %S" fun
))
2591 (byte-compile-set-symbol-position 'lambda
))
2592 (byte-compile-check-lambda-list (nth 1 fun
))
2593 (let* ((arglist (nth 1 fun
))
2594 (byte-compile-bound-variables
2595 (append (and (not lexical-binding
)
2596 (byte-compile-arglist-vars arglist
))
2597 byte-compile-bound-variables
))
2598 (body (cdr (cdr fun
)))
2599 (doc (if (stringp (car body
))
2601 ;; Discard the doc string
2602 ;; unless it is the last element of the body.
2604 (setq body
(cdr body
))))))
2605 (int (assq 'interactive body
)))
2606 ;; Process the interactive spec.
2608 (byte-compile-set-symbol-position 'interactive
)
2609 ;; Skip (interactive) if it is in front (the most usual location).
2610 (if (eq int
(car body
))
2611 (setq body
(cdr body
)))
2612 (cond ((consp (cdr int
))
2614 (byte-compile-warn "malformed interactive spec: %s"
2615 (prin1-to-string int
)))
2616 ;; If the interactive spec is a call to `list', don't
2617 ;; compile it, because `call-interactively' looks at the
2618 ;; args of `list'. Actually, compile it to get warnings,
2619 ;; but don't use the result.
2620 (let* ((form (nth 1 int
))
2621 (newform (byte-compile-top-level form
)))
2622 (while (memq (car-safe form
) '(let let
* progn save-excursion
))
2623 (while (consp (cdr form
))
2624 (setq form
(cdr form
)))
2625 (setq form
(car form
)))
2626 (if (and (eq (car-safe form
) 'list
)
2627 ;; The spec is evaled in callint.c in dynamic-scoping
2628 ;; mode, so just leaving the form unchanged would mean
2629 ;; it won't be eval'd in the right mode.
2630 (not lexical-binding
))
2632 (setq int
`(interactive ,newform
)))))
2634 (byte-compile-warn "malformed interactive spec: %s"
2635 (prin1-to-string int
)))))
2636 ;; Process the body.
2638 (byte-compile-top-level (cons 'progn body
) nil
'lambda
2639 ;; If doing lexical binding, push a new
2640 ;; lexical environment containing just the
2641 ;; args (since lambda expressions should be
2643 (and lexical-binding
2644 (byte-compile-make-lambda-lexenv fun
))
2646 ;; Build the actual byte-coded function.
2647 (if (eq 'byte-code
(car-safe compiled
))
2648 (apply 'make-byte-code
2650 (byte-compile-make-args-desc arglist
)
2653 ;; byte-string, constants-vector, stack depth
2655 ;; optionally, the doc string.
2656 (cond (lexical-binding
2658 (list (help-add-fundoc-usage doc arglist
)))
2661 ;; optionally, the interactive spec.
2663 (list (nth 1 int
)))))
2664 (error "byte-compile-top-level did not return byte-code")))))
2666 (defvar byte-compile-reserved-constants
0)
2668 (defun byte-compile-constants-vector ()
2669 ;; Builds the constants-vector from the current variables and constants.
2670 ;; This modifies the constants from (const . nil) to (const . offset).
2671 ;; To keep the byte-codes to look up the vector as short as possible:
2672 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2673 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2674 ;; Next variables again, to get 2-byte codes for variable lookup.
2675 ;; The rest of the constants and variables need 3-byte byte-codes.
2676 (let* ((i (1- byte-compile-reserved-constants
))
2677 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2678 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2680 (limits '(5 ; Use the 1-byte varref codes,
2681 63 ; 1-constlim ; 1-byte byte-constant codes,
2682 255 ; 2-byte varref codes,
2683 65535)) ; 3-byte codes for the rest.
2685 (while (or rest other
)
2686 (setq limit
(car limits
))
2687 (while (and rest
(< i limit
))
2689 ((numberp (car rest
))
2690 (assert (< (car rest
) byte-compile-reserved-constants
)))
2691 ((setq tmp
(assq (car (car rest
)) ret
))
2692 (setcdr (car rest
) (cdr tmp
)))
2694 (setcdr (car rest
) (setq i
(1+ i
)))
2695 (setq ret
(cons (car rest
) ret
))))
2696 (setq rest
(cdr rest
)))
2697 (setq limits
(cdr limits
)
2699 (setq other rest
))))
2700 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2702 ;; Given an expression FORM, compile it and return an equivalent byte-code
2703 ;; expression (a call to the function byte-code).
2704 (defun byte-compile-top-level (form &optional for-effect output-type
2705 lexenv reserved-csts
)
2706 ;; OUTPUT-TYPE advises about how form is expected to be used:
2707 ;; 'eval or nil -> a single form,
2708 ;; 'progn or t -> a list of forms,
2709 ;; 'lambda -> body of a lambda,
2710 ;; 'file -> used at file-level.
2711 (let ((byte-compile--for-effect for-effect
)
2712 (byte-compile-constants nil
)
2713 (byte-compile-variables nil
)
2714 (byte-compile-tag-number 0)
2715 (byte-compile-depth 0)
2716 (byte-compile-maxdepth 0)
2717 (byte-compile--lexical-environment lexenv
)
2718 (byte-compile-reserved-constants (or reserved-csts
0))
2719 (byte-compile-output nil
))
2720 (if (memq byte-optimize
'(t source
))
2721 (setq form
(byte-optimize-form form byte-compile--for-effect
)))
2722 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2723 (setq form
(nth 1 form
)))
2724 ;; Set up things for a lexically-bound function.
2725 (when (and lexical-binding
(eq output-type
'lambda
))
2726 ;; See how many arguments there are, and set the current stack depth
2728 (setq byte-compile-depth
(length byte-compile--lexical-environment
))
2729 ;; If there are args, output a tag to record the initial
2730 ;; stack-depth for the optimizer.
2731 (when (> byte-compile-depth
0)
2732 (byte-compile-out-tag (byte-compile-make-tag))))
2734 (byte-compile-form form byte-compile--for-effect
)
2735 (byte-compile-out-toplevel byte-compile--for-effect output-type
)))
2737 (defun byte-compile-out-toplevel (&optional for-effect output-type
)
2739 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2740 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2741 (setq byte-compile-output
(cdr byte-compile-output
))
2742 (byte-compile-push-constant
2743 ;; Push any constant - preferably one which already is used, and
2744 ;; a number or symbol - ie not some big sequence. The return value
2745 ;; isn't returned, but it would be a shame if some textually large
2746 ;; constant was not optimized away because we chose to return it.
2747 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2748 (let ((tmp (reverse byte-compile-constants
)))
2749 (while (and tmp
(not (or (symbolp (caar tmp
))
2750 (numberp (caar tmp
)))))
2751 (setq tmp
(cdr tmp
)))
2753 (byte-compile-out 'byte-return
0)
2754 (setq byte-compile-output
(nreverse byte-compile-output
))
2755 (if (memq byte-optimize
'(t byte
))
2756 (setq byte-compile-output
2757 (byte-optimize-lapcode byte-compile-output
)))
2759 ;; Decompile trivial functions:
2760 ;; only constants and variables, or a single funcall except in lambdas.
2761 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2762 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2763 ;; Note that even (quote foo) must be parsed just as any subr by the
2764 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2765 ;; What to leave uncompiled:
2766 ;; lambda -> never. we used to leave it uncompiled if the body was
2767 ;; a single atom, but that causes confusion if the docstring
2768 ;; uses the (file . pos) syntax. Besides, now that we have
2769 ;; the Lisp_Compiled type, the compiled form is faster.
2770 ;; eval -> atom, quote or (function atom atom atom)
2771 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2772 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2774 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2777 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2778 ((or (eq output-type
'lambda
)
2779 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2780 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2781 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2783 (setq rest
(nreverse
2784 (cdr (memq tmp
(reverse byte-compile-output
)))))
2787 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2788 (setq tmp
(car (cdr (car rest
))))
2789 (if (if (eq (car (car rest
)) 'byte-constant
)
2792 (not (byte-compile-const-symbol-p tmp
)))))
2794 (setq body
(cons (list 'quote tmp
) body
)))
2795 (setq body
(cons tmp body
))))
2797 ;; Allow a funcall if at most one atom follows it.
2798 (null (nthcdr 3 rest
))
2799 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2800 (or (null (cdr rest
))
2801 (and (memq output-type
'(file progn t
))
2803 (eq (car (nth 1 rest
)) 'byte-discard
)
2804 (progn (setq rest
(cdr rest
)) t
))))
2805 (setq maycall nil
) ; Only allow one real function call.
2806 (setq body
(nreverse body
))
2808 (if (and (eq tmp
'funcall
)
2809 (eq (car-safe (car body
)) 'quote
))
2810 (cons (nth 1 (car body
)) (cdr body
))
2812 (or (eq output-type
'file
)
2813 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2814 (setq rest
(cdr rest
)))
2816 (let ((byte-compile-vector (byte-compile-constants-vector)))
2817 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2818 byte-compile-vector byte-compile-maxdepth
)))
2819 ;; it's a trivial function
2820 ((cdr body
) (cons 'progn
(nreverse body
)))
2823 ;; Given BODY, compile it and return a new body.
2824 (defun byte-compile-top-level-body (body &optional for-effect
)
2826 (byte-compile-top-level (cons 'progn body
) for-effect t
))
2827 (cond ((eq (car-safe body
) 'progn
)
2832 ;; Special macro-expander used during byte-compilation.
2833 (defun byte-compile-macroexpand-declare-function (fn file
&rest args
)
2835 (if (and (consp args
) (listp (car args
)))
2836 (list 'declared
(car args
))
2837 t
)) ; arglist not specified
2838 byte-compile-function-environment
)
2839 ;; We are stating that it _will_ be defined at runtime.
2840 (setq byte-compile-noruntime-functions
2841 (delq fn byte-compile-noruntime-functions
))
2842 ;; Delegate the rest to the normal macro definition.
2843 (macroexpand `(declare-function ,fn
,file
,@args
)))
2846 ;; This is the recursive entry point for compiling each subform of an
2848 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2849 ;; before terminating (ie no value will be left on the stack).
2850 ;; A byte-compile handler may, when byte-compile--for-effect is non-nil, choose
2851 ;; output code which does not leave a value on the stack, and then set
2852 ;; byte-compile--for-effect to nil (to prevent byte-compile-form from
2853 ;; outputting the byte-discard).
2854 ;; If a handler wants to call another handler, it should do so via
2855 ;; byte-compile-form, or take extreme care to handle byte-compile--for-effect
2856 ;; correctly. (Use byte-compile-form-do-effect to reset the
2857 ;; byte-compile--for-effect flag too.)
2859 (defun byte-compile-form (form &optional for-effect
)
2860 (let ((byte-compile--for-effect for-effect
))
2863 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2864 (when (symbolp form
)
2865 (byte-compile-set-symbol-position form
))
2866 (byte-compile-constant form
))
2867 ((and byte-compile--for-effect byte-compile-delete-errors
)
2868 (when (symbolp form
)
2869 (byte-compile-set-symbol-position form
))
2870 (setq byte-compile--for-effect nil
))
2872 (byte-compile-variable-ref form
))))
2873 ((symbolp (car form
))
2874 (let* ((fn (car form
))
2875 (handler (get fn
'byte-compile
)))
2876 (when (byte-compile-const-symbol-p fn
)
2877 (byte-compile-warn "`%s' called as a function" fn
))
2878 (and (byte-compile-warning-enabled-p 'interactive-only
)
2879 (memq fn byte-compile-interactive-only-functions
)
2880 (byte-compile-warn "`%s' used from Lisp code\n\
2881 That command is designed for interactive use only" fn
))
2882 (if (and (fboundp (car form
))
2883 (eq (car-safe (symbol-function (car form
))) 'macro
))
2884 (byte-compile-report-error
2885 (format "Forgot to expand macro %s" (car form
))))
2887 ;; Make sure that function exists. This is important
2888 ;; for CL compiler macros since the symbol may be
2889 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2890 ;; loaded, this function doesn't exist.
2891 (and (not (eq handler
2892 ;; Already handled by macroexpand-all.
2893 'cl-byte-compile-compiler-macro
))
2894 (functionp handler
)))
2895 (funcall handler form
)
2896 (byte-compile-normal-call form
))
2897 (if (byte-compile-warning-enabled-p 'cl-functions
)
2898 (byte-compile-cl-warn form
))))
2899 ((and (byte-code-function-p (car form
))
2900 (memq byte-optimize
'(t lap
)))
2901 (byte-compile-unfold-bcf form
))
2902 ((and (eq (car-safe (car form
)) 'lambda
)
2903 ;; if the form comes out the same way it went in, that's
2904 ;; because it was malformed, and we couldn't unfold it.
2905 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
2906 (byte-compile-form form byte-compile--for-effect
)
2907 (setq byte-compile--for-effect nil
))
2908 ((byte-compile-normal-call form
)))
2909 (if byte-compile--for-effect
2910 (byte-compile-discard))))
2912 (defun byte-compile-normal-call (form)
2913 (when (and (byte-compile-warning-enabled-p 'callargs
)
2914 (symbolp (car form
)))
2915 (if (memq (car form
)
2916 '(custom-declare-group custom-declare-variable
2917 custom-declare-face
))
2918 (byte-compile-nogroup-warn form
))
2919 (when (get (car form
) 'byte-obsolete-info
)
2920 (byte-compile-warn-obsolete (car form
)))
2921 (byte-compile-callargs-warn form
))
2922 (if byte-compile-generate-call-tree
2923 (byte-compile-annotate-call-tree form
))
2924 (when (and byte-compile--for-effect
(eq (car form
) 'mapcar
)
2925 (byte-compile-warning-enabled-p 'mapcar
))
2926 (byte-compile-set-symbol-position 'mapcar
)
2928 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
2929 (byte-compile-push-constant (car form
))
2930 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
2931 (byte-compile-out 'byte-call
(length (cdr form
))))
2934 ;; Splice the given lap code into the current instruction stream.
2935 ;; If it has any labels in it, you're responsible for making sure there
2936 ;; are no collisions, and that byte-compile-tag-number is reasonable
2937 ;; after this is spliced in. The provided list is destroyed.
2938 (defun byte-compile-inline-lapcode (lap end-depth
)
2939 ;; "Replay" the operations: we used to just do
2940 ;; (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))
2941 ;; but that fails to update byte-compile-depth, so we had to assume
2942 ;; that `lap' ends up adding exactly 1 element to the stack. This
2943 ;; happens to be true for byte-code generated by bytecomp.el without
2944 ;; lexical-binding, but it's not true in general, and it's not true for
2945 ;; code output by bytecomp.el with lexical-binding.
2946 (let ((endtag (byte-compile-make-tag)))
2949 ((eq (car op
) 'TAG
) (byte-compile-out-tag op
))
2950 ((memq (car op
) byte-goto-ops
) (byte-compile-goto (car op
) (cdr op
)))
2951 ((eq (car op
) 'byte-return
)
2952 (byte-compile-discard (- byte-compile-depth end-depth
) t
)
2953 (byte-compile-goto 'byte-goto endtag
))
2954 (t (byte-compile-out (car op
) (cdr op
)))))
2955 (byte-compile-out-tag endtag
)))
2957 (defun byte-compile-unfold-bcf (form)
2958 "Inline call to byte-code-functions."
2959 (let* ((byte-compile-bound-variables byte-compile-bound-variables
)
2961 (fargs (aref fun
0))
2962 (start-depth byte-compile-depth
)
2963 (fmax2 (if (numberp fargs
) (lsh fargs -
7))) ;2*max+rest.
2964 ;; (fmin (if (numberp fargs) (logand fargs 127)))
2965 (alen (length (cdr form
)))
2967 (fetch-bytecode fun
)
2968 (mapc 'byte-compile-form
(cdr form
))
2970 ;; Old-style byte-code.
2971 (assert (listp fargs
))
2974 (&optional
(setq fargs
(cdr fargs
)))
2975 (&rest
(setq fmax2
(+ (* 2 (length dynbinds
)) 1))
2976 (push (cadr fargs
) dynbinds
)
2978 (t (push (pop fargs
) dynbinds
))))
2979 (unless fmax2
(setq fmax2
(* 2 (length dynbinds
)))))
2981 ((<= (+ alen alen
) fmax2
)
2982 ;; Add missing &optional (or &rest) arguments.
2983 (dotimes (i (- (/ (1+ fmax2
) 2) alen
))
2984 (byte-compile-push-constant nil
)))
2985 ((zerop (logand fmax2
1))
2986 (byte-compile-log-warning "Too many arguments for inlined function"
2988 (byte-compile-discard (- alen
(/ fmax2
2))))
2990 ;; Turn &rest args into a list.
2991 (let ((n (- alen
(/ (1- fmax2
) 2))))
2992 (assert (> n
0) nil
"problem: fmax2=%S alen=%S n=%S" fmax2 alen n
)
2995 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- n
))
2997 (byte-compile-out 'byte-listN n
)))))
2998 (mapc #'byte-compile-dynamic-variable-bind dynbinds
)
2999 (byte-compile-inline-lapcode
3000 (byte-decompile-bytecode-1 (aref fun
1) (aref fun
2) t
)
3002 ;; Unbind dynamic variables.
3004 (byte-compile-out 'byte-unbind
(length dynbinds
)))
3005 (assert (eq byte-compile-depth
(1+ start-depth
))
3006 nil
"Wrong depth start=%s end=%s" start-depth byte-compile-depth
)))
3008 (defun byte-compile-check-variable (var &optional binding
)
3009 "Do various error checks before a use of the variable VAR.
3010 If BINDING is non-nil, VAR is being bound."
3012 (byte-compile-set-symbol-position var
))
3013 (cond ((or (not (symbolp var
)) (byte-compile-const-symbol-p var
))
3014 (when (byte-compile-warning-enabled-p 'constants
)
3015 (byte-compile-warn (if binding
3016 "attempt to let-bind %s `%s`"
3017 "variable reference to %s `%s'")
3018 (if (symbolp var
) "constant" "nonvariable")
3019 (prin1-to-string var
))))
3020 ((and (get var
'byte-obsolete-variable
)
3021 (not (memq var byte-compile-not-obsolete-vars
)))
3022 (byte-compile-warn-obsolete var
))))
3024 (defsubst byte-compile-dynamic-variable-op
(base-op var
)
3025 (let ((tmp (assq var byte-compile-variables
)))
3027 (setq tmp
(list var
))
3028 (push tmp byte-compile-variables
))
3029 (byte-compile-out base-op tmp
)))
3031 (defun byte-compile-dynamic-variable-bind (var)
3032 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3033 (byte-compile-check-variable var t
)
3034 (push var byte-compile-bound-variables
)
3035 (byte-compile-dynamic-variable-op 'byte-varbind var
))
3037 (defun byte-compile-variable-ref (var)
3038 "Generate code to push the value of the variable VAR on the stack."
3039 (byte-compile-check-variable var
)
3040 (let ((lex-binding (assq var byte-compile--lexical-environment
)))
3042 ;; VAR is lexically bound
3043 (byte-compile-stack-ref (cdr lex-binding
))
3044 ;; VAR is dynamically bound
3045 (unless (or (not (byte-compile-warning-enabled-p 'free-vars
))
3047 (memq var byte-compile-bound-variables
)
3048 (memq var byte-compile-free-references
))
3049 (byte-compile-warn "reference to free variable `%S'" var
)
3050 (push var byte-compile-free-references
))
3051 (byte-compile-dynamic-variable-op 'byte-varref var
))))
3053 (defun byte-compile-variable-set (var)
3054 "Generate code to set the variable VAR from the top-of-stack value."
3055 (byte-compile-check-variable var
)
3056 (let ((lex-binding (assq var byte-compile--lexical-environment
)))
3058 ;; VAR is lexically bound
3059 (byte-compile-stack-set (cdr lex-binding
))
3060 ;; VAR is dynamically bound
3061 (unless (or (not (byte-compile-warning-enabled-p 'free-vars
))
3063 (memq var byte-compile-bound-variables
)
3064 (memq var byte-compile-free-assignments
))
3065 (byte-compile-warn "assignment to free variable `%s'" var
)
3066 (push var byte-compile-free-assignments
))
3067 (byte-compile-dynamic-variable-op 'byte-varset var
))))
3069 (defmacro byte-compile-get-constant
(const)
3070 `(or (if (stringp ,const
)
3071 ;; In a string constant, treat properties as significant.
3073 (dolist (elt byte-compile-constants
)
3074 (if (equal-including-properties (car elt
) ,const
)
3077 (assq ,const byte-compile-constants
))
3078 (car (setq byte-compile-constants
3079 (cons (list ,const
) byte-compile-constants
)))))
3081 ;; Use this when the value of a form is a constant.
3082 ;; This obeys byte-compile--for-effect.
3083 (defun byte-compile-constant (const)
3084 (if byte-compile--for-effect
3085 (setq byte-compile--for-effect nil
)
3086 (when (symbolp const
)
3087 (byte-compile-set-symbol-position const
))
3088 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
3090 ;; Use this for a constant that is not the value of its containing form.
3091 ;; This ignores byte-compile--for-effect.
3092 (defun byte-compile-push-constant (const)
3093 (let ((byte-compile--for-effect nil
))
3094 (inline (byte-compile-constant const
))))
3096 ;; Compile those primitive ordinary functions
3097 ;; which have special byte codes just for speed.
3099 (defmacro byte-defop-compiler
(function &optional compile-handler
)
3100 "Add a compiler-form for FUNCTION.
3101 If function is a symbol, then the variable \"byte-SYMBOL\" must name
3102 the opcode to be used. If function is a list, the first element
3103 is the function and the second element is the bytecode-symbol.
3104 The second element may be nil, meaning there is no opcode.
3105 COMPILE-HANDLER is the function to use to compile this byte-op, or
3106 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3107 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
3109 (if (symbolp function
)
3110 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
3111 (setq opcode
(car (cdr function
))
3112 function
(car function
)))
3114 (list 'put
(list 'quote function
) ''byte-compile
3116 (or (cdr (assq compile-handler
3117 '((0 . byte-compile-no-args
)
3118 (1 . byte-compile-one-arg
)
3119 (2 . byte-compile-two-args
)
3120 (3 . byte-compile-three-args
)
3121 (0-1 . byte-compile-zero-or-one-arg
)
3122 (1-2 . byte-compile-one-or-two-args
)
3123 (2-3 . byte-compile-two-or-three-args
)
3126 (intern (concat "byte-compile-"
3127 (symbol-name function
))))))))
3130 (list 'put
(list 'quote function
)
3131 ''byte-opcode
(list 'quote opcode
))
3132 (list 'put
(list 'quote opcode
)
3133 ''byte-opcode-invert
(list 'quote function
)))
3136 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
3137 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
3140 (put 'byte-call
'byte-opcode-invert
'funcall
)
3141 (put 'byte-list1
'byte-opcode-invert
'list
)
3142 (put 'byte-list2
'byte-opcode-invert
'list
)
3143 (put 'byte-list3
'byte-opcode-invert
'list
)
3144 (put 'byte-list4
'byte-opcode-invert
'list
)
3145 (put 'byte-listN
'byte-opcode-invert
'list
)
3146 (put 'byte-concat2
'byte-opcode-invert
'concat
)
3147 (put 'byte-concat3
'byte-opcode-invert
'concat
)
3148 (put 'byte-concat4
'byte-opcode-invert
'concat
)
3149 (put 'byte-concatN
'byte-opcode-invert
'concat
)
3150 (put 'byte-insertN
'byte-opcode-invert
'insert
)
3152 (byte-defop-compiler point
0)
3153 ;;(byte-defop-compiler mark 0) ;; obsolete
3154 (byte-defop-compiler point-max
0)
3155 (byte-defop-compiler point-min
0)
3156 (byte-defop-compiler following-char
0)
3157 (byte-defop-compiler preceding-char
0)
3158 (byte-defop-compiler current-column
0)
3159 (byte-defop-compiler eolp
0)
3160 (byte-defop-compiler eobp
0)
3161 (byte-defop-compiler bolp
0)
3162 (byte-defop-compiler bobp
0)
3163 (byte-defop-compiler current-buffer
0)
3164 ;;(byte-defop-compiler read-char 0) ;; obsolete
3165 ;; (byte-defop-compiler interactive-p 0) ;; Obsolete.
3166 (byte-defop-compiler widen
0)
3167 (byte-defop-compiler end-of-line
0-
1)
3168 (byte-defop-compiler forward-char
0-
1)
3169 (byte-defop-compiler forward-line
0-
1)
3170 (byte-defop-compiler symbolp
1)
3171 (byte-defop-compiler consp
1)
3172 (byte-defop-compiler stringp
1)
3173 (byte-defop-compiler listp
1)
3174 (byte-defop-compiler not
1)
3175 (byte-defop-compiler (null byte-not
) 1)
3176 (byte-defop-compiler car
1)
3177 (byte-defop-compiler cdr
1)
3178 (byte-defop-compiler length
1)
3179 (byte-defop-compiler symbol-value
1)
3180 (byte-defop-compiler symbol-function
1)
3181 (byte-defop-compiler (1+ byte-add1
) 1)
3182 (byte-defop-compiler (1- byte-sub1
) 1)
3183 (byte-defop-compiler goto-char
1)
3184 (byte-defop-compiler char-after
0-
1)
3185 (byte-defop-compiler set-buffer
1)
3186 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3187 (byte-defop-compiler forward-word
0-
1)
3188 (byte-defop-compiler char-syntax
1)
3189 (byte-defop-compiler nreverse
1)
3190 (byte-defop-compiler car-safe
1)
3191 (byte-defop-compiler cdr-safe
1)
3192 (byte-defop-compiler numberp
1)
3193 (byte-defop-compiler integerp
1)
3194 (byte-defop-compiler skip-chars-forward
1-
2)
3195 (byte-defop-compiler skip-chars-backward
1-
2)
3196 (byte-defop-compiler eq
2)
3197 (byte-defop-compiler memq
2)
3198 (byte-defop-compiler cons
2)
3199 (byte-defop-compiler aref
2)
3200 (byte-defop-compiler set
2)
3201 (byte-defop-compiler (= byte-eqlsign
) 2)
3202 (byte-defop-compiler (< byte-lss
) 2)
3203 (byte-defop-compiler (> byte-gtr
) 2)
3204 (byte-defop-compiler (<= byte-leq
) 2)
3205 (byte-defop-compiler (>= byte-geq
) 2)
3206 (byte-defop-compiler get
2)
3207 (byte-defop-compiler nth
2)
3208 (byte-defop-compiler substring
2-
3)
3209 (byte-defop-compiler (move-marker byte-set-marker
) 2-
3)
3210 (byte-defop-compiler set-marker
2-
3)
3211 (byte-defop-compiler match-beginning
1)
3212 (byte-defop-compiler match-end
1)
3213 (byte-defop-compiler upcase
1)
3214 (byte-defop-compiler downcase
1)
3215 (byte-defop-compiler string
= 2)
3216 (byte-defop-compiler string
< 2)
3217 (byte-defop-compiler (string-equal byte-string
=) 2)
3218 (byte-defop-compiler (string-lessp byte-string
<) 2)
3219 (byte-defop-compiler equal
2)
3220 (byte-defop-compiler nthcdr
2)
3221 (byte-defop-compiler elt
2)
3222 (byte-defop-compiler member
2)
3223 (byte-defop-compiler assq
2)
3224 (byte-defop-compiler (rplaca byte-setcar
) 2)
3225 (byte-defop-compiler (rplacd byte-setcdr
) 2)
3226 (byte-defop-compiler setcar
2)
3227 (byte-defop-compiler setcdr
2)
3228 (byte-defop-compiler buffer-substring
2)
3229 (byte-defop-compiler delete-region
2)
3230 (byte-defop-compiler narrow-to-region
2)
3231 (byte-defop-compiler (% byte-rem
) 2)
3232 (byte-defop-compiler aset
3)
3234 (byte-defop-compiler max byte-compile-associative
)
3235 (byte-defop-compiler min byte-compile-associative
)
3236 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
3237 (byte-defop-compiler (* byte-mult
) byte-compile-associative
)
3239 ;;####(byte-defop-compiler move-to-column 1)
3240 (byte-defop-compiler-1 interactive byte-compile-noop
)
3243 (defun byte-compile-subr-wrong-args (form n
)
3244 (byte-compile-set-symbol-position (car form
))
3245 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3246 (car form
) (length (cdr form
))
3247 (if (= 1 (length (cdr form
))) "" "s") n
)
3248 ;; Get run-time wrong-number-of-args error.
3249 (byte-compile-normal-call form
))
3251 (defun byte-compile-no-args (form)
3252 (if (not (= (length form
) 1))
3253 (byte-compile-subr-wrong-args form
"none")
3254 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3256 (defun byte-compile-one-arg (form)
3257 (if (not (= (length form
) 2))
3258 (byte-compile-subr-wrong-args form
1)
3259 (byte-compile-form (car (cdr form
))) ;; Push the argument
3260 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3262 (defun byte-compile-two-args (form)
3263 (if (not (= (length form
) 3))
3264 (byte-compile-subr-wrong-args form
2)
3265 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3266 (byte-compile-form (nth 2 form
))
3267 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3269 (defun byte-compile-three-args (form)
3270 (if (not (= (length form
) 4))
3271 (byte-compile-subr-wrong-args form
3)
3272 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3273 (byte-compile-form (nth 2 form
))
3274 (byte-compile-form (nth 3 form
))
3275 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3277 (defun byte-compile-zero-or-one-arg (form)
3278 (let ((len (length form
)))
3279 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
3280 ((= len
2) (byte-compile-one-arg form
))
3281 (t (byte-compile-subr-wrong-args form
"0-1")))))
3283 (defun byte-compile-one-or-two-args (form)
3284 (let ((len (length form
)))
3285 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
3286 ((= len
3) (byte-compile-two-args form
))
3287 (t (byte-compile-subr-wrong-args form
"1-2")))))
3289 (defun byte-compile-two-or-three-args (form)
3290 (let ((len (length form
)))
3291 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
3292 ((= len
4) (byte-compile-three-args form
))
3293 (t (byte-compile-subr-wrong-args form
"2-3")))))
3295 (defun byte-compile-noop (_form)
3296 (byte-compile-constant nil
))
3298 (defun byte-compile-discard (&optional num preserve-tos
)
3299 "Output byte codes to discard the NUM entries at the top of the stack.
3301 If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3302 popped before discarding the num values, and then pushed back again after
3304 (if (and (null num
) (not preserve-tos
))
3306 (byte-compile-out 'byte-discard
)
3310 (when (and preserve-tos
(> num
0))
3311 ;; Preserve the top-of-stack value by writing it directly to the stack
3312 ;; location which will be at the top-of-stack after popping.
3313 (byte-compile-stack-set (1- (- byte-compile-depth num
)))
3314 ;; Now we actually discard one less value, since we want to keep
3316 (setq num
(1- num
)))
3318 (byte-compile-out 'byte-discard
)
3319 (setq num
(1- num
)))))
3321 (defun byte-compile-stack-ref (stack-pos)
3322 "Output byte codes to push the value at stack position STACK-POS."
3323 (let ((dist (- byte-compile-depth
(1+ stack-pos
))))
3325 ;; A simple optimization
3326 (byte-compile-out 'byte-dup
)
3328 (byte-compile-out 'byte-stack-ref dist
))))
3330 (defun byte-compile-stack-set (stack-pos)
3331 "Output byte codes to store the TOS value at stack position STACK-POS."
3332 (byte-compile-out 'byte-stack-set
(- byte-compile-depth
(1+ stack-pos
))))
3334 (byte-defop-compiler-1 internal-make-closure byte-compile-make-closure
)
3335 (byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var
)
3337 (defun byte-compile-make-closure (form)
3338 "Byte-compile the special `internal-make-closure' form."
3339 (if byte-compile--for-effect
(setq byte-compile--for-effect nil
)
3340 (let* ((vars (nth 1 form
))
3342 (body (nthcdr 3 form
))
3344 (byte-compile-lambda `(lambda ,vars .
,body
) nil
(length env
))))
3345 (assert (byte-code-function-p fun
))
3346 (byte-compile-form `(make-byte-code
3347 ',(aref fun
0) ',(aref fun
1)
3348 (vconcat (vector .
,env
) ',(aref fun
2))
3349 ,@(nthcdr 3 (mapcar (lambda (x) `',x
) fun
)))))))
3351 (defun byte-compile-get-closed-var (form)
3352 "Byte-compile the special `internal-get-closed-var' form."
3353 (if byte-compile--for-effect
(setq byte-compile--for-effect nil
)
3354 (byte-compile-out 'byte-constant
(nth 1 form
))))
3356 ;; Compile a function that accepts one or more args and is right-associative.
3357 ;; We do it by left-associativity so that the operations
3358 ;; are done in the same order as in interpreted code.
3359 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3360 ;; in order to convert markers to numbers, and trigger expected errors.
3361 (defun byte-compile-associative (form)
3363 (let ((opcode (get (car form
) 'byte-opcode
))
3365 (if (and (< 3 (length form
))
3366 (memq opcode
(list (get '+ 'byte-opcode
)
3367 (get '* 'byte-opcode
))))
3368 ;; Don't use binary operations for > 2 operands, as that
3369 ;; may cause overflow/truncation in float operations.
3370 (byte-compile-normal-call form
)
3371 (setq args
(copy-sequence (cdr form
)))
3372 (byte-compile-form (car args
))
3373 (setq args
(cdr args
))
3374 (or args
(setq args
'(0)
3375 opcode
(get '+ 'byte-opcode
)))
3377 (byte-compile-form arg
)
3378 (byte-compile-out opcode
0))))
3379 (byte-compile-constant (eval form
))))
3382 ;; more complicated compiler macros
3384 (byte-defop-compiler char-before
)
3385 (byte-defop-compiler backward-char
)
3386 (byte-defop-compiler backward-word
)
3387 (byte-defop-compiler list
)
3388 (byte-defop-compiler concat
)
3389 (byte-defop-compiler fset
)
3390 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
3391 (byte-defop-compiler indent-to
)
3392 (byte-defop-compiler insert
)
3393 (byte-defop-compiler-1 function byte-compile-function-form
)
3394 (byte-defop-compiler-1 - byte-compile-minus
)
3395 (byte-defop-compiler (/ byte-quo
) byte-compile-quo
)
3396 (byte-defop-compiler nconc
)
3398 (defun byte-compile-char-before (form)
3399 (cond ((= 2 (length form
))
3400 (byte-compile-form (list 'char-after
(if (numberp (nth 1 form
))
3402 `(1- ,(nth 1 form
))))))
3403 ((= 1 (length form
))
3404 (byte-compile-form '(char-after (1- (point)))))
3405 (t (byte-compile-subr-wrong-args form
"0-1"))))
3407 ;; backward-... ==> forward-... with negated argument.
3408 (defun byte-compile-backward-char (form)
3409 (cond ((= 2 (length form
))
3410 (byte-compile-form (list 'forward-char
(if (numberp (nth 1 form
))
3412 `(- ,(nth 1 form
))))))
3413 ((= 1 (length form
))
3414 (byte-compile-form '(forward-char -
1)))
3415 (t (byte-compile-subr-wrong-args form
"0-1"))))
3417 (defun byte-compile-backward-word (form)
3418 (cond ((= 2 (length form
))
3419 (byte-compile-form (list 'forward-word
(if (numberp (nth 1 form
))
3421 `(- ,(nth 1 form
))))))
3422 ((= 1 (length form
))
3423 (byte-compile-form '(forward-word -
1)))
3424 (t (byte-compile-subr-wrong-args form
"0-1"))))
3426 (defun byte-compile-list (form)
3427 (let ((count (length (cdr form
))))
3429 (byte-compile-constant nil
))
3431 (mapc 'byte-compile-form
(cdr form
))
3433 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
3435 (mapc 'byte-compile-form
(cdr form
))
3436 (byte-compile-out 'byte-listN count
))
3437 (t (byte-compile-normal-call form
)))))
3439 (defun byte-compile-concat (form)
3440 (let ((count (length (cdr form
))))
3441 (cond ((and (< 1 count
) (< count
5))
3442 (mapc 'byte-compile-form
(cdr form
))
3444 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
3446 ;; Concat of one arg is not a no-op if arg is not a string.
3448 (byte-compile-form ""))
3450 (mapc 'byte-compile-form
(cdr form
))
3451 (byte-compile-out 'byte-concatN count
))
3452 ((byte-compile-normal-call form
)))))
3454 (defun byte-compile-minus (form)
3455 (let ((len (length form
)))
3457 ((= 1 len
) (byte-compile-constant 0))
3459 (byte-compile-form (cadr form
))
3460 (byte-compile-out 'byte-negate
0))
3462 (byte-compile-form (nth 1 form
))
3463 (byte-compile-form (nth 2 form
))
3464 (byte-compile-out 'byte-diff
0))
3465 ;; Don't use binary operations for > 2 operands, as that may
3466 ;; cause overflow/truncation in float operations.
3467 (t (byte-compile-normal-call form
)))))
3469 (defun byte-compile-quo (form)
3470 (let ((len (length form
)))
3472 (byte-compile-subr-wrong-args form
"2 or more"))
3474 (byte-compile-two-args form
))
3476 ;; Don't use binary operations for > 2 operands, as that
3477 ;; may cause overflow/truncation in float operations.
3478 (byte-compile-normal-call form
)))))
3480 (defun byte-compile-nconc (form)
3481 (let ((len (length form
)))
3483 (byte-compile-constant nil
))
3485 ;; nconc of one arg is a noop, even if that arg isn't a list.
3486 (byte-compile-form (nth 1 form
)))
3488 (byte-compile-form (car (setq form
(cdr form
))))
3489 (while (setq form
(cdr form
))
3490 (byte-compile-form (car form
))
3491 (byte-compile-out 'byte-nconc
0))))))
3493 (defun byte-compile-fset (form)
3494 ;; warn about forms like (fset 'foo '(lambda () ...))
3495 ;; (where the lambda expression is non-trivial...)
3496 (let ((fn (nth 2 form
))
3498 (if (and (eq (car-safe fn
) 'quote
)
3499 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
3501 (setq body
(cdr (cdr fn
)))
3502 (if (stringp (car body
)) (setq body
(cdr body
)))
3503 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
3504 (if (and (consp (car body
))
3505 (not (eq 'byte-code
(car (car body
)))))
3507 "A quoted lambda form is the second argument of `fset'. This is probably
3508 not what you want, as that lambda cannot be compiled. Consider using
3509 the syntax #'(lambda (...) ...) instead.")))))
3510 (byte-compile-two-args form
))
3512 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3513 ;; Otherwise it will be incompatible with the interpreter,
3514 ;; and (funcall (function foo)) will lose with autoloads.
3516 (defun byte-compile-function-form (form)
3517 (byte-compile-constant (if (symbolp (nth 1 form
))
3519 (byte-compile-lambda (nth 1 form
)))))
3521 (defun byte-compile-indent-to (form)
3522 (let ((len (length form
)))
3524 (byte-compile-form (car (cdr form
)))
3525 (byte-compile-out 'byte-indent-to
0))
3527 ;; no opcode for 2-arg case.
3528 (byte-compile-normal-call form
))
3530 (byte-compile-subr-wrong-args form
"1-2")))))
3532 (defun byte-compile-insert (form)
3533 (cond ((null (cdr form
))
3534 (byte-compile-constant nil
))
3535 ((<= (length form
) 256)
3536 (mapc 'byte-compile-form
(cdr form
))
3537 (if (cdr (cdr form
))
3538 (byte-compile-out 'byte-insertN
(length (cdr form
)))
3539 (byte-compile-out 'byte-insert
0)))
3540 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
3541 (byte-compile-normal-call form
))
3542 ;; We can split it; there is no function call after inserting 1st arg.
3544 (while (setq form
(cdr form
))
3545 (byte-compile-form (car form
))
3546 (byte-compile-out 'byte-insert
0)
3548 (byte-compile-discard))))))
3551 (byte-defop-compiler-1 setq
)
3552 (byte-defop-compiler-1 setq-default
)
3553 (byte-defop-compiler-1 quote
)
3555 (defun byte-compile-setq (form)
3556 (let ((args (cdr form
)))
3559 (byte-compile-form (car (cdr args
)))
3560 (or byte-compile--for-effect
(cdr (cdr args
))
3561 (byte-compile-out 'byte-dup
0))
3562 (byte-compile-variable-set (car args
))
3563 (setq args
(cdr (cdr args
))))
3564 ;; (setq), with no arguments.
3565 (byte-compile-form nil byte-compile--for-effect
))
3566 (setq byte-compile--for-effect nil
)))
3568 (defun byte-compile-setq-default (form)
3569 (setq form
(cdr form
))
3570 (if (> (length form
) 2)
3573 (push `(setq-default ,(pop form
) ,(pop form
)) setters
))
3574 (byte-compile-form (cons 'progn
(nreverse setters
))))
3575 (let ((var (car form
)))
3576 (and (or (not (symbolp var
))
3577 (byte-compile-const-symbol-p var t
))
3578 (byte-compile-warning-enabled-p 'constants
)
3580 "variable assignment to %s `%s'"
3581 (if (symbolp var
) "constant" "nonvariable")
3582 (prin1-to-string var
)))
3583 (byte-compile-normal-call `(set-default ',var
,@(cdr form
))))))
3585 (byte-defop-compiler-1 set-default
)
3586 (defun byte-compile-set-default (form)
3587 (let ((varexp (car-safe (cdr-safe form
))))
3588 (if (eq (car-safe varexp
) 'quote
)
3589 ;; If the varexp is constant, compile it as a setq-default
3590 ;; so we get more warnings.
3591 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp
))
3593 (byte-compile-normal-call form
))))
3595 (defun byte-compile-quote (form)
3596 (byte-compile-constant (car (cdr form
))))
3598 ;;; control structures
3600 (defun byte-compile-body (body &optional for-effect
)
3602 (byte-compile-form (car body
) t
)
3603 (setq body
(cdr body
)))
3604 (byte-compile-form (car body
) for-effect
))
3606 (defsubst byte-compile-body-do-effect
(body)
3607 (byte-compile-body body byte-compile--for-effect
)
3608 (setq byte-compile--for-effect nil
))
3610 (defsubst byte-compile-form-do-effect
(form)
3611 (byte-compile-form form byte-compile--for-effect
)
3612 (setq byte-compile--for-effect nil
))
3614 (byte-defop-compiler-1 inline byte-compile-progn
)
3615 (byte-defop-compiler-1 progn
)
3616 (byte-defop-compiler-1 prog1
)
3617 (byte-defop-compiler-1 prog2
)
3618 (byte-defop-compiler-1 if
)
3619 (byte-defop-compiler-1 cond
)
3620 (byte-defop-compiler-1 and
)
3621 (byte-defop-compiler-1 or
)
3622 (byte-defop-compiler-1 while
)
3623 (byte-defop-compiler-1 funcall
)
3624 (byte-defop-compiler-1 let
)
3625 (byte-defop-compiler-1 let
* byte-compile-let
)
3627 (defun byte-compile-progn (form)
3628 (byte-compile-body-do-effect (cdr form
)))
3630 (defun byte-compile-prog1 (form)
3631 (byte-compile-form-do-effect (car (cdr form
)))
3632 (byte-compile-body (cdr (cdr form
)) t
))
3634 (defun byte-compile-prog2 (form)
3635 (byte-compile-form (nth 1 form
) t
)
3636 (byte-compile-form-do-effect (nth 2 form
))
3637 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3639 (defmacro byte-compile-goto-if
(cond discard tag
)
3642 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3643 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3646 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3647 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3648 (defun byte-compile-find-bound-condition (condition-param
3650 &optional only-if-not-present
)
3654 (if (memq (car-safe condition-param
) pred-list
)
3655 ;; The condition appears by itself.
3656 (list condition-param
)
3657 ;; If the condition is an `and', look for matches among the
3659 (when (eq 'and
(car-safe condition-param
))
3660 (cdr condition-param
)))))
3662 (dolist (crt cond-list
)
3663 (when (and (memq (car-safe crt
) pred-list
)
3664 (eq 'quote
(car-safe (setq nth-one
(nth 1 crt
))))
3665 ;; Ignore if the symbol is already on the unresolved
3667 (not (assq (nth 1 nth-one
) ; the relevant symbol
3668 only-if-not-present
)))
3669 (push (nth 1 (nth 1 crt
)) result
)))
3672 (defmacro byte-compile-maybe-guarded
(condition &rest body
)
3673 "Execute forms in BODY, potentially guarded by CONDITION.
3674 CONDITION is a variable whose value is a test in an `if' or `cond'.
3675 BODY is the code to compile in the first arm of the if or the body of
3676 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3677 or (boundp 'foo), the relevant warnings from BODY about foo's
3678 being undefined (or obsolete) will be suppressed.
3680 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3681 that suppresses all warnings during execution of BODY."
3682 (declare (indent 1) (debug t
))
3683 `(let* ((fbound-list (byte-compile-find-bound-condition
3684 ,condition
(list 'fboundp
)
3685 byte-compile-unresolved-functions
))
3686 (bound-list (byte-compile-find-bound-condition
3687 ,condition
(list 'boundp
'default-boundp
)))
3688 ;; Maybe add to the bound list.
3689 (byte-compile-bound-variables
3690 (append bound-list byte-compile-bound-variables
)))
3692 ;; If things not being bound at all is ok, so must them being
3693 ;; obsolete. Note that we add to the existing lists since Tramp
3694 ;; (ab)uses this feature.
3695 (let ((byte-compile-not-obsolete-vars
3696 (append byte-compile-not-obsolete-vars bound-list
))
3697 (byte-compile-not-obsolete-funcs
3698 (append byte-compile-not-obsolete-funcs fbound-list
)))
3700 ;; Maybe remove the function symbol from the unresolved list.
3701 (dolist (fbound fbound-list
)
3703 (setq byte-compile-unresolved-functions
3704 (delq (assq fbound byte-compile-unresolved-functions
)
3705 byte-compile-unresolved-functions
)))))))
3707 (defun byte-compile-if (form)
3708 (byte-compile-form (car (cdr form
)))
3709 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3710 ;; and avoid warnings about the relevent symbols in the consequent.
3711 (let ((clause (nth 1 form
))
3712 (donetag (byte-compile-make-tag)))
3713 (if (null (nthcdr 3 form
))
3716 (byte-compile-goto-if nil byte-compile--for-effect donetag
)
3717 (byte-compile-maybe-guarded clause
3718 (byte-compile-form (nth 2 form
) byte-compile--for-effect
))
3719 (byte-compile-out-tag donetag
))
3720 (let ((elsetag (byte-compile-make-tag)))
3721 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3722 (byte-compile-maybe-guarded clause
3723 (byte-compile-form (nth 2 form
) byte-compile--for-effect
))
3724 (byte-compile-goto 'byte-goto donetag
)
3725 (byte-compile-out-tag elsetag
)
3726 (byte-compile-maybe-guarded (list 'not clause
)
3727 (byte-compile-body (cdr (cdr (cdr form
))) byte-compile--for-effect
))
3728 (byte-compile-out-tag donetag
))))
3729 (setq byte-compile--for-effect nil
))
3731 (defun byte-compile-cond (clauses)
3732 (let ((donetag (byte-compile-make-tag))
3734 (while (setq clauses
(cdr clauses
))
3735 (setq clause
(car clauses
))
3736 (cond ((or (eq (car clause
) t
)
3737 (and (eq (car-safe (car clause
)) 'quote
)
3738 (car-safe (cdr-safe (car clause
)))))
3739 ;; Unconditional clause
3740 (setq clause
(cons t clause
)
3743 (byte-compile-form (car clause
))
3744 (if (null (cdr clause
))
3745 ;; First clause is a singleton.
3746 (byte-compile-goto-if t byte-compile--for-effect donetag
)
3747 (setq nexttag
(byte-compile-make-tag))
3748 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3749 (byte-compile-maybe-guarded (car clause
)
3750 (byte-compile-body (cdr clause
) byte-compile--for-effect
))
3751 (byte-compile-goto 'byte-goto donetag
)
3752 (byte-compile-out-tag nexttag
)))))
3754 (let ((guard (car clause
)))
3755 (and (cdr clause
) (not (eq guard t
))
3756 (progn (byte-compile-form guard
)
3757 (byte-compile-goto-if nil byte-compile--for-effect donetag
)
3758 (setq clause
(cdr clause
))))
3759 (byte-compile-maybe-guarded guard
3760 (byte-compile-body-do-effect clause
)))
3761 (byte-compile-out-tag donetag
)))
3763 (defun byte-compile-and (form)
3764 (let ((failtag (byte-compile-make-tag))
3767 (byte-compile-form-do-effect t
)
3768 (byte-compile-and-recursion args failtag
))))
3770 ;; Handle compilation of a nontrivial `and' call.
3771 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3772 (defun byte-compile-and-recursion (rest failtag
)
3775 (byte-compile-form (car rest
))
3776 (byte-compile-goto-if nil byte-compile--for-effect failtag
)
3777 (byte-compile-maybe-guarded (car rest
)
3778 (byte-compile-and-recursion (cdr rest
) failtag
)))
3779 (byte-compile-form-do-effect (car rest
))
3780 (byte-compile-out-tag failtag
)))
3782 (defun byte-compile-or (form)
3783 (let ((wintag (byte-compile-make-tag))
3786 (byte-compile-form-do-effect nil
)
3787 (byte-compile-or-recursion args wintag
))))
3789 ;; Handle compilation of a nontrivial `or' call.
3790 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3791 (defun byte-compile-or-recursion (rest wintag
)
3794 (byte-compile-form (car rest
))
3795 (byte-compile-goto-if t byte-compile--for-effect wintag
)
3796 (byte-compile-maybe-guarded (list 'not
(car rest
))
3797 (byte-compile-or-recursion (cdr rest
) wintag
)))
3798 (byte-compile-form-do-effect (car rest
))
3799 (byte-compile-out-tag wintag
)))
3801 (defun byte-compile-while (form)
3802 (let ((endtag (byte-compile-make-tag))
3803 (looptag (byte-compile-make-tag)))
3804 (byte-compile-out-tag looptag
)
3805 (byte-compile-form (car (cdr form
)))
3806 (byte-compile-goto-if nil byte-compile--for-effect endtag
)
3807 (byte-compile-body (cdr (cdr form
)) t
)
3808 (byte-compile-goto 'byte-goto looptag
)
3809 (byte-compile-out-tag endtag
)
3810 (setq byte-compile--for-effect nil
)))
3812 (defun byte-compile-funcall (form)
3813 (mapc 'byte-compile-form
(cdr form
))
3814 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3819 (defun byte-compile-push-binding-init (clause)
3820 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
3821 Return the offset in the form (VAR . OFFSET)."
3822 (let* ((var (if (consp clause
) (car clause
) clause
)))
3823 ;; We record the stack position even of dynamic bindings and
3824 ;; variables in non-stack lexical environments; we'll put
3825 ;; them in the proper place below.
3826 (prog1 (cons var byte-compile-depth
)
3828 (byte-compile-form (cadr clause
))
3829 (byte-compile-push-constant nil
)))))
3831 (defun byte-compile-not-lexical-var-p (var)
3832 (or (not (symbolp var
))
3833 (special-variable-p var
)
3834 (memq var byte-compile-bound-variables
)
3838 (defun byte-compile-bind (var init-lexenv
)
3839 "Emit byte-codes to bind VAR and update `byte-compile--lexical-environment'.
3840 INIT-LEXENV should be a lexical-environment alist describing the
3841 positions of the init value that have been pushed on the stack.
3842 Return non-nil if the TOS value was popped."
3843 ;; The presence of lexical bindings mean that we may have to
3844 ;; juggle things on the stack, to move them to TOS for
3846 (cond ((not (byte-compile-not-lexical-var-p var
))
3847 ;; VAR is a simple stack-allocated lexical variable
3848 (push (assq var init-lexenv
)
3849 byte-compile--lexical-environment
)
3851 ((eq var
(caar init-lexenv
))
3852 ;; VAR is dynamic and is on the top of the
3853 ;; stack, so we can just bind it like usual
3854 (byte-compile-dynamic-variable-bind var
)
3857 ;; VAR is dynamic, but we have to get its
3858 ;; value out of the middle of the stack
3859 (let ((stack-pos (cdr (assq var init-lexenv
))))
3860 (byte-compile-stack-ref stack-pos
)
3861 (byte-compile-dynamic-variable-bind var
)
3862 ;; Now we have to store nil into its temporary
3863 ;; stack position to avoid problems with GC
3864 (byte-compile-push-constant nil
)
3865 (byte-compile-stack-set stack-pos
))
3868 (defun byte-compile-unbind (clauses init-lexenv
3869 &optional preserve-body-value
)
3870 "Emit byte-codes to unbind the variables bound by CLAUSES.
3871 CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3872 lexical-environment alist describing the positions of the init value that
3873 have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3874 then an additional value on the top of the stack, above any lexical binding
3875 slots, is preserved, so it will be on the top of the stack after all
3876 binding slots have been popped."
3877 ;; Unbind dynamic variables
3878 (let ((num-dynamic-bindings 0))
3879 (dolist (clause clauses
)
3880 (unless (assq (if (consp clause
) (car clause
) clause
)
3881 byte-compile--lexical-environment
)
3882 (setq num-dynamic-bindings
(1+ num-dynamic-bindings
))))
3883 (unless (zerop num-dynamic-bindings
)
3884 (byte-compile-out 'byte-unbind num-dynamic-bindings
)))
3885 ;; Pop lexical variables off the stack, possibly preserving the
3886 ;; return value of the body.
3888 ;; INIT-LEXENV contains all init values left on the stack
3889 (byte-compile-discard (length init-lexenv
) preserve-body-value
)))
3891 (defun byte-compile-let (form)
3892 "Generate code for the `let' form FORM."
3893 (let ((clauses (cadr form
))
3895 (when (eq (car form
) 'let
)
3896 ;; First compute the binding values in the old scope.
3897 (dolist (var clauses
)
3898 (push (byte-compile-push-binding-init var
) init-lexenv
)))
3900 (let ((byte-compile-bound-variables byte-compile-bound-variables
)
3901 (byte-compile--lexical-environment
3902 byte-compile--lexical-environment
))
3903 ;; Bind the variables.
3904 ;; For `let', do it in reverse order, because it makes no
3905 ;; semantic difference, but it is a lot more efficient since the
3906 ;; values are now in reverse order on the stack.
3907 (dolist (var (if (eq (car form
) 'let
) (reverse clauses
) clauses
))
3908 (unless (eq (car form
) 'let
)
3909 (push (byte-compile-push-binding-init var
) init-lexenv
))
3910 (let ((var (if (consp var
) (car var
) var
)))
3911 (cond ((null lexical-binding
)
3912 ;; If there are no lexical bindings, we can do things simply.
3913 (byte-compile-dynamic-variable-bind var
))
3914 ((byte-compile-bind var init-lexenv
)
3915 (pop init-lexenv
)))))
3917 (let ((init-stack-depth byte-compile-depth
))
3918 (byte-compile-body-do-effect (cdr (cdr form
)))
3919 ;; Unbind the variables.
3921 ;; Unbind both lexical and dynamic variables.
3923 (assert (or (eq byte-compile-depth init-stack-depth
)
3924 (eq byte-compile-depth
(1+ init-stack-depth
))))
3925 (byte-compile-unbind clauses init-lexenv
(> byte-compile-depth
3927 ;; Unbind dynamic variables.
3928 (byte-compile-out 'byte-unbind
(length clauses
)))))))
3932 (byte-defop-compiler-1 /= byte-compile-negated
)
3933 (byte-defop-compiler-1 atom byte-compile-negated
)
3934 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3936 (put '/= 'byte-compile-negated-op
'=)
3937 (put 'atom
'byte-compile-negated-op
'consp
)
3938 (put 'nlistp
'byte-compile-negated-op
'listp
)
3940 (defun byte-compile-negated (form)
3941 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3943 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3944 (defun byte-compile-negation-optimizer (form)
3945 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3946 (byte-compile-set-symbol-position (car form
))
3948 (cons (or (get (car form
) 'byte-compile-negated-op
)
3950 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3954 ;;; other tricky macro-like special-forms
3956 (byte-defop-compiler-1 catch
)
3957 (byte-defop-compiler-1 unwind-protect
)
3958 (byte-defop-compiler-1 condition-case
)
3959 (byte-defop-compiler-1 save-excursion
)
3960 (byte-defop-compiler-1 save-current-buffer
)
3961 (byte-defop-compiler-1 save-restriction
)
3962 ;; (byte-defop-compiler-1 save-window-excursion) ;Obsolete: now a macro.
3963 ;; (byte-defop-compiler-1 with-output-to-temp-buffer) ;Obsolete: now a macro.
3964 (byte-defop-compiler-1 track-mouse
)
3966 (defun byte-compile-catch (form)
3967 (byte-compile-form (car (cdr form
)))
3970 (byte-compile-form `(list 'funcall
,f
)))
3972 (byte-compile-push-constant
3973 (byte-compile-top-level (cons 'progn body
) byte-compile--for-effect
))))
3974 (byte-compile-out 'byte-catch
0))
3976 (defun byte-compile-unwind-protect (form)
3979 (byte-compile-form `(list (list 'funcall
,f
))))
3981 (byte-compile-push-constant
3982 (byte-compile-top-level-body handlers t
))))
3983 (byte-compile-out 'byte-unwind-protect
0)
3984 (byte-compile-form-do-effect (car (cdr form
)))
3985 (byte-compile-out 'byte-unbind
1))
3987 (defun byte-compile-track-mouse (form)
3990 (`(,_
:fun-body
,f
) `(eval (list 'track-mouse
(list 'funcall
,f
))))
3991 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form
))))))))
3993 (defun byte-compile-condition-case (form)
3994 (let* ((var (nth 1 form
))
3995 (fun-bodies (eq var
:fun-body
))
3996 (byte-compile-bound-variables
3997 (if (and var
(not fun-bodies
))
3998 (cons var byte-compile-bound-variables
)
3999 byte-compile-bound-variables
)))
4000 (byte-compile-set-symbol-position 'condition-case
)
4001 (unless (symbolp var
)
4003 "`%s' is not a variable-name or nil (in condition-case)" var
))
4004 (if fun-bodies
(setq var
(make-symbol "err")))
4005 (byte-compile-push-constant var
)
4007 (byte-compile-form `(list 'funcall
,(nth 2 form
)))
4008 (byte-compile-push-constant
4009 (byte-compile-top-level (nth 2 form
) byte-compile--for-effect
)))
4010 (let ((compiled-clauses
4013 (let ((condition (car clause
)))
4014 (cond ((not (or (symbolp condition
)
4015 (and (listp condition
)
4017 (dolist (sym condition
)
4018 (if (not (symbolp sym
))
4022 "`%S' is not a condition name or list of such (in condition-case)"
4024 ;; (not (or (eq condition 't)
4025 ;; (and (stringp (get condition 'error-message))
4026 ;; (consp (get condition
4027 ;; 'error-conditions)))))
4028 ;; (byte-compile-warn
4029 ;; "`%s' is not a known condition name
4030 ;; (in condition-case)"
4034 `(list ',condition
(list 'funcall
,(cadr clause
) ',var
))
4036 (byte-compile-top-level-body
4037 (cdr clause
) byte-compile--for-effect
)))))
4038 (cdr (cdr (cdr form
))))))
4040 (byte-compile-form `(list ,@compiled-clauses
))
4041 (byte-compile-push-constant compiled-clauses
)))
4042 (byte-compile-out 'byte-condition-case
0)))
4045 (defun byte-compile-save-excursion (form)
4046 (if (and (eq 'set-buffer
(car-safe (car-safe (cdr form
))))
4047 (byte-compile-warning-enabled-p 'suspicious
))
4049 "Use `with-current-buffer' rather than save-excursion+set-buffer"))
4050 (byte-compile-out 'byte-save-excursion
0)
4051 (byte-compile-body-do-effect (cdr form
))
4052 (byte-compile-out 'byte-unbind
1))
4054 (defun byte-compile-save-restriction (form)
4055 (byte-compile-out 'byte-save-restriction
0)
4056 (byte-compile-body-do-effect (cdr form
))
4057 (byte-compile-out 'byte-unbind
1))
4059 (defun byte-compile-save-current-buffer (form)
4060 (byte-compile-out 'byte-save-current-buffer
0)
4061 (byte-compile-body-do-effect (cdr form
))
4062 (byte-compile-out 'byte-unbind
1))
4064 ;;; top-level forms elsewhere
4066 (byte-defop-compiler-1 defun
)
4067 (byte-defop-compiler-1 defmacro
)
4068 (byte-defop-compiler-1 defvar
)
4069 (byte-defop-compiler-1 defconst byte-compile-defvar
)
4070 (byte-defop-compiler-1 autoload
)
4071 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
4073 (defun byte-compile-defun (form)
4074 ;; This is not used for file-level defuns with doc strings.
4075 (if (symbolp (car form
))
4076 (byte-compile-set-symbol-position (car form
))
4077 (byte-compile-set-symbol-position 'defun
)
4078 (error "defun name must be a symbol, not %s" (car form
)))
4079 (byte-compile-push-constant 'defalias
)
4080 (byte-compile-push-constant (nth 1 form
))
4081 (byte-compile-push-constant (byte-compile-lambda (cdr (cdr form
)) t
))
4082 (byte-compile-out 'byte-call
2))
4084 (defun byte-compile-defmacro (form)
4085 ;; This is not used for file-level defmacros with doc strings.
4086 (byte-compile-body-do-effect
4087 (let ((decls (byte-compile-defmacro-declaration form
))
4088 (code (byte-compile-lambda (cdr (cdr form
)) t
)))
4089 `((defalias ',(nth 1 form
)
4090 ,(if (eq (car-safe code
) 'make-byte-code
)
4091 `(cons 'macro
,code
)
4092 `'(macro .
,(eval code
))))
4096 ;; If foo.el declares `toto' as obsolete, it is likely that foo.el will
4097 ;; actually use `toto' in order for this obsolete variable to still work
4098 ;; correctly, so paradoxically, while byte-compiling foo.el, the presence
4099 ;; of a make-obsolete-variable call for `toto' is an indication that `toto'
4100 ;; should not trigger obsolete-warnings in foo.el.
4101 (byte-defop-compiler-1 make-obsolete-variable
)
4102 (defun byte-compile-make-obsolete-variable (form)
4103 (when (eq 'quote
(car-safe (nth 1 form
)))
4104 (push (nth 1 (nth 1 form
)) byte-compile-not-obsolete-vars
))
4105 (byte-compile-normal-call form
))
4107 (defun byte-compile-defvar (form)
4108 ;; This is not used for file-level defvar/consts with doc strings.
4109 (when (and (symbolp (nth 1 form
))
4110 (not (string-match "[-*/:$]" (symbol-name (nth 1 form
))))
4111 (byte-compile-warning-enabled-p 'lexical
))
4112 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4114 (let ((fun (nth 0 form
))
4116 (value (nth 2 form
))
4117 (string (nth 3 form
)))
4118 (byte-compile-set-symbol-position fun
)
4119 (when (or (> (length form
) 4)
4120 (and (eq fun
'defconst
) (null (cddr form
))))
4121 (let ((ncall (length (cdr form
))))
4123 "`%s' called with %d argument%s, but %s %s"
4125 (if (= 1 ncall
) "" "s")
4126 (if (< ncall
2) "requires" "accepts only")
4128 (push var byte-compile-bound-variables
)
4129 (if (eq fun
'defconst
)
4130 (push var byte-compile-const-variables
))
4131 (byte-compile-body-do-effect
4133 ;; Put the defined variable in this library's load-history entry
4134 ;; just as a real defvar would, but only in top-level forms.
4135 (when (and (cddr form
) (null byte-compile-current-form
))
4136 `(setq current-load-list
(cons ',var current-load-list
)))
4137 (when (> (length form
) 3)
4138 (when (and string
(not (stringp string
)))
4139 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4141 `(put ',var
'variable-documentation
,string
))
4142 (if (cddr form
) ; `value' provided
4143 (let ((byte-compile-not-obsolete-vars (list var
)))
4144 (if (eq fun
'defconst
)
4145 ;; `defconst' sets `var' unconditionally.
4146 (let ((tmp (make-symbol "defconst-tmp-var")))
4147 `(funcall '(lambda (,tmp
) (defconst ,var
,tmp
))
4149 ;; `defvar' sets `var' only when unbound.
4150 `(if (not (default-boundp ',var
)) (setq-default ,var
,value
))))
4151 (when (eq fun
'defconst
)
4152 ;; This will signal an appropriate error at runtime.
4156 (defun byte-compile-autoload (form)
4157 (byte-compile-set-symbol-position 'autoload
)
4158 (and (byte-compile-constp (nth 1 form
))
4159 (byte-compile-constp (nth 5 form
))
4160 (eval (nth 5 form
)) ; macro-p
4161 (not (fboundp (eval (nth 1 form
))))
4163 "The compiler ignores `autoload' except at top level. You should
4164 probably put the autoload of the macro `%s' at top-level."
4165 (eval (nth 1 form
))))
4166 (byte-compile-normal-call form
))
4168 ;; Lambdas in valid places are handled as special cases by various code.
4169 ;; The ones that remain are errors.
4170 (defun byte-compile-lambda-form (_form)
4171 (byte-compile-set-symbol-position 'lambda
)
4172 (error "`lambda' used as function name is invalid"))
4174 ;; Compile normally, but deal with warnings for the function being defined.
4175 (put 'defalias
'byte-hunk-handler
'byte-compile-file-form-defalias
)
4176 (defun byte-compile-file-form-defalias (form)
4177 (if (and (consp (cdr form
)) (consp (nth 1 form
))
4178 (eq (car (nth 1 form
)) 'quote
)
4179 (consp (cdr (nth 1 form
)))
4180 (symbolp (nth 1 (nth 1 form
))))
4182 (and (consp (nthcdr 2 form
))
4183 (consp (nth 2 form
))
4184 (eq (car (nth 2 form
)) 'quote
)
4185 (consp (cdr (nth 2 form
)))
4186 (symbolp (nth 1 (nth 2 form
))))))
4187 (byte-compile-defalias-warn (nth 1 (nth 1 form
)))
4188 (push (cons (nth 1 (nth 1 form
))
4189 (if constant
(nth 1 (nth 2 form
)) t
))
4190 byte-compile-function-environment
)))
4191 ;; We used to just do: (byte-compile-normal-call form)
4192 ;; But it turns out that this fails to optimize the code.
4193 ;; So instead we now do the same as what other byte-hunk-handlers do,
4194 ;; which is to call back byte-compile-file-form and then return nil.
4195 ;; Except that we can't just call byte-compile-file-form since it would
4196 ;; call us right back.
4197 (byte-compile-keep-pending form
)
4198 ;; Return nil so the form is not output twice.
4201 ;; Turn off warnings about prior calls to the function being defalias'd.
4202 ;; This could be smarter and compare those calls with
4203 ;; the function it is being aliased to.
4204 (defun byte-compile-defalias-warn (new)
4205 (let ((calls (assq new byte-compile-unresolved-functions
)))
4207 (setq byte-compile-unresolved-functions
4208 (delq calls byte-compile-unresolved-functions
)))))
4210 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings
)
4211 (defun byte-compile-no-warnings (form)
4212 (let (byte-compile-warnings)
4213 (byte-compile-form (cons 'progn
(cdr form
)))))
4215 ;; Warn about misuses of make-variable-buffer-local.
4216 (byte-defop-compiler-1 make-variable-buffer-local
4217 byte-compile-make-variable-buffer-local
)
4218 (defun byte-compile-make-variable-buffer-local (form)
4219 (if (and (eq (car-safe (car-safe (cdr-safe form
))) 'quote
)
4220 (byte-compile-warning-enabled-p 'make-local
))
4222 "`make-variable-buffer-local' should be called at toplevel"))
4223 (byte-compile-normal-call form
))
4224 (put 'make-variable-buffer-local
4225 'byte-hunk-handler
'byte-compile-form-make-variable-buffer-local
)
4226 (defun byte-compile-form-make-variable-buffer-local (form)
4227 (byte-compile-keep-pending form
'byte-compile-normal-call
))
4232 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4233 ;; optimization to have the 'TAG as a part of the tag.
4234 ;; Tags will be (TAG . (tag-number . stack-depth)).
4235 (defun byte-compile-make-tag ()
4236 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
4239 (defun byte-compile-out-tag (tag)
4240 (setq byte-compile-output
(cons tag byte-compile-output
))
4243 ;; ## remove this someday
4244 (and byte-compile-depth
4245 (not (= (cdr (cdr tag
)) byte-compile-depth
))
4246 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
4247 (setq byte-compile-depth
(cdr (cdr tag
))))
4248 (setcdr (cdr tag
) byte-compile-depth
)))
4250 (defun byte-compile-goto (opcode tag
)
4251 (push (cons opcode tag
) byte-compile-output
)
4252 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
4253 (1- byte-compile-depth
)
4254 byte-compile-depth
))
4255 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
4256 (1- byte-compile-depth
))))
4258 (defun byte-compile-stack-adjustment (op operand
)
4259 "Return the amount by which an operation adjusts the stack.
4260 OP and OPERAND are as passed to `byte-compile-out'."
4261 (if (memq op
'(byte-call byte-discardN byte-discardN-preserve-tos
))
4262 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4263 ;; elements, and the push the result, for a total of -OPERAND.
4264 ;; For discardN*, of course, we just pop OPERAND elements.
4266 (or (aref byte-stack
+-info
(symbol-value op
))
4267 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4268 ;; that take OPERAND values off the stack and push a result, for
4269 ;; a total of 1 - OPERAND
4272 (defun byte-compile-out (op &optional operand
)
4273 (push (cons op operand
) byte-compile-output
)
4274 (if (eq op
'byte-return
)
4275 ;; This is actually an unnecessary case, because there should be no
4276 ;; more ops behind byte-return.
4277 (setq byte-compile-depth nil
)
4278 (setq byte-compile-depth
4279 (+ byte-compile-depth
(byte-compile-stack-adjustment op operand
)))
4280 (setq byte-compile-maxdepth
(max byte-compile-depth byte-compile-maxdepth
))
4281 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4286 (defun byte-compile-annotate-call-tree (form)
4288 ;; annotate the current call
4289 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
4290 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
4292 (cons byte-compile-current-form
(nth 1 entry
))))
4293 (setq byte-compile-call-tree
4294 (cons (list (car form
) (list byte-compile-current-form
) nil
)
4295 byte-compile-call-tree
)))
4296 ;; annotate the current function
4297 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
4298 (or (memq (car form
) (nth 2 entry
)) ;called
4299 (setcar (cdr (cdr entry
))
4300 (cons (car form
) (nth 2 entry
))))
4301 (setq byte-compile-call-tree
4302 (cons (list byte-compile-current-form nil
(list (car form
)))
4303 byte-compile-call-tree
)))
4306 ;; Renamed from byte-compile-report-call-tree
4307 ;; to avoid interfering with completion of byte-compile-file.
4309 (defun display-call-tree (&optional filename
)
4310 "Display a call graph of a specified file.
4311 This lists which functions have been called, what functions called
4312 them, and what functions they call. The list includes all functions
4313 whose definitions have been compiled in this Emacs session, as well as
4314 all functions called by those functions.
4316 The call graph does not include macros, inline functions, or
4317 primitives that the byte-code interpreter knows about directly \(eq,
4320 The call tree also lists those functions which are not known to be called
4321 \(that is, to which no calls have been compiled\), and which cannot be
4322 invoked interactively."
4324 (message "Generating call tree...")
4325 (with-output-to-temp-buffer "*Call-Tree*"
4326 (set-buffer "*Call-Tree*")
4328 (message "Generating call tree... (sorting on %s)"
4329 byte-compile-call-tree-sort
)
4330 (insert "Call tree for "
4331 (cond ((null byte-compile-current-file
) (or filename
"???"))
4332 ((stringp byte-compile-current-file
)
4333 byte-compile-current-file
)
4334 (t (buffer-name byte-compile-current-file
)))
4336 (prin1-to-string byte-compile-call-tree-sort
)
4338 (if byte-compile-call-tree-sort
4339 (setq byte-compile-call-tree
4340 (sort byte-compile-call-tree
4341 (case byte-compile-call-tree-sort
4343 (lambda (x y
) (< (length (nth 1 x
))
4344 (length (nth 1 y
)))))
4346 (lambda (x y
) (< (length (nth 2 x
))
4347 (length (nth 2 y
)))))
4349 (lambda (x y
) (< (+ (length (nth 1 x
))
4351 (+ (length (nth 1 y
))
4352 (length (nth 2 y
))))))
4354 (lambda (x y
) (string< (car x
) (car y
))))
4355 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4356 byte-compile-call-tree-sort
))))))
4357 (message "Generating call tree...")
4358 (let ((rest byte-compile-call-tree
)
4359 (b (current-buffer))
4363 (prin1 (car (car rest
)) b
)
4364 (setq callers
(nth 1 (car rest
))
4365 calls
(nth 2 (car rest
)))
4367 (cond ((not (fboundp (setq f
(car (car rest
)))))
4369 " <top level>";; shouldn't insert nil then, actually -sk
4371 ((subrp (setq f
(symbol-function f
)))
4374 (format " ==> %s" f
))
4375 ((byte-code-function-p f
)
4376 "<compiled function>")
4378 "<malformed function>")
4379 ((eq 'macro
(car f
))
4380 (if (or (byte-code-function-p (cdr f
))
4381 (assq 'byte-code
(cdr (cdr (cdr f
)))))
4384 ((assq 'byte-code
(cdr (cdr f
)))
4385 "<compiled lambda>")
4386 ((eq 'lambda
(car f
))
4389 (format " (%d callers + %d calls = %d)"
4390 ;; Does the optimizer eliminate common subexpressions?-sk
4393 (+ (length callers
) (length calls
)))
4397 (insert " called by:\n")
4399 (insert " " (if (car callers
)
4400 (mapconcat 'symbol-name callers
", ")
4402 (let ((fill-prefix " "))
4403 (fill-region-as-paragraph p
(point)))
4404 (unless (= 0 (current-column))
4408 (insert " calls:\n")
4410 (insert " " (mapconcat 'symbol-name calls
", "))
4411 (let ((fill-prefix " "))
4412 (fill-region-as-paragraph p
(point)))
4413 (unless (= 0 (current-column))
4415 (setq rest
(cdr rest
)))
4417 (message "Generating call tree...(finding uncalled functions...)")
4418 (setq rest byte-compile-call-tree
)
4421 (or (nth 1 (car rest
))
4422 (null (setq f
(caar rest
)))
4424 (setq def
(byte-compile-fdefinition f t
))
4425 (and (eq (car-safe def
) 'macro
)
4426 (eq (car-safe (cdr-safe def
)) 'lambda
)
4427 (setq def
(cdr def
)))
4430 (setq def
(byte-compile-fdefinition f nil
))
4431 (and (eq (car-safe def
) 'macro
)
4432 (eq (car-safe (cdr-safe def
)) 'lambda
)
4433 (setq def
(cdr def
)))
4435 (setq uncalled
(cons f uncalled
)))
4436 (setq rest
(cdr rest
)))
4438 (let ((fill-prefix " "))
4439 (insert "Noninteractive functions not known to be called:\n ")
4441 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
4442 (fill-region-as-paragraph p
(point))))))
4443 (message "Generating call tree...done.")))
4447 (defun batch-byte-compile-if-not-done ()
4448 "Like `byte-compile-file' but doesn't recompile if already up to date.
4449 Use this from the command line, with `-batch';
4450 it won't work in an interactive Emacs."
4451 (batch-byte-compile t
))
4453 ;;; by crl@newton.purdue.edu
4454 ;;; Only works noninteractively.
4456 (defun batch-byte-compile (&optional noforce
)
4457 "Run `byte-compile-file' on the files remaining on the command line.
4458 Use this from the command line, with `-batch';
4459 it won't work in an interactive Emacs.
4460 Each file is processed even if an error occurred previously.
4461 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4462 If NOFORCE is non-nil, don't recompile a file that seems to be
4463 already up-to-date."
4464 ;; command-line-args-left is what is left of the command line, from
4466 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4467 (if (not noninteractive
)
4468 (error "`batch-byte-compile' is to be used only with -batch"))
4470 (while command-line-args-left
4471 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
4472 ;; Directory as argument.
4474 (dolist (file (directory-files (car command-line-args-left
)))
4475 (if (and (string-match emacs-lisp-file-regexp file
)
4476 (not (auto-save-file-name-p file
))
4478 (expand-file-name file
4479 (car command-line-args-left
)))
4480 (setq dest
(byte-compile-dest-file source
))
4481 (file-exists-p dest
)
4482 (file-newer-than-file-p source dest
))
4483 (if (null (batch-byte-compile-file source
))
4485 ;; Specific file argument
4486 (if (or (not noforce
)
4487 (let* ((source (car command-line-args-left
))
4488 (dest (byte-compile-dest-file source
)))
4489 (or (not (file-exists-p dest
))
4490 (file-newer-than-file-p source dest
))))
4491 (if (null (batch-byte-compile-file (car command-line-args-left
)))
4493 (setq command-line-args-left
(cdr command-line-args-left
)))
4494 (kill-emacs (if error
1 0))))
4496 (defun batch-byte-compile-file (file)
4498 (byte-compile-file file
)
4500 (byte-compile-file file
)
4502 (message (if (cdr err
)
4503 ">>Error occurred processing %s: %s (%s)"
4504 ">>Error occurred processing %s: %s")
4506 (get (car err
) 'error-message
)
4507 (prin1-to-string (cdr err
)))
4508 (let ((destfile (byte-compile-dest-file file
)))
4509 (if (file-exists-p destfile
)
4510 (delete-file destfile
)))
4513 (message (if (cdr err
)
4514 ">>Error occurred processing %s: %s (%s)"
4515 ">>Error occurred processing %s: %s")
4517 (get (car err
) 'error-message
)
4518 (prin1-to-string (cdr err
)))
4521 (defun byte-compile-refresh-preloaded ()
4522 "Reload any Lisp file that was changed since Emacs was dumped.
4524 (let* ((argv0 (car command-line-args
))
4525 (emacs-file (executable-find argv0
)))
4526 (if (not (and emacs-file
(file-executable-p emacs-file
)))
4527 (message "Can't find %s to refresh preloaded Lisp files" argv0
)
4528 (dolist (f (reverse load-history
))
4530 (if (string-match "elc\\'" f
) (setq f
(substring f
0 -
1)))
4531 (when (and (file-readable-p f
)
4532 (file-newer-than-file-p f emacs-file
)
4533 ;; Don't reload the source version of the files below
4534 ;; because that causes subsequent byte-compilation to
4535 ;; be a lot slower and need a higher max-lisp-eval-depth,
4536 ;; so it can cause recompilation to fail.
4537 (not (member (file-name-nondirectory f
)
4538 '("pcase.el" "bytecomp.el" "macroexp.el"
4539 "cconv.el" "byte-opt.el"))))
4540 (message "Reloading stale %s" (file-name-nondirectory f
))
4542 (load f
'noerror nil
'nosuffix
)
4543 ;; Probably shouldn't happen, but in case of an error, it seems
4544 ;; at least as useful to ignore it as it is to stop compilation.
4548 (defun batch-byte-recompile-directory (&optional arg
)
4549 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4550 Must be used only with `-batch', and kills Emacs on completion.
4551 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4553 Optional argument ARG is passed as second argument ARG to
4554 `byte-recompile-directory'; see there for its possible values
4555 and corresponding effects."
4556 ;; command-line-args-left is what is left of the command line (startup.el)
4557 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4558 (if (not noninteractive
)
4559 (error "batch-byte-recompile-directory is to be used only with -batch"))
4560 (or command-line-args-left
4561 (setq command-line-args-left
'(".")))
4562 (while command-line-args-left
4563 (byte-recompile-directory (car command-line-args-left
) arg
)
4564 (setq command-line-args-left
(cdr command-line-args-left
)))
4567 (provide 'byte-compile
)
4571 ;;; report metering (see the hacks in bytecode.c)
4573 (defvar byte-code-meter
)
4574 (defun byte-compile-report-ops ()
4575 (or (boundp 'byte-metering-on
)
4576 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4577 (with-output-to-temp-buffer "*Meter*"
4578 (set-buffer "*Meter*")
4579 (let ((i 0) n op off
)
4581 (setq n
(aref (aref byte-code-meter
0) i
)
4583 (if t
;(not (zerop n))
4587 (cond ((< op byte-nth
)
4588 (setq off
(logand op
7))
4589 (setq op
(logand op
248)))
4590 ((>= op byte-constant
)
4591 (setq off
(- op byte-constant
)
4593 (setq op
(aref byte-code-vector op
))
4594 (insert (format "%-4d" i
))
4595 (insert (symbol-name op
))
4596 (if off
(insert " [" (int-to-string off
) "]"))
4598 (insert (int-to-string n
) "\n")))
4601 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4602 ;; itself, compile some of its most used recursive functions (at load time).
4605 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
4606 (assq 'byte-code
(symbol-function 'byte-compile-form
))
4607 (let ((byte-optimize nil
) ; do it fast
4608 (byte-compile-warnings nil
))
4610 (or noninteractive
(message "compiling %s..." x
))
4612 (or noninteractive
(message "compiling %s...done" x
)))
4613 '(byte-compile-normal-call
4616 ;; Inserted some more than necessary, to speed it up.
4617 byte-compile-top-level
4618 byte-compile-out-toplevel
4619 byte-compile-constant
4620 byte-compile-variable-ref
))))
4623 (run-hooks 'bytecomp-load-hook
)
4625 ;;; bytecomp.el ends here