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 ;; FIXME: Use lexical-binding and get rid of the atrocious "bytecomp-"
39 ;; ========================================================================
41 ;; byte-recompile-directory, byte-compile-file,
42 ;; byte-recompile-file,
43 ;; batch-byte-compile, batch-byte-recompile-directory,
44 ;; byte-compile, compile-defun,
46 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
47 ;; because they are not terribly useful and get in the way of completion.)
49 ;; This version of the byte compiler has the following improvements:
50 ;; + optimization of compiled code:
51 ;; - removal of unreachable code;
52 ;; - removal of calls to side-effectless functions whose return-value
54 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
56 ;; - open-coding of literal lambdas;
57 ;; - peephole optimization of emitted code;
58 ;; - trivial functions are left uncompiled for speed.
59 ;; + support for inline functions;
60 ;; + compile-time evaluation of arbitrary expressions;
61 ;; + compile-time warning messages for:
62 ;; - functions being redefined with incompatible arglists;
63 ;; - functions being redefined as macros, or vice-versa;
64 ;; - functions or macros defined multiple times in the same file;
65 ;; - functions being called with the incorrect number of arguments;
66 ;; - functions being called which are not defined globally, in the
67 ;; file, or as autoloads;
68 ;; - assignment and reference of undeclared free variables;
69 ;; - various syntax errors;
70 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
71 ;; + correct compilation of top-level uses of macros;
72 ;; + the ability to generate a histogram of functions called.
74 ;; User customization variables: M-x customize-group bytecomp
78 ;; o The form `defsubst' is just like `defun', except that the function
79 ;; generated will be open-coded in compiled code which uses it. This
80 ;; means that no function call will be generated, it will simply be
81 ;; spliced in. Lisp functions calls are very slow, so this can be a
84 ;; You can generally accomplish the same thing with `defmacro', but in
85 ;; that case, the defined procedure can't be used as an argument to
88 ;; o You can also open-code one particular call to a function without
89 ;; open-coding all calls. Use the 'inline' form to do this, like so:
91 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
93 ;; (inline ;; `foo' and `baz' will be
94 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
97 ;; o It is possible to open-code a function in the same file it is defined
98 ;; in without having to load that file before compiling it. The
99 ;; byte-compiler has been modified to remember function definitions in
100 ;; the compilation environment in the same way that it remembers macro
103 ;; o Forms like ((lambda ...) ...) are open-coded.
105 ;; o The form `eval-when-compile' is like progn, except that the body
106 ;; is evaluated at compile-time. When it appears at top-level, this
107 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
108 ;; When it does not appear at top-level, it is similar to the
109 ;; Common Lisp #. reader macro (but not in interpreted code).
111 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
112 ;; the whole form is evalled both at compile-time and at run-time.
114 ;; o The command compile-defun is analogous to eval-defun.
116 ;; o If you run byte-compile-file on a filename which is visited in a
117 ;; buffer, and that buffer is modified, you are asked whether you want
118 ;; to save the buffer before compiling.
120 ;; o byte-compiled files now start with the string `;ELC'.
121 ;; Some versions of `file' can be customized to recognize that.
126 (eval-when-compile (require 'cl
))
128 (or (fboundp 'defsubst
)
129 ;; This really ought to be loaded already!
132 ;; The feature of compiling in a specific target Emacs version
133 ;; has been turned off because compile time options are a bad idea.
134 (defmacro byte-compile-single-version
() nil
)
135 (defmacro byte-compile-version-cond
(cond) cond
)
138 (defgroup bytecomp nil
139 "Emacs Lisp byte-compiler."
142 (defcustom emacs-lisp-file-regexp
"\\.el\\'"
143 "Regexp which matches Emacs Lisp source files.
144 If you change this, you might want to set `byte-compile-dest-file-function'."
148 (defcustom byte-compile-dest-file-function nil
149 "Function for the function `byte-compile-dest-file' to call.
150 It should take one argument, the name of an Emacs Lisp source
151 file name, and return the name of the compiled file."
153 :type
'(choice (const nil
) function
)
156 ;; This enables file name handlers such as jka-compr
157 ;; to remove parts of the file name that should not be copied
158 ;; through to the output file name.
159 (defun byte-compiler-base-file-name (filename)
160 (let ((handler (find-file-name-handler filename
161 'byte-compiler-base-file-name
)))
163 (funcall handler
'byte-compiler-base-file-name filename
)
166 (or (fboundp 'byte-compile-dest-file
)
167 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
168 ;; so only define it if it is undefined.
169 ;; Note - redefining this function is obsolete as of 23.2.
170 ;; Customize byte-compile-dest-file-function instead.
171 (defun byte-compile-dest-file (filename)
172 "Convert an Emacs Lisp source file name to a compiled file name.
173 If `byte-compile-dest-file-function' is non-nil, uses that
174 function to do the work. Otherwise, if FILENAME matches
175 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
176 adds `c' to it; otherwise adds `.elc'."
177 (if byte-compile-dest-file-function
178 (funcall byte-compile-dest-file-function filename
)
179 (setq filename
(file-name-sans-versions
180 (byte-compiler-base-file-name filename
)))
181 (cond ((string-match emacs-lisp-file-regexp filename
)
182 (concat (substring filename
0 (match-beginning 0)) ".elc"))
183 (t (concat filename
".elc"))))))
185 ;; This can be the 'byte-compile property of any symbol.
186 (autoload 'byte-compile-inline-expand
"byte-opt")
188 ;; This is the entrypoint to the lapcode optimizer pass1.
189 (autoload 'byte-optimize-form
"byte-opt")
190 ;; This is the entrypoint to the lapcode optimizer pass2.
191 (autoload 'byte-optimize-lapcode
"byte-opt")
192 (autoload 'byte-compile-unfold-lambda
"byte-opt")
194 ;; This is the entry point to the decompiler, which is used by the
195 ;; disassembler. The disassembler just requires 'byte-compile, but
196 ;; that doesn't define this function, so this seems to be a reasonable
198 (autoload 'byte-decompile-bytecode
"byte-opt")
200 (defcustom byte-compile-verbose
201 (and (not noninteractive
) (> baud-rate search-slow-speed
))
202 "Non-nil means print messages describing progress of byte-compiler."
206 (defcustom byte-optimize t
207 "Enable optimization in the byte compiler.
209 nil - no optimization
210 t - all optimizations
211 `source' - source-level optimizations only
212 `byte' - code-level optimizations only"
214 :type
'(choice (const :tag
"none" nil
)
216 (const :tag
"source-level" source
)
217 (const :tag
"byte-level" byte
)))
219 (defcustom byte-compile-delete-errors nil
220 "If non-nil, the optimizer may delete forms that may signal an error.
221 This includes variable references and calls to functions such as `car'."
225 (defvar byte-compile-dynamic nil
226 "If non-nil, compile function bodies so they load lazily.
227 They are hidden in comments in the compiled file,
228 and each one is brought into core when the
231 To enable this option, make it a file-local variable
232 in the source file you want it to apply to.
233 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
235 When this option is true, if you load the compiled file and then move it,
236 the functions you loaded will not be able to run.")
237 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
239 (defvar byte-compile-disable-print-circle nil
240 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
241 (make-obsolete-variable 'byte-compile-disable-print-circle nil
"24.1")
242 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
244 (defcustom byte-compile-dynamic-docstrings t
245 "If non-nil, compile doc strings for lazy access.
246 We bury the doc strings of functions and variables inside comments in
247 the file, and bring them into core only when they are actually needed.
249 When this option is true, if you load the compiled file and then move it,
250 you won't be able to find the documentation of anything in that file.
252 To disable this option for a certain file, make it a file-local variable
253 in the source file. For example, add this to the first line:
254 -*-byte-compile-dynamic-docstrings:nil;-*-
255 You can also set the variable globally.
257 This option is enabled by default because it reduces Emacs memory usage."
260 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
262 (defconst byte-compile-log-buffer
"*Compile-Log*"
263 "Name of the byte-compiler's log buffer.")
265 (defcustom byte-optimize-log nil
266 "If non-nil, the byte-compiler will log its optimizations.
267 If this is 'source, then only source-level optimizations will be logged.
268 If it is 'byte, then only byte-level optimizations will be logged.
269 The information is logged to `byte-compile-log-buffer'."
271 :type
'(choice (const :tag
"none" nil
)
273 (const :tag
"source-level" source
)
274 (const :tag
"byte-level" byte
)))
276 (defcustom byte-compile-error-on-warn nil
277 "If true, the byte-compiler reports warnings with `error'."
281 (defconst byte-compile-warning-types
282 '(redefine callargs free-vars unresolved
283 obsolete noruntime cl-functions interactive-only
284 make-local mapcar constants suspicious lexical
)
285 "The list of warning types used when `byte-compile-warnings' is t.")
286 (defcustom byte-compile-warnings t
287 "List of warnings that the byte-compiler should issue (t for all).
289 Elements of the list may be:
291 free-vars references to variables not in the current lexical scope.
292 unresolved calls to unknown functions.
293 callargs function calls with args that don't match the definition.
294 redefine function name redefined from a macro to ordinary function or vice
295 versa, or redefined to take a different number of arguments.
296 obsolete obsolete variables and functions.
297 noruntime functions that may not be defined at runtime (typically
298 defined only under `eval-when-compile').
299 cl-functions calls to runtime functions from the CL package (as
300 distinguished from macros and aliases).
302 commands that normally shouldn't be called from Lisp code.
303 make-local calls to make-variable-buffer-local that may be incorrect.
304 mapcar mapcar called for effect.
305 constants let-binding of, or assignment to, constants/nonvariables.
306 suspicious constructs that usually don't do what the coder wanted.
308 If the list begins with `not', then the remaining elements specify warnings to
309 suppress. For example, (not mapcar) will suppress warnings about mapcar."
311 :type
`(choice (const :tag
"All" t
)
312 (set :menu-tag
"Some"
313 ,@(mapcar (lambda (x) `(const ,x
))
314 byte-compile-warning-types
))))
317 (put 'byte-compile-warnings
'safe-local-variable
320 (null (delq nil
(mapcar (lambda (x) (not (symbolp x
))) v
))))))
322 (defun byte-compile-warning-enabled-p (warning)
323 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
324 (or (eq byte-compile-warnings t
)
325 (if (eq (car byte-compile-warnings
) 'not
)
326 (not (memq warning byte-compile-warnings
))
327 (memq warning byte-compile-warnings
))))
330 (defun byte-compile-disable-warning (warning)
331 "Change `byte-compile-warnings' to disable WARNING.
332 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
333 Otherwise, if the first element is `not', add WARNING, else remove it.
334 Normally you should let-bind `byte-compile-warnings' before calling this,
335 else the global value will be modified."
336 (setq byte-compile-warnings
337 (cond ((eq byte-compile-warnings t
)
339 ((eq (car byte-compile-warnings
) 'not
)
340 (if (memq warning byte-compile-warnings
)
341 byte-compile-warnings
342 (append byte-compile-warnings
(list warning
))))
344 (delq warning byte-compile-warnings
)))))
347 (defun byte-compile-enable-warning (warning)
348 "Change `byte-compile-warnings' to enable WARNING.
349 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
350 first element is `not', remove WARNING, else add it.
351 Normally you should let-bind `byte-compile-warnings' before calling this,
352 else the global value will be modified."
353 (or (eq byte-compile-warnings t
)
354 (setq byte-compile-warnings
355 (cond ((eq (car byte-compile-warnings
) 'not
)
356 (delq warning byte-compile-warnings
))
357 ((memq warning byte-compile-warnings
)
358 byte-compile-warnings
)
360 (append byte-compile-warnings
(list warning
)))))))
362 (defvar byte-compile-interactive-only-functions
363 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
364 insert-file insert-buffer insert-file-literally previous-line next-line
365 goto-line comint-run delete-backward-char
)
366 "List of commands that are not meant to be called from Lisp.")
368 (defvar byte-compile-not-obsolete-vars nil
369 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
371 (defvar byte-compile-not-obsolete-funcs nil
372 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
374 (defcustom byte-compile-generate-call-tree nil
375 "Non-nil means collect call-graph information when compiling.
376 This records which functions were called and from where.
377 If the value is t, compilation displays the call graph when it finishes.
378 If the value is neither t nor nil, compilation asks you whether to display
381 The call tree only lists functions called, not macros used. Those functions
382 which the byte-code interpreter knows about directly (eq, cons, etc.) are
385 The call tree also lists those functions which are not known to be called
386 \(that is, to which no calls have been compiled). Functions which can be
387 invoked interactively are excluded from this list."
389 :type
'(choice (const :tag
"Yes" t
) (const :tag
"No" nil
)
390 (other :tag
"Ask" lambda
)))
392 (defvar byte-compile-call-tree nil
393 "Alist of functions and their call tree.
394 Each element looks like
396 \(FUNCTION CALLERS CALLS\)
398 where CALLERS is a list of functions that call FUNCTION, and CALLS
399 is a list of functions for which calls were generated while compiling
402 (defcustom byte-compile-call-tree-sort
'name
403 "If non-nil, sort the call tree.
404 The values `name', `callers', `calls', `calls+callers'
405 specify different fields to sort on."
407 :type
'(choice (const name
) (const callers
) (const calls
)
408 (const calls
+callers
) (const nil
)))
410 (defvar byte-compile-debug t
)
411 (setq debug-on-error t
)
413 (defvar byte-compile-constants nil
414 "List of all constants encountered during compilation of this form.")
415 (defvar byte-compile-variables nil
416 "List of all variables encountered during compilation of this form.")
417 (defvar byte-compile-bound-variables nil
418 "List of dynamic variables bound in the context of the current form.
419 This list lives partly on the stack.")
420 (defvar byte-compile-const-variables nil
421 "List of variables declared as constants during compilation of this file.")
422 (defvar byte-compile-free-references
)
423 (defvar byte-compile-free-assignments
)
425 (defvar byte-compiler-error-flag
)
427 (defconst byte-compile-initial-macro-environment
429 ;; (byte-compiler-options . (lambda (&rest forms)
430 ;; (apply 'byte-compiler-options-handler forms)))
431 (declare-function . byte-compile-macroexpand-declare-function
)
432 (eval-when-compile .
(lambda (&rest body
)
435 ;; FIXME: is that right in lexbind code?
437 (byte-compile-top-level
440 byte-compile-initial-macro-environment
))))))
441 (eval-and-compile .
(lambda (&rest body
)
442 (byte-compile-eval-before-compile (cons 'progn body
))
443 (cons 'progn body
))))
444 "The default macro-environment passed to macroexpand by the compiler.
445 Placing a macro here will cause a macro to have different semantics when
446 expanded by the compiler as when expanded by the interpreter.")
448 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
449 "Alist of macros defined in the file being compiled.
450 Each element looks like (MACRONAME . DEFINITION). It is
451 \(MACRONAME . nil) when a macro is redefined as a function.")
453 (defvar byte-compile-function-environment nil
454 "Alist of functions defined in the file being compiled.
455 This is so we can inline them when necessary.
456 Each element looks like (FUNCTIONNAME . DEFINITION). It is
457 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
458 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
459 and we don't know the definition. For an autoloaded function, DEFINITION
460 has the form (autoload . FILENAME).")
462 (defvar byte-compile-unresolved-functions nil
463 "Alist of undefined functions to which calls have been compiled.
464 This variable is only significant whilst compiling an entire buffer.
465 Used for warnings when a function is not known to be defined or is later
466 defined with incorrect args.")
468 (defvar byte-compile-noruntime-functions nil
469 "Alist of functions called that may not be defined when the compiled code is run.
470 Used for warnings about calling a function that is defined during compilation
471 but won't necessarily be defined when the compiled file is loaded.")
473 ;; Variables for lexical binding
474 (defvar byte-compile-lexical-environment nil
475 "The current lexical environment.")
477 (defvar byte-compile-tag-number
0)
478 (defvar byte-compile-output nil
479 "Alist describing contents to put in byte code string.
480 Each element is (INDEX . VALUE)")
481 (defvar byte-compile-depth
0 "Current depth of execution stack.")
482 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
485 ;;; The byte codes; this information is duplicated in bytecomp.c
487 (defvar byte-code-vector nil
488 "An array containing byte-code names indexed by byte-code values.")
490 (defvar byte-stack
+-info nil
491 "An array with the stack adjustment for each byte-code.")
493 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
494 ;; This is a speed-hack for building the byte-code-vector at compile-time.
495 ;; We fill in the vector at macroexpand-time, and then after the last call
496 ;; to byte-defop, we write the vector out as a constant instead of writing
497 ;; out a bunch of calls to aset.
498 ;; Actually, we don't fill in the vector itself, because that could make
499 ;; it problematic to compile big changes to this compiler; we store the
500 ;; values on its plist, and remove them later in -extrude.
501 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
502 (put 'byte-code-vector
'tmp-compile-time-value
503 (make-vector 256 nil
))))
504 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
505 (put 'byte-stack
+-info
'tmp-compile-time-value
506 (make-vector 256 nil
)))))
507 (aset v1 opcode opname
)
508 (aset v2 opcode stack-adjust
))
510 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
511 (list 'defconst opname opcode
)))
513 (defmacro byte-extrude-byte-code-vectors
()
514 (prog1 (list 'setq
'byte-code-vector
515 (get 'byte-code-vector
'tmp-compile-time-value
)
517 (get 'byte-stack
+-info
'tmp-compile-time-value
))
518 (put 'byte-code-vector
'tmp-compile-time-value nil
)
519 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
522 ;; These opcodes are special in that they pack their argument into the
525 (byte-defop 0 1 byte-stack-ref
"for stack reference")
526 (byte-defop 8 1 byte-varref
"for variable reference")
527 (byte-defop 16 -
1 byte-varset
"for setting a variable")
528 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
529 (byte-defop 32 0 byte-call
"for calling a function")
530 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
531 ;; codes 8-47 are consumed by the preceding opcodes
535 (byte-defop 56 -
1 byte-nth
)
536 (byte-defop 57 0 byte-symbolp
)
537 (byte-defop 58 0 byte-consp
)
538 (byte-defop 59 0 byte-stringp
)
539 (byte-defop 60 0 byte-listp
)
540 (byte-defop 61 -
1 byte-eq
)
541 (byte-defop 62 -
1 byte-memq
)
542 (byte-defop 63 0 byte-not
)
543 (byte-defop 64 0 byte-car
)
544 (byte-defop 65 0 byte-cdr
)
545 (byte-defop 66 -
1 byte-cons
)
546 (byte-defop 67 0 byte-list1
)
547 (byte-defop 68 -
1 byte-list2
)
548 (byte-defop 69 -
2 byte-list3
)
549 (byte-defop 70 -
3 byte-list4
)
550 (byte-defop 71 0 byte-length
)
551 (byte-defop 72 -
1 byte-aref
)
552 (byte-defop 73 -
2 byte-aset
)
553 (byte-defop 74 0 byte-symbol-value
)
554 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
555 (byte-defop 76 -
1 byte-set
)
556 (byte-defop 77 -
1 byte-fset
) ; this was commented out
557 (byte-defop 78 -
1 byte-get
)
558 (byte-defop 79 -
2 byte-substring
)
559 (byte-defop 80 -
1 byte-concat2
)
560 (byte-defop 81 -
2 byte-concat3
)
561 (byte-defop 82 -
3 byte-concat4
)
562 (byte-defop 83 0 byte-sub1
)
563 (byte-defop 84 0 byte-add1
)
564 (byte-defop 85 -
1 byte-eqlsign
)
565 (byte-defop 86 -
1 byte-gtr
)
566 (byte-defop 87 -
1 byte-lss
)
567 (byte-defop 88 -
1 byte-leq
)
568 (byte-defop 89 -
1 byte-geq
)
569 (byte-defop 90 -
1 byte-diff
)
570 (byte-defop 91 0 byte-negate
)
571 (byte-defop 92 -
1 byte-plus
)
572 (byte-defop 93 -
1 byte-max
)
573 (byte-defop 94 -
1 byte-min
)
574 (byte-defop 95 -
1 byte-mult
) ; v19 only
575 (byte-defop 96 1 byte-point
)
576 (byte-defop 98 0 byte-goto-char
)
577 (byte-defop 99 0 byte-insert
)
578 (byte-defop 100 1 byte-point-max
)
579 (byte-defop 101 1 byte-point-min
)
580 (byte-defop 102 0 byte-char-after
)
581 (byte-defop 103 1 byte-following-char
)
582 (byte-defop 104 1 byte-preceding-char
)
583 (byte-defop 105 1 byte-current-column
)
584 (byte-defop 106 0 byte-indent-to
)
585 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
586 (byte-defop 108 1 byte-eolp
)
587 (byte-defop 109 1 byte-eobp
)
588 (byte-defop 110 1 byte-bolp
)
589 (byte-defop 111 1 byte-bobp
)
590 (byte-defop 112 1 byte-current-buffer
)
591 (byte-defop 113 0 byte-set-buffer
)
592 (byte-defop 114 0 byte-save-current-buffer
593 "To make a binding to record the current buffer")
594 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
596 ;; These ops are new to v19
597 (byte-defop 117 0 byte-forward-char
)
598 (byte-defop 118 0 byte-forward-word
)
599 (byte-defop 119 -
1 byte-skip-chars-forward
)
600 (byte-defop 120 -
1 byte-skip-chars-backward
)
601 (byte-defop 121 0 byte-forward-line
)
602 (byte-defop 122 0 byte-char-syntax
)
603 (byte-defop 123 -
1 byte-buffer-substring
)
604 (byte-defop 124 -
1 byte-delete-region
)
605 (byte-defop 125 -
1 byte-narrow-to-region
)
606 (byte-defop 126 1 byte-widen
)
607 (byte-defop 127 0 byte-end-of-line
)
611 ;; These store their argument in the next two bytes
612 (byte-defop 129 1 byte-constant2
613 "for reference to a constant with vector index >= byte-constant-limit")
614 (byte-defop 130 0 byte-goto
"for unconditional jump")
615 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
616 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
617 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
618 "to examine top-of-stack, jump and don't pop it if it's nil,
620 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
621 "to examine top-of-stack, jump and don't pop it if it's non nil,
624 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
625 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
626 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
628 (byte-defop 138 0 byte-save-excursion
629 "to make a binding to record the buffer, point and mark")
630 (byte-defop 140 0 byte-save-restriction
631 "to make a binding to record the current buffer clipping restrictions")
632 (byte-defop 141 -
1 byte-catch
633 "for catch. Takes, on stack, the tag and an expression for the body")
634 (byte-defop 142 -
1 byte-unwind-protect
635 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
637 ;; For condition-case. Takes, on stack, the variable to bind,
638 ;; an expression for the body, and a list of clauses.
639 (byte-defop 143 -
2 byte-condition-case
)
641 ;; For entry to with-output-to-temp-buffer.
642 ;; Takes, on stack, the buffer name.
643 ;; Binds standard-output and does some other things.
644 ;; Returns with temp buffer on the stack in place of buffer name.
645 ;; (byte-defop 144 0 byte-temp-output-buffer-setup)
647 ;; For exit from with-output-to-temp-buffer.
648 ;; Expects the temp buffer on the stack underneath value to return.
649 ;; Pops them both, then pushes the value back on.
650 ;; Unbinds standard-output and makes the temp buffer visible.
651 ;; (byte-defop 145 -1 byte-temp-output-buffer-show)
653 ;; these ops are new to v19
655 ;; To unbind back to the beginning of this frame.
656 ;; Not used yet, but will be needed for tail-recursion elimination.
657 (byte-defop 146 0 byte-unbind-all
)
659 ;; these ops are new to v19
660 (byte-defop 147 -
2 byte-set-marker
)
661 (byte-defop 148 0 byte-match-beginning
)
662 (byte-defop 149 0 byte-match-end
)
663 (byte-defop 150 0 byte-upcase
)
664 (byte-defop 151 0 byte-downcase
)
665 (byte-defop 152 -
1 byte-string
=)
666 (byte-defop 153 -
1 byte-string
<)
667 (byte-defop 154 -
1 byte-equal
)
668 (byte-defop 155 -
1 byte-nthcdr
)
669 (byte-defop 156 -
1 byte-elt
)
670 (byte-defop 157 -
1 byte-member
)
671 (byte-defop 158 -
1 byte-assq
)
672 (byte-defop 159 0 byte-nreverse
)
673 (byte-defop 160 -
1 byte-setcar
)
674 (byte-defop 161 -
1 byte-setcdr
)
675 (byte-defop 162 0 byte-car-safe
)
676 (byte-defop 163 0 byte-cdr-safe
)
677 (byte-defop 164 -
1 byte-nconc
)
678 (byte-defop 165 -
1 byte-quo
)
679 (byte-defop 166 -
1 byte-rem
)
680 (byte-defop 167 0 byte-numberp
)
681 (byte-defop 168 0 byte-integerp
)
685 (byte-defop 175 nil byte-listN
)
686 (byte-defop 176 nil byte-concatN
)
687 (byte-defop 177 nil byte-insertN
)
689 (byte-defop 178 -
1 byte-stack-set
) ; stack offset in following one byte
690 (byte-defop 179 -
1 byte-stack-set2
) ; stack offset in following two bytes
692 ;; if (following one byte & 0x80) == 0
693 ;; discard (following one byte & 0x7F) stack entries
695 ;; discard (following one byte & 0x7F) stack entries _underneath_ the top of stack
696 ;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
697 (byte-defop 182 nil byte-discardN
)
698 ;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
699 ;; `byte-discardN' with the high bit in the operand set (by
700 ;; `byte-compile-lapcode').
701 (defconst byte-discardN-preserve-tos byte-discardN
)
705 (byte-defop 192 1 byte-constant
"for reference to a constant")
706 ;; codes 193-255 are consumed by byte-constant.
707 (defconst byte-constant-limit
64
708 "Exclusive maximum index usable in the `byte-constant' opcode.")
710 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
711 byte-goto-if-nil-else-pop
712 byte-goto-if-not-nil-else-pop
)
713 "List of byte-codes whose offset is a pc.")
715 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
717 (byte-extrude-byte-code-vectors)
719 ;;; lapcode generator
721 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
722 ;; source -> bytecode, because it's a lot easier to make optimizations
723 ;; on lapcode than on bytecode.
725 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
726 ;; where instruction is a symbol naming a byte-code instruction,
727 ;; and parameter is an argument to that instruction, if any.
729 ;; The instruction can be the pseudo-op TAG, which means that this position
730 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
731 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
732 ;; parameter for some goto op.
734 ;; If the operation is varbind, varref, varset or push-constant, then the
735 ;; parameter is (variable/constant . index_in_constant_vector).
737 ;; First, the source code is macroexpanded and optimized in various ways.
738 ;; Then the resultant code is compiled into lapcode. Another set of
739 ;; optimizations are then run over the lapcode. Then the variables and
740 ;; constants referenced by the lapcode are collected and placed in the
741 ;; constants-vector. (This happens now so that variables referenced by dead
742 ;; code don't consume space.) And finally, the lapcode is transformed into
743 ;; compacted byte-code.
745 ;; A distinction is made between variables and constants because the variable-
746 ;; referencing instructions are more sensitive to the variables being near the
747 ;; front of the constants-vector than the constant-referencing instructions.
748 ;; Also, this lets us notice references to free variables.
750 (defmacro byte-compile-push-bytecodes
(&rest args
)
751 "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
752 ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
753 BYTES and PC are updated after evaluating all the arguments."
754 (let ((byte-exprs (butlast args
2))
755 (bytes-var (car (last args
2)))
756 (pc-var (car (last args
))))
757 `(setq ,bytes-var
,(if (null (cdr byte-exprs
))
758 `(progn (assert (<= 0 ,(car byte-exprs
)))
759 (cons ,@byte-exprs
,bytes-var
))
760 `(nconc (list ,@(reverse byte-exprs
)) ,bytes-var
))
761 ,pc-var
(+ ,(length byte-exprs
) ,pc-var
))))
763 (defmacro byte-compile-push-bytecode-const2
(opcode const2 bytes pc
)
764 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
765 CONST2 may be evaulated multiple times."
766 `(byte-compile-push-bytecodes ,opcode
(logand ,const2
255) (lsh ,const2 -
8)
769 (defun byte-compile-lapcode (lap)
770 "Turns lapcode into bytecode. The lapcode is destroyed."
771 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
772 (let ((pc 0) ; Program counter
773 op off
; Operation & offset
774 opcode
; numeric value of OP
775 (bytes '()) ; Put the output bytes here
776 (patchlist nil
)) ; List of gotos to patch
777 (dolist (lap-entry lap
)
778 (setq op
(car lap-entry
)
782 (error "Non-symbolic opcode `%s'" op
))
786 ;; a no-op added by `byte-compile-delay-out'
789 "Placeholder added by `byte-compile-delay-out' not filled in.")
793 (if (eq op
'byte-discardN-preserve-tos
)
794 ;; byte-discardN-preserve-tos is a pseudo op, which
795 ;; is actually the same as byte-discardN
796 ;; with a modified argument.
799 (cond ((memq op byte-goto-ops
)
801 (byte-compile-push-bytecodes opcode nil
(cdr off
) bytes pc
)
802 (push bytes patchlist
))
803 ((or (and (consp off
)
804 ;; Variable or constant reference
807 (eq op
'byte-constant
)))
808 (and (eq op
'byte-constant
) ;; 'byte-closed-var
811 (if (< off byte-constant-limit
)
812 (byte-compile-push-bytecodes (+ byte-constant off
)
814 (byte-compile-push-bytecode-const2 byte-constant2 off
816 ((and (= opcode byte-stack-set
)
818 ;; Use the two-byte version of byte-stack-set if the
819 ;; offset is too large for the normal version.
820 (byte-compile-push-bytecode-const2 byte-stack-set2 off
822 ((and (>= opcode byte-listN
)
823 (< opcode byte-discardN
))
824 ;; These insns all put their operand into one extra byte.
825 (byte-compile-push-bytecodes opcode off bytes pc
))
826 ((= opcode byte-discardN
)
827 ;; byte-discardN is weird in that it encodes a flag in the
828 ;; top bit of its one-byte argument. If the argument is
829 ;; too large to fit in 7 bits, the opcode can be repeated.
830 (let ((flag (if (eq op
'byte-discardN-preserve-tos
) #x80
0)))
832 (byte-compile-push-bytecodes opcode
(logior #x7f flag
) bytes pc
)
833 (setq off
(- off
#x7f
)))
834 (byte-compile-push-bytecodes opcode
(logior off flag
) bytes pc
)))
836 ;; opcode that doesn't use OFF
837 (byte-compile-push-bytecodes opcode bytes pc
))
838 ((and (eq opcode byte-stack-ref
) (eq off
0))
839 ;; (stack-ref 0) is really just another name for `dup'.
840 (debug) ;FIXME: When would this happen?
841 (byte-compile-push-bytecodes byte-dup bytes pc
))
842 ;; The following three cases are for the special
843 ;; insns that encode their operand into 0, 1, or 2
844 ;; extra bytes depending on its magnitude.
846 (byte-compile-push-bytecodes (+ opcode off
) bytes pc
))
848 (byte-compile-push-bytecodes (+ opcode
6) off bytes pc
))
850 (byte-compile-push-bytecode-const2 (+ opcode
7) off
852 ;;(if (not (= pc (length bytes)))
853 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
855 ;; Patch tag PCs into absolute jumps
856 (dolist (bytes-tail patchlist
)
857 (setq pc
(caar bytes-tail
)) ; Pick PC from goto's tag
858 (setcar (cdr bytes-tail
) (logand pc
255))
859 (setcar bytes-tail
(lsh pc -
8))
860 ;; FIXME: Replace this by some workaround.
861 (if (> (car bytes
) 255) (error "Bytecode overflow")))
863 (apply 'unibyte-string
(nreverse bytes
))))
866 ;;; compile-time evaluation
868 (defun byte-compile-cl-file-p (file)
869 "Return non-nil if FILE is one of the CL files."
871 (string-match "^cl\\>" (file-name-nondirectory file
))))
873 (defun byte-compile-eval (form)
874 "Eval FORM and mark the functions defined therein.
875 Each function's symbol gets added to `byte-compile-noruntime-functions'."
876 (let ((hist-orig load-history
)
877 (hist-nil-orig current-load-list
))
879 (when (byte-compile-warning-enabled-p 'noruntime
)
880 (let ((hist-new load-history
)
881 (hist-nil-new current-load-list
))
882 ;; Go through load-history, look for newly loaded files
883 ;; and mark all the functions defined therein.
884 (while (and hist-new
(not (eq hist-new hist-orig
)))
885 (let ((xs (pop hist-new
))
887 ;; Make sure the file was not already loaded before.
888 (unless (or (assoc (car xs
) hist-orig
)
889 ;; Don't give both the "noruntime" and
890 ;; "cl-functions" warning for the same function.
891 ;; FIXME This seems incorrect - these are two
892 ;; independent warnings. For example, you may be
893 ;; choosing to see the cl warnings but ignore them.
894 ;; You probably don't want to ignore noruntime in the
896 (and (byte-compile-warning-enabled-p 'cl-functions
)
897 (byte-compile-cl-file-p (car xs
))))
901 (unless (memq s old-autoloads
)
902 (push s byte-compile-noruntime-functions
)))
903 ((and (consp s
) (eq t
(car s
)))
904 (push (cdr s
) old-autoloads
))
905 ((and (consp s
) (eq 'autoload
(car s
)))
906 (push (cdr s
) byte-compile-noruntime-functions
)))))))
907 ;; Go through current-load-list for the locally defined funs.
909 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
910 (let ((s (pop hist-nil-new
)))
911 (when (and (symbolp s
) (not (memq s old-autoloads
)))
912 (push s byte-compile-noruntime-functions
))
913 (when (and (consp s
) (eq t
(car s
)))
914 (push (cdr s
) old-autoloads
)))))))
915 (when (byte-compile-warning-enabled-p 'cl-functions
)
916 (let ((hist-new load-history
))
917 ;; Go through load-history, looking for the cl files.
918 ;; Since new files are added at the start of load-history,
919 ;; we scan the new history until the tail matches the old.
920 (while (and (not byte-compile-cl-functions
)
921 hist-new
(not (eq hist-new hist-orig
)))
922 ;; We used to check if the file had already been loaded,
923 ;; but it is better to check non-nil byte-compile-cl-functions.
924 (and (byte-compile-cl-file-p (car (pop hist-new
)))
925 (byte-compile-find-cl-functions))))))))
927 (defun byte-compile-eval-before-compile (form)
928 "Evaluate FORM for `eval-and-compile'."
929 (let ((hist-nil-orig current-load-list
))
931 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
932 ;; FIXME Why does it do that - just as a hack?
933 ;; There are other ways to do this nowadays.
934 (let ((tem current-load-list
))
935 (while (not (eq tem hist-nil-orig
))
936 (when (equal (car tem
) '(require . cl
))
937 (byte-compile-disable-warning 'cl-functions
))
938 (setq tem
(cdr tem
)))))))
940 ;;; byte compiler messages
942 (defvar byte-compile-current-form nil
)
943 (defvar byte-compile-dest-file nil
)
944 (defvar byte-compile-current-file nil
)
945 (defvar byte-compile-current-group nil
)
946 (defvar byte-compile-current-buffer nil
)
948 ;; Log something that isn't a warning.
949 (defmacro byte-compile-log
(format-string &rest args
)
952 (memq byte-optimize-log
'(t source
))
953 (let ((print-escape-newlines t
)
960 (lambda (x) (if (symbolp x
) (list 'prin1-to-string x
) x
))
963 ;; Log something that isn't a warning.
964 (defun byte-compile-log-1 (string)
965 (with-current-buffer byte-compile-log-buffer
966 (let ((inhibit-read-only t
))
967 (goto-char (point-max))
968 (byte-compile-warning-prefix nil nil
)
969 (cond (noninteractive
970 (message " %s" string
))
972 (insert (format "%s\n" string
)))))))
974 (defvar byte-compile-read-position nil
975 "Character position we began the last `read' from.")
976 (defvar byte-compile-last-position nil
977 "Last known character position in the input.")
979 ;; copied from gnus-util.el
980 (defsubst byte-compile-delete-first
(elt list
)
981 (if (eq (car list
) elt
)
984 (while (and (cdr list
)
985 (not (eq (cadr list
) elt
)))
986 (setq list
(cdr list
)))
988 (setcdr list
(cddr list
)))
991 ;; The purpose of this function is to iterate through the
992 ;; `read-symbol-positions-list'. Each time we process, say, a
993 ;; function definition (`defun') we remove `defun' from
994 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
995 ;; to that symbol's character position. Similarly, if we encounter a
996 ;; variable reference, like in (1+ foo), we remove `foo' from the
997 ;; list. If our current position is after the symbol's position, we
998 ;; assume we've already passed that point, and look for the next
999 ;; occurrence of the symbol.
1001 ;; This function should not be called twice for the same occurrence of
1002 ;; a symbol, and it should not be called for symbols generated by the
1003 ;; byte compiler itself; because rather than just fail looking up the
1004 ;; symbol, we may find an occurrence of the symbol further ahead, and
1005 ;; then `byte-compile-last-position' as advanced too far.
1007 ;; So your're probably asking yourself: Isn't this function a
1008 ;; gross hack? And the answer, of course, would be yes.
1009 (defun byte-compile-set-symbol-position (sym &optional allow-previous
)
1010 (when byte-compile-read-position
1013 (setq last byte-compile-last-position
1014 entry
(assq sym read-symbol-positions-list
))
1016 (setq byte-compile-last-position
1017 (+ byte-compile-read-position
(cdr entry
))
1018 read-symbol-positions-list
1019 (byte-compile-delete-first
1020 entry read-symbol-positions-list
)))
1021 (or (and allow-previous
(not (= last byte-compile-last-position
)))
1022 (> last byte-compile-last-position
)))))))
1024 (defvar byte-compile-last-warned-form nil
)
1025 (defvar byte-compile-last-logged-file nil
)
1027 ;; This is used as warning-prefix for the compiler.
1028 ;; It is always called with the warnings buffer current.
1029 (defun byte-compile-warning-prefix (level entry
)
1030 (let* ((inhibit-read-only t
)
1031 (dir default-directory
)
1032 (file (cond ((stringp byte-compile-current-file
)
1033 (format "%s:" (file-relative-name byte-compile-current-file dir
)))
1034 ((bufferp byte-compile-current-file
)
1035 (format "Buffer %s:"
1036 (buffer-name byte-compile-current-file
)))
1038 (pos (if (and byte-compile-current-file
1039 (integerp byte-compile-read-position
))
1040 (with-current-buffer byte-compile-current-buffer
1043 (goto-char byte-compile-last-position
)
1044 (1+ (count-lines (point-min) (point-at-bol))))
1046 (goto-char byte-compile-last-position
)
1047 (1+ (current-column)))))
1049 (form (if (eq byte-compile-current-form
:end
) "end of data"
1050 (or byte-compile-current-form
"toplevel form"))))
1051 (when (or (and byte-compile-current-file
1052 (not (equal byte-compile-current-file
1053 byte-compile-last-logged-file
)))
1054 (and byte-compile-current-form
1055 (not (eq byte-compile-current-form
1056 byte-compile-last-warned-form
))))
1057 (insert (format "\nIn %s:\n" form
)))
1059 (insert (format "%s%s" file pos
))))
1060 (setq byte-compile-last-logged-file byte-compile-current-file
1061 byte-compile-last-warned-form byte-compile-current-form
)
1064 ;; This no-op function is used as the value of warning-series
1065 ;; to tell inner calls to displaying-byte-compile-warnings
1066 ;; not to bind warning-series.
1067 (defun byte-compile-warning-series (&rest _ignore
)
1070 ;; (compile-mode) will cause this to be loaded.
1071 (declare-function compilation-forget-errors
"compile" ())
1073 ;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
1074 ;; Return the position of the start of the page in the log buffer.
1075 ;; But do nothing in batch mode.
1076 (defun byte-compile-log-file ()
1077 (and (not (equal byte-compile-current-file byte-compile-last-logged-file
))
1078 (not noninteractive
)
1079 (with-current-buffer (get-buffer-create byte-compile-log-buffer
)
1080 (goto-char (point-max))
1081 (let* ((inhibit-read-only t
)
1082 (dir (and byte-compile-current-file
1083 (file-name-directory byte-compile-current-file
)))
1084 (was-same (equal default-directory dir
))
1088 (insert (format "Leaving directory `%s'\n" default-directory
))))
1091 (setq pt
(point-marker))
1092 (if byte-compile-current-file
1093 (insert "\f\nCompiling "
1094 (if (stringp byte-compile-current-file
)
1095 (concat "file " byte-compile-current-file
)
1096 (concat "buffer " (buffer-name byte-compile-current-file
)))
1097 " at " (current-time-string) "\n")
1098 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1100 (setq default-directory dir
)
1102 (insert (format "Entering directory `%s'\n" default-directory
))))
1103 (setq byte-compile-last-logged-file byte-compile-current-file
1104 byte-compile-last-warned-form nil
)
1105 ;; Do this after setting default-directory.
1106 (unless (derived-mode-p 'compilation-mode
) (compilation-mode))
1107 (compilation-forget-errors)
1110 ;; Log a message STRING in `byte-compile-log-buffer'.
1111 ;; Also log the current function and file if not already done.
1112 (defun byte-compile-log-warning (string &optional fill level
)
1113 (let ((warning-prefix-function 'byte-compile-warning-prefix
)
1114 (warning-type-format "")
1115 (warning-fill-prefix (if fill
" "))
1116 (inhibit-read-only t
))
1117 (display-warning 'bytecomp string level byte-compile-log-buffer
)))
1119 (defun byte-compile-warn (format &rest args
)
1120 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1121 (setq format
(apply 'format format args
))
1122 (if byte-compile-error-on-warn
1123 (error "%s" format
) ; byte-compile-file catches and logs it
1124 (byte-compile-log-warning format t
:warning
)))
1126 (defun byte-compile-warn-obsolete (symbol)
1127 "Warn that SYMBOL (a variable or function) is obsolete."
1128 (when (byte-compile-warning-enabled-p 'obsolete
)
1129 (let* ((funcp (get symbol
'byte-obsolete-info
))
1130 (obsolete (or funcp
(get symbol
'byte-obsolete-variable
)))
1131 (instead (car obsolete
))
1132 (asof (if funcp
(nth 2 obsolete
) (cdr obsolete
))))
1133 (unless (and funcp
(memq symbol byte-compile-not-obsolete-funcs
))
1134 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1135 (if funcp
"function" "variable")
1136 (if asof
(concat " (as of Emacs " asof
")") "")
1137 (cond ((stringp instead
)
1138 (concat "; " instead
))
1140 (format "; use `%s' instead." instead
))
1143 (defun byte-compile-report-error (error-info)
1144 "Report Lisp error in compilation. ERROR-INFO is the error data."
1145 (setq byte-compiler-error-flag t
)
1146 (byte-compile-log-warning
1147 (error-message-string error-info
)
1150 ;;; sanity-checking arglists
1152 (defun byte-compile-fdefinition (name macro-p
)
1153 ;; If a function has an entry saying (FUNCTION . t).
1154 ;; that means we know it is defined but we don't know how.
1155 ;; If a function has an entry saying (FUNCTION . nil),
1156 ;; that means treat it as not defined.
1157 (let* ((list (if macro-p
1158 byte-compile-macro-environment
1159 byte-compile-function-environment
))
1160 (env (cdr (assq name list
))))
1163 (while (and (symbolp fn
)
1165 (or (symbolp (symbol-function fn
))
1166 (consp (symbol-function fn
))
1168 (byte-code-function-p (symbol-function fn
)))))
1169 (setq fn
(symbol-function fn
)))
1170 (let ((advertised (gethash (if (and (symbolp fn
) (fboundp fn
))
1172 (symbol-function fn
)
1174 advertised-signature-table t
)))
1178 `(macro lambda
,advertised
)
1179 `(lambda ,advertised
)))
1180 ((and (not macro-p
) (byte-code-function-p fn
)) fn
)
1181 ((not (consp fn
)) nil
)
1182 ((eq 'macro
(car fn
)) (cdr fn
))
1184 ((eq 'autoload
(car fn
)) nil
)
1187 (defun byte-compile-arglist-signature (arglist)
1188 (if (integerp arglist
)
1189 ;; New style byte-code arglist.
1190 (cons (logand arglist
127) ;Mandatory.
1191 (if (zerop (logand arglist
128)) ;No &rest.
1192 (lsh arglist -
8))) ;Nonrest.
1193 ;; Old style byte-code, or interpreted function.
1198 (cond ((eq (car arglist
) '&optional
)
1199 (or opts
(setq opts
0)))
1200 ((eq (car arglist
) '&rest
)
1206 (setq opts
(1+ opts
))
1207 (setq args
(1+ args
)))))
1208 (setq arglist
(cdr arglist
)))
1209 (cons args
(if restp nil
(if opts
(+ args opts
) args
))))))
1212 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1214 (> (car new
) (car old
)) ; requires more args now
1215 (and (null (cdr old
)) ; took rest-args, doesn't any more
1217 (and (cdr new
) (cdr old
) ; can't take as many args now
1218 (< (cdr new
) (cdr old
)))
1221 (defun byte-compile-arglist-signature-string (signature)
1222 (cond ((null (cdr signature
))
1223 (format "%d+" (car signature
)))
1224 ((= (car signature
) (cdr signature
))
1225 (format "%d" (car signature
)))
1226 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1229 ;; Warn if the form is calling a function with the wrong number of arguments.
1230 (defun byte-compile-callargs-warn (form)
1231 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1232 (byte-compile-fdefinition (car form
) t
)))
1233 (sig (if (and def
(not (eq def t
)))
1235 (and (eq (car-safe def
) 'macro
)
1236 (eq (car-safe (cdr-safe def
)) 'lambda
)
1237 (setq def
(cdr def
)))
1238 (byte-compile-arglist-signature
1239 (if (memq (car-safe def
) '(declared lambda
))
1241 (if (byte-code-function-p def
)
1244 (if (and (fboundp (car form
))
1245 (subrp (symbol-function (car form
))))
1246 (subr-arity (symbol-function (car form
))))))
1247 (ncall (length (cdr form
))))
1248 ;; Check many or unevalled from subr-arity.
1249 (if (and (cdr-safe sig
)
1250 (not (numberp (cdr sig
))))
1253 (when (or (< ncall
(car sig
))
1254 (and (cdr sig
) (> ncall
(cdr sig
))))
1255 (byte-compile-set-symbol-position (car form
))
1257 "%s called with %d argument%s, but %s %s"
1259 (if (= 1 ncall
) "" "s")
1260 (if (< ncall
(car sig
))
1263 (byte-compile-arglist-signature-string sig
))))
1264 (byte-compile-format-warn form
)
1265 ;; Check to see if the function will be available at runtime
1266 ;; and/or remember its arity if it's unknown.
1267 (or (and (or def
(fboundp (car form
))) ; might be a subr or autoload.
1268 (not (memq (car form
) byte-compile-noruntime-functions
)))
1269 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1271 ;; It's a currently-undefined function.
1272 ;; Remember number of args in call.
1273 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1274 (n (length (cdr form
))))
1276 (or (memq n
(cdr cons
))
1277 (setcdr cons
(cons n
(cdr cons
))))
1278 (push (list (car form
) n
)
1279 byte-compile-unresolved-functions
))))))
1281 (defun byte-compile-format-warn (form)
1282 "Warn if FORM is `format'-like with inconsistent args.
1283 Applies if head of FORM is a symbol with non-nil property
1284 `byte-compile-format-like' and first arg is a constant string.
1285 Then check the number of format fields matches the number of
1287 (when (and (symbolp (car form
))
1288 (stringp (nth 1 form
))
1289 (get (car form
) 'byte-compile-format-like
))
1290 (let ((nfields (with-temp-buffer
1291 (insert (nth 1 form
))
1292 (goto-char (point-min))
1294 (while (re-search-forward "%." nil t
)
1295 (unless (eq ?%
(char-after (1+ (match-beginning 0))))
1298 (nargs (- (length form
) 2)))
1299 (unless (= nargs nfields
)
1301 "`%s' called with %d args to fill %d format field(s)" (car form
)
1304 (dolist (elt '(format message error
))
1305 (put elt
'byte-compile-format-like t
))
1307 ;; Warn if a custom definition fails to specify :group.
1308 (defun byte-compile-nogroup-warn (form)
1309 (if (and (memq (car form
) '(custom-declare-face custom-declare-variable
))
1310 byte-compile-current-group
)
1311 ;; The group will be provided implicitly.
1313 (let ((keyword-args (cdr (cdr (cdr (cdr form
)))))
1315 (or (not (eq (car-safe name
) 'quote
))
1316 (and (eq (car form
) 'custom-declare-group
)
1317 (equal name
''emacs
))
1318 (plist-get keyword-args
:group
)
1319 (not (and (consp name
) (eq (car name
) 'quote
)))
1321 "%s for `%s' fails to specify containing group"
1322 (cdr (assq (car form
)
1323 '((custom-declare-group . defgroup
)
1324 (custom-declare-face . defface
)
1325 (custom-declare-variable . defcustom
))))
1327 ;; Update the current group, if needed.
1328 (if (and byte-compile-current-file
;Only when byte-compiling a whole file.
1329 (eq (car form
) 'custom-declare-group
)
1330 (eq (car-safe name
) 'quote
))
1331 (setq byte-compile-current-group
(cadr name
))))))
1333 ;; Warn if the function or macro is being redefined with a different
1334 ;; number of arguments.
1335 (defun byte-compile-arglist-warn (form macrop
)
1336 (let* ((name (nth 1 form
))
1337 (old (byte-compile-fdefinition name macrop
)))
1338 (if (and old
(not (eq old t
)))
1340 (and (eq 'macro
(car-safe old
))
1341 (eq 'lambda
(car-safe (cdr-safe old
)))
1342 (setq old
(cdr old
)))
1343 (let ((sig1 (byte-compile-arglist-signature
1345 (`(lambda ,args .
,_
) args
)
1346 (`(closure ,_
,_
,args .
,_
) args
)
1347 ((pred byte-code-function-p
) (aref old
0))
1349 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1350 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1351 (byte-compile-set-symbol-position name
)
1353 "%s %s used to take %s %s, now takes %s"
1354 (if (eq (car form
) 'defun
) "function" "macro")
1356 (byte-compile-arglist-signature-string sig1
)
1357 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1358 (byte-compile-arglist-signature-string sig2
)))))
1359 ;; This is the first definition. See if previous calls are compatible.
1360 (let ((calls (assq name byte-compile-unresolved-functions
))
1363 (when (and (symbolp name
)
1364 (eq (get name
'byte-optimizer
)
1365 'byte-compile-inline-expand
))
1366 (byte-compile-warn "defsubst `%s' was used before it was defined"
1368 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1369 nums
(sort (copy-sequence (cdr calls
)) (function <))
1371 max
(car (nreverse nums
)))
1372 (when (or (< min
(car sig
))
1373 (and (cdr sig
) (> max
(cdr sig
))))
1374 (byte-compile-set-symbol-position name
)
1376 "%s being defined to take %s%s, but was previously called with %s"
1378 (byte-compile-arglist-signature-string sig
)
1379 (if (equal sig
'(1 .
1)) " arg" " args")
1380 (byte-compile-arglist-signature-string (cons min max
))))
1382 (setq byte-compile-unresolved-functions
1383 (delq calls byte-compile-unresolved-functions
)))))))
1385 (defvar byte-compile-cl-functions nil
1386 "List of functions defined in CL.")
1388 ;; Can't just add this to cl-load-hook, because that runs just before
1389 ;; the forms from cl.el get added to load-history.
1390 (defun byte-compile-find-cl-functions ()
1391 (unless byte-compile-cl-functions
1392 (dolist (elt load-history
)
1393 (and (byte-compile-cl-file-p (car elt
))
1394 (dolist (e (cdr elt
))
1395 ;; Includes the cl-foo functions that cl autoloads.
1396 (when (memq (car-safe e
) '(autoload defun
))
1397 (push (cdr e
) byte-compile-cl-functions
)))))))
1399 (defun byte-compile-cl-warn (form)
1400 "Warn if FORM is a call of a function from the CL package."
1401 (let ((func (car-safe form
)))
1402 (if (and byte-compile-cl-functions
1403 (memq func byte-compile-cl-functions
)
1404 ;; Aliases which won't have been expanded at this point.
1405 ;; These aren't all aliases of subrs, so not trivial to
1406 ;; avoid hardwiring the list.
1408 '(cl-block-wrapper cl-block-throw
1409 multiple-value-call nth-value
1410 copy-seq first second rest endp cl-member
1411 ;; These are included in generated code
1412 ;; that can't be called except at compile time
1413 ;; or unless cl is loaded anyway.
1414 cl-defsubst-expand cl-struct-setf-expander
1415 ;; These would sometimes be warned about
1416 ;; but such warnings are never useful,
1417 ;; so don't warn about them.
1418 macroexpand cl-macroexpand-all
1419 cl-compiling-file
))))
1420 (byte-compile-warn "function `%s' from cl package called at runtime"
1424 (defun byte-compile-print-syms (str1 strn syms
)
1426 (byte-compile-set-symbol-position (car syms
) t
))
1427 (cond ((and (cdr syms
) (not noninteractive
))
1432 (setq s
(symbol-name (pop syms
))
1433 L
(+ L
(length s
) 2))
1434 (if (< L
(1- fill-column
))
1435 (setq str
(concat str
" " s
(and syms
",")))
1436 (setq str
(concat str
"\n " s
(and syms
","))
1437 L
(+ (length s
) 4))))
1438 (byte-compile-warn "%s" str
)))
1440 (byte-compile-warn "%s %s"
1442 (mapconcat #'symbol-name syms
", ")))
1445 (byte-compile-warn str1
(car syms
)))))
1447 ;; If we have compiled any calls to functions which are not known to be
1448 ;; defined, issue a warning enumerating them.
1449 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1450 (defun byte-compile-warn-about-unresolved-functions ()
1451 (when (byte-compile-warning-enabled-p 'unresolved
)
1452 (let ((byte-compile-current-form :end
)
1455 ;; Separate the functions that will not be available at runtime
1456 ;; from the truly unresolved ones.
1457 (dolist (f byte-compile-unresolved-functions
)
1459 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1460 ;; Complain about the no-run-time functions
1461 (byte-compile-print-syms
1462 "the function `%s' might not be defined at runtime."
1463 "the following functions might not be defined at runtime:"
1465 ;; Complain about the unresolved functions
1466 (byte-compile-print-syms
1467 "the function `%s' is not known to be defined."
1468 "the following functions are not known to be defined:"
1473 (defsubst byte-compile-const-symbol-p
(symbol &optional any-value
)
1474 "Non-nil if SYMBOL is constant.
1475 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1477 (or (memq symbol
'(nil t
))
1480 (or (memq symbol byte-compile-const-variables
)
1481 ;; FIXME: We should provide a less intrusive way to find out
1482 ;; if a variable is "constant".
1483 (and (boundp symbol
)
1485 (progn (set symbol
(symbol-value symbol
)) nil
)
1486 (setting-constant t
)))))))
1488 (defmacro byte-compile-constp
(form)
1489 "Return non-nil if FORM is a constant."
1490 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1491 ((not (symbolp ,form
)))
1492 ((byte-compile-const-symbol-p ,form
))))
1494 (defmacro byte-compile-close-variables
(&rest body
)
1498 ;; Close over these variables to encapsulate the
1499 ;; compilation state
1501 (byte-compile-macro-environment
1502 ;; Copy it because the compiler may patch into the
1503 ;; macroenvironment.
1504 (copy-alist byte-compile-initial-macro-environment
))
1505 (byte-compile-function-environment nil
)
1506 (byte-compile-bound-variables nil
)
1507 (byte-compile-const-variables nil
)
1508 (byte-compile-free-references nil
)
1509 (byte-compile-free-assignments nil
)
1511 ;; Close over these variables so that `byte-compiler-options'
1512 ;; can change them on a per-file basis.
1514 (byte-compile-verbose byte-compile-verbose
)
1515 (byte-optimize byte-optimize
)
1516 (byte-compile-dynamic byte-compile-dynamic
)
1517 (byte-compile-dynamic-docstrings
1518 byte-compile-dynamic-docstrings
)
1519 ;; (byte-compile-generate-emacs19-bytecodes
1520 ;; byte-compile-generate-emacs19-bytecodes)
1521 (byte-compile-warnings byte-compile-warnings
)
1525 (defmacro displaying-byte-compile-warnings
(&rest body
)
1527 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body
))
1528 (warning-series-started
1529 (and (markerp warning-series
)
1530 (eq (marker-buffer warning-series
)
1531 (get-buffer byte-compile-log-buffer
)))))
1532 (byte-compile-find-cl-functions)
1533 (if (or (eq warning-series
'byte-compile-warning-series
)
1534 warning-series-started
)
1535 ;; warning-series does come from compilation,
1536 ;; so don't bind it, but maybe do set it.
1538 ;; Log the file name. Record position of that text.
1539 (setq tem
(byte-compile-log-file))
1540 (unless warning-series-started
1541 (setq warning-series
(or tem
'byte-compile-warning-series
)))
1542 (if byte-compile-debug
1543 (funcall --displaying-byte-compile-warnings-fn
)
1544 (condition-case error-info
1545 (funcall --displaying-byte-compile-warnings-fn
)
1546 (error (byte-compile-report-error error-info
)))))
1547 ;; warning-series does not come from compilation, so bind it.
1548 (let ((warning-series
1549 ;; Log the file name. Record position of that text.
1550 (or (byte-compile-log-file) 'byte-compile-warning-series
)))
1551 (if byte-compile-debug
1552 (funcall --displaying-byte-compile-warnings-fn
)
1553 (condition-case error-info
1554 (funcall --displaying-byte-compile-warnings-fn
)
1555 (error (byte-compile-report-error error-info
))))))))
1558 (defun byte-force-recompile (directory)
1559 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1560 Files in subdirectories of DIRECTORY are processed also."
1561 (interactive "DByte force recompile (directory): ")
1562 (byte-recompile-directory directory nil t
))
1564 ;; The `bytecomp-' prefix is applied to all local variables with
1565 ;; otherwise common names in this and similar functions for the sake
1566 ;; of the boundp test in byte-compile-variable-ref.
1567 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg00237.html
1568 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00134.html
1569 ;; Note that similar considerations apply to command-line-1 in startup.el.
1571 (defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
1573 "Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
1574 This happens when a `.elc' file exists but is older than the `.el' file.
1575 Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
1577 If the `.elc' file does not exist, normally this function *does not*
1578 compile the corresponding `.el' file. However, if the prefix argument
1579 BYTECOMP-ARG is 0, that means do compile all those files. A nonzero
1580 BYTECOMP-ARG means ask the user, for each such `.el' file, whether to
1581 compile it. A nonzero BYTECOMP-ARG also means ask about each subdirectory
1584 If the third argument BYTECOMP-FORCE is non-nil, recompile every `.el' file
1585 that already has a `.elc' file."
1586 (interactive "DByte recompile directory: \nP")
1588 (setq bytecomp-arg
(prefix-numeric-value bytecomp-arg
)))
1592 (force-mode-line-update))
1593 (with-current-buffer (get-buffer-create byte-compile-log-buffer
)
1594 (setq default-directory
(expand-file-name bytecomp-directory
))
1595 ;; compilation-mode copies value of default-directory.
1596 (unless (eq major-mode
'compilation-mode
)
1598 (let ((bytecomp-directories (list default-directory
))
1599 (default-directory default-directory
)
1605 (displaying-byte-compile-warnings
1606 (while bytecomp-directories
1607 (setq bytecomp-directory
(car bytecomp-directories
))
1608 (message "Checking %s..." bytecomp-directory
)
1609 (let ((bytecomp-files (directory-files bytecomp-directory
))
1611 (dolist (bytecomp-file bytecomp-files
)
1612 (setq bytecomp-source
1613 (expand-file-name bytecomp-file bytecomp-directory
))
1614 (if (and (not (member bytecomp-file
'("RCS" "CVS")))
1615 (not (eq ?\.
(aref bytecomp-file
0)))
1616 (file-directory-p bytecomp-source
)
1617 (not (file-symlink-p bytecomp-source
)))
1618 ;; This file is a subdirectory. Handle them differently.
1619 (when (or (null bytecomp-arg
)
1621 (y-or-n-p (concat "Check " bytecomp-source
"? ")))
1622 (setq bytecomp-directories
1623 (nconc bytecomp-directories
(list bytecomp-source
))))
1624 ;; It is an ordinary file. Decide whether to compile it.
1625 (if (and (string-match emacs-lisp-file-regexp bytecomp-source
)
1626 (file-readable-p bytecomp-source
)
1627 (not (auto-save-file-name-p bytecomp-source
))
1628 (not (string-equal dir-locals-file
1629 (file-name-nondirectory
1631 (progn (let ((bytecomp-res (byte-recompile-file
1633 bytecomp-force bytecomp-arg
)))
1634 (cond ((eq bytecomp-res
'no-byte-compile
)
1635 (setq skip-count
(1+ skip-count
)))
1636 ((eq bytecomp-res t
)
1637 (setq file-count
(1+ file-count
)))
1638 ((eq bytecomp-res nil
)
1639 (setq fail-count
(1+ fail-count
)))))
1641 (message "Checking %s..." bytecomp-directory
))
1642 (if (not (eq last-dir bytecomp-directory
))
1643 (setq last-dir bytecomp-directory
1644 dir-count
(1+ dir-count
)))
1646 (setq bytecomp-directories
(cdr bytecomp-directories
))))
1647 (message "Done (Total of %d file%s compiled%s%s%s)"
1648 file-count
(if (= file-count
1) "" "s")
1649 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1650 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1652 (format " in %d directories" dir-count
) "")))))
1654 (defvar no-byte-compile nil
1655 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1656 This is normally set in local file variables at the end of the elisp file:
1658 \;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
1659 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1661 (defun byte-recompile-file (bytecomp-filename &optional bytecomp-force bytecomp-arg load
)
1662 "Recompile BYTECOMP-FILENAME file if it needs recompilation.
1663 This happens when its `.elc' file is older than itself.
1665 If the `.elc' file exists and is up-to-date, normally this
1666 function *does not* compile BYTECOMP-FILENAME. However, if the
1667 prefix argument BYTECOMP-FORCE is set, that means do compile
1668 BYTECOMP-FILENAME even if the destination already exists and is
1671 If the `.elc' file does not exist, normally this function *does
1672 not* compile BYTECOMP-FILENAME. If BYTECOMP-ARG is 0, that means
1673 compile the file even if it has never been compiled before.
1674 A nonzero BYTECOMP-ARG means ask the user.
1676 If LOAD is set, `load' the file after compiling.
1678 The value returned is the value returned by `byte-compile-file',
1679 or 'no-byte-compile if the file did not need recompilation."
1681 (let ((bytecomp-file buffer-file-name
)
1682 (bytecomp-file-name nil
)
1683 (bytecomp-file-dir nil
))
1685 (eq (cdr (assq 'major-mode
(buffer-local-variables)))
1687 (setq bytecomp-file-name
(file-name-nondirectory bytecomp-file
)
1688 bytecomp-file-dir
(file-name-directory bytecomp-file
)))
1689 (list (read-file-name (if current-prefix-arg
1690 "Byte compile file: "
1691 "Byte recompile file: ")
1692 bytecomp-file-dir bytecomp-file-name nil
)
1693 current-prefix-arg
)))
1694 (let ((bytecomp-dest
1695 (byte-compile-dest-file bytecomp-filename
))
1696 ;; Expand now so we get the current buffer's defaults
1697 (bytecomp-filename (expand-file-name bytecomp-filename
)))
1698 (if (if (file-exists-p bytecomp-dest
)
1699 ;; File was already compiled
1700 ;; Compile if forced to, or filename newer
1702 (file-newer-than-file-p bytecomp-filename
1705 (or (eq 0 bytecomp-arg
)
1706 (y-or-n-p (concat "Compile "
1707 bytecomp-filename
"? ")))))
1709 (if (and noninteractive
(not byte-compile-verbose
))
1710 (message "Compiling %s..." bytecomp-filename
))
1711 (byte-compile-file bytecomp-filename load
))
1712 (when load
(load bytecomp-filename
))
1716 (defun byte-compile-file (bytecomp-filename &optional load
)
1717 "Compile a file of Lisp code named BYTECOMP-FILENAME into a file of byte code.
1718 The output file's name is generated by passing BYTECOMP-FILENAME to the
1719 function `byte-compile-dest-file' (which see).
1720 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1721 The value is non-nil if there were no errors, nil if errors."
1722 ;; (interactive "fByte compile file: \nP")
1724 (let ((bytecomp-file buffer-file-name
)
1725 (bytecomp-file-name nil
)
1726 (bytecomp-file-dir nil
))
1728 (derived-mode-p 'emacs-lisp-mode
)
1729 (setq bytecomp-file-name
(file-name-nondirectory bytecomp-file
)
1730 bytecomp-file-dir
(file-name-directory bytecomp-file
)))
1731 (list (read-file-name (if current-prefix-arg
1732 "Byte compile and load file: "
1733 "Byte compile file: ")
1734 bytecomp-file-dir bytecomp-file-name nil
)
1735 current-prefix-arg
)))
1736 ;; Expand now so we get the current buffer's defaults
1737 (setq bytecomp-filename
(expand-file-name bytecomp-filename
))
1739 ;; If we're compiling a file that's in a buffer and is modified, offer
1740 ;; to save it first.
1742 (let ((b (get-file-buffer (expand-file-name bytecomp-filename
))))
1743 (if (and b
(buffer-modified-p b
)
1744 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1745 (with-current-buffer b
(save-buffer)))))
1747 ;; Force logging of the file name for each file compiled.
1748 (setq byte-compile-last-logged-file nil
)
1749 (let ((byte-compile-current-file bytecomp-filename
)
1750 (byte-compile-current-group nil
)
1751 (set-auto-coding-for-load t
)
1752 target-file input-buffer output-buffer
1753 byte-compile-dest-file
)
1754 (setq target-file
(byte-compile-dest-file bytecomp-filename
))
1755 (setq byte-compile-dest-file target-file
)
1756 (with-current-buffer
1757 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1759 (setq buffer-file-coding-system nil
)
1760 ;; Always compile an Emacs Lisp file as multibyte
1761 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1762 (set-buffer-multibyte t
)
1763 (insert-file-contents bytecomp-filename
)
1764 ;; Mimic the way after-insert-file-set-coding can make the
1765 ;; buffer unibyte when visiting this file.
1766 (when (or (eq last-coding-system-used
'no-conversion
)
1767 (eq (coding-system-type last-coding-system-used
) 5))
1768 ;; For coding systems no-conversion and raw-text...,
1769 ;; edit the buffer as unibyte.
1770 (set-buffer-multibyte nil
))
1771 ;; Run hooks including the uncompression hook.
1772 ;; If they change the file name, then change it for the output also.
1773 (letf ((buffer-file-name bytecomp-filename
)
1774 ((default-value 'major-mode
) 'emacs-lisp-mode
)
1775 ;; Ignore unsafe local variables.
1776 ;; We only care about a few of them for our purposes.
1777 (enable-local-variables :safe
)
1778 (enable-local-eval nil
))
1779 ;; Arg of t means don't alter enable-local-variables.
1781 (setq bytecomp-filename buffer-file-name
))
1782 ;; Set the default directory, in case an eval-when-compile uses it.
1783 (setq default-directory
(file-name-directory bytecomp-filename
)))
1784 ;; Check if the file's local variables explicitly specify not to
1785 ;; compile this file.
1786 (if (with-current-buffer input-buffer no-byte-compile
)
1788 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1789 ;; (file-relative-name bytecomp-filename)
1790 ;; (with-current-buffer input-buffer no-byte-compile))
1791 (when (file-exists-p target-file
)
1792 (message "%s deleted because of `no-byte-compile: %s'"
1793 (file-relative-name target-file
)
1794 (buffer-local-value 'no-byte-compile input-buffer
))
1795 (condition-case nil
(delete-file target-file
) (error nil
)))
1796 ;; We successfully didn't compile this file.
1798 (when byte-compile-verbose
1799 (message "Compiling %s..." bytecomp-filename
))
1800 (setq byte-compiler-error-flag nil
)
1801 ;; It is important that input-buffer not be current at this call,
1802 ;; so that the value of point set in input-buffer
1803 ;; within byte-compile-from-buffer lingers in that buffer.
1805 (save-current-buffer
1806 (byte-compile-from-buffer input-buffer
)))
1807 (if byte-compiler-error-flag
1809 (when byte-compile-verbose
1810 (message "Compiling %s...done" bytecomp-filename
))
1811 (kill-buffer input-buffer
)
1812 (with-current-buffer output-buffer
1813 (goto-char (point-max))
1814 (insert "\n") ; aaah, unix.
1815 (if (file-writable-p target-file
)
1816 ;; We must disable any code conversion here.
1817 (let* ((coding-system-for-write 'no-conversion
)
1818 ;; Write to a tempfile so that if another Emacs
1819 ;; process is trying to load target-file (eg in a
1820 ;; parallel bootstrap), it does not risk getting a
1821 ;; half-finished file. (Bug#4196)
1822 (tempfile (make-temp-name target-file
))
1824 (cons (lambda () (ignore-errors (delete-file tempfile
)))
1826 (if (memq system-type
'(ms-dos 'windows-nt
))
1827 (setq buffer-file-type t
))
1828 (write-region (point-min) (point-max) tempfile nil
1)
1829 ;; This has the intentional side effect that any
1830 ;; hard-links to target-file continue to
1831 ;; point to the old file (this makes it possible
1832 ;; for installed files to share disk space with
1833 ;; the build tree, without causing problems when
1834 ;; emacs-lisp files in the build tree are
1835 ;; recompiled). Previously this was accomplished by
1836 ;; deleting target-file before writing it.
1837 (rename-file tempfile target-file t
)
1838 (message "Wrote %s" target-file
))
1839 ;; This is just to give a better error message than write-region
1841 (list "Opening output file"
1842 (if (file-exists-p target-file
)
1843 "cannot overwrite file"
1844 "directory not writable or nonexistent")
1846 (kill-buffer (current-buffer)))
1847 (if (and byte-compile-generate-call-tree
1848 (or (eq t byte-compile-generate-call-tree
)
1849 (y-or-n-p (format "Report call tree for %s? "
1850 bytecomp-filename
))))
1852 (display-call-tree bytecomp-filename
)))
1857 ;;; compiling a single function
1859 (defun compile-defun (&optional arg
)
1860 "Compile and evaluate the current top-level form.
1861 Print the result in the echo area.
1862 With argument ARG, insert value in current buffer after the form."
1866 (beginning-of-defun)
1867 (let* ((byte-compile-current-file nil
)
1868 (byte-compile-current-buffer (current-buffer))
1869 (byte-compile-read-position (point))
1870 (byte-compile-last-position byte-compile-read-position
)
1871 (byte-compile-last-warned-form 'nothing
)
1873 (let ((read-with-symbol-positions (current-buffer))
1874 (read-symbol-positions-list nil
))
1875 (displaying-byte-compile-warnings
1876 (byte-compile-sexp (read (current-buffer))))))))
1878 (message "Compiling from buffer... done.")
1879 (prin1 value
(current-buffer))
1881 ((message "%s" (prin1-to-string value
)))))))
1883 ;; Dynamically bound in byte-compile-from-buffer.
1884 ;; NB also used in cl.el and cl-macs.el.
1885 (defvar bytecomp-outbuffer
)
1887 (defun byte-compile-from-buffer (bytecomp-inbuffer)
1888 (let (bytecomp-outbuffer
1889 (byte-compile-current-buffer bytecomp-inbuffer
)
1890 (byte-compile-read-position nil
)
1891 (byte-compile-last-position nil
)
1892 ;; Prevent truncation of flonums and lists as we read and print them
1893 (float-output-format nil
)
1894 (case-fold-search nil
)
1897 ;; Prevent edebug from interfering when we compile
1898 ;; and put the output into a file.
1899 ;; (edebug-all-defs nil)
1900 ;; (edebug-all-forms nil)
1901 ;; Simulate entry to byte-compile-top-level
1902 (byte-compile-constants nil
)
1903 (byte-compile-variables nil
)
1904 (byte-compile-tag-number 0)
1905 (byte-compile-depth 0)
1906 (byte-compile-maxdepth 0)
1907 (byte-compile-output nil
)
1908 ;; This allows us to get the positions of symbols read; it's
1909 ;; new in Emacs 22.1.
1910 (read-with-symbol-positions bytecomp-inbuffer
)
1911 (read-symbol-positions-list nil
)
1912 ;; #### This is bound in b-c-close-variables.
1913 ;; (byte-compile-warnings byte-compile-warnings)
1915 (byte-compile-close-variables
1916 (with-current-buffer
1917 (setq bytecomp-outbuffer
(get-buffer-create " *Compiler Output*"))
1918 (set-buffer-multibyte t
)
1920 ;; (emacs-lisp-mode)
1921 (setq case-fold-search nil
))
1922 (displaying-byte-compile-warnings
1923 (with-current-buffer bytecomp-inbuffer
1924 (and byte-compile-current-file
1925 (byte-compile-insert-header byte-compile-current-file
1926 bytecomp-outbuffer
))
1927 (goto-char (point-min))
1928 ;; Should we always do this? When calling multiple files, it
1929 ;; would be useful to delay this warning until all have been
1930 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1931 ;; previous byte-compile.
1932 (setq byte-compile-unresolved-functions nil
)
1934 ;; Compile the forms from the input buffer.
1936 (while (progn (skip-chars-forward " \t\n\^l")
1940 (setq byte-compile-read-position
(point)
1941 byte-compile-last-position byte-compile-read-position
)
1942 (let* ((old-style-backquotes nil
)
1943 (form (read bytecomp-inbuffer
)))
1944 ;; Warn about the use of old-style backquotes.
1945 (when old-style-backquotes
1946 (byte-compile-warn "!! The file uses old-style backquotes !!
1947 This functionality has been obsolete for more than 10 years already
1948 and will be removed soon. See (elisp)Backquote in the manual."))
1949 (byte-compile-toplevel-file-form form
)))
1950 ;; Compile pending forms at end of file.
1951 (byte-compile-flush-pending)
1952 ;; Make warnings about unresolved functions
1953 ;; give the end of the file as their position.
1954 (setq byte-compile-last-position
(point-max))
1955 (byte-compile-warn-about-unresolved-functions))
1956 ;; Fix up the header at the front of the output
1957 ;; if the buffer contains multibyte characters.
1958 (and byte-compile-current-file
1959 (with-current-buffer bytecomp-outbuffer
1960 (byte-compile-fix-header byte-compile-current-file
)))))
1961 bytecomp-outbuffer
))
1963 (defun byte-compile-fix-header (filename)
1964 "If the current buffer has any multibyte characters, insert a version test."
1965 (when (< (point-max) (position-bytes (point-max)))
1966 (goto-char (point-min))
1967 ;; Find the comment that describes the version condition.
1968 (search-forward "\n;;; This file uses")
1969 (narrow-to-region (line-beginning-position) (point-max))
1970 ;; Find the first line of ballast semicolons.
1971 (search-forward ";;;;;;;;;;")
1973 (narrow-to-region (point-min) (point))
1974 (let ((old-header-end (point))
1975 (minimum-version "23")
1977 (delete-region (point-min) (point-max))
1979 ";;; This file contains utf-8 non-ASCII characters,\n"
1980 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1981 ;; Have to check if emacs-version is bound so that this works
1982 ;; in files loaded early in loadup.el.
1983 "(and (boundp 'emacs-version)\n"
1984 ;; If there is a name at the end of emacs-version,
1985 ;; don't try to check the version number.
1986 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1987 (format " (string-lessp emacs-version \"%s\")\n" minimum-version
)
1989 ;; prin1-to-string is used to quote backslashes.
1990 (substring (prin1-to-string (file-name-nondirectory filename
))
1992 (format "' was compiled for Emacs %s or later\"))\n\n"
1994 ;; Now compensate for any change in size, to make sure all
1995 ;; positions in the file remain valid.
1996 (setq delta
(- (point-max) old-header-end
))
1997 (goto-char (point-max))
1999 (delete-char delta
))))
2001 (defun byte-compile-insert-header (filename outbuffer
)
2002 "Insert a header at the start of OUTBUFFER.
2003 Call from the source buffer."
2004 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
2005 (dynamic byte-compile-dynamic
)
2006 (optimize byte-optimize
))
2007 (with-current-buffer outbuffer
2008 (goto-char (point-min))
2009 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
2010 ;; that is the file-format version number (18, 19, 20, or 23) as a
2011 ;; byte, followed by some nulls. The primary motivation for doing
2012 ;; this is to get some binary characters up in the first line of
2013 ;; the file so that `diff' will simply say "Binary files differ"
2014 ;; instead of actually doing a diff of two .elc files. An extra
2015 ;; benefit is that you can add this to /etc/magic:
2016 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
2017 ;; >4 byte x version %d
2019 ";ELC" 23 "\000\000\000\n"
2021 (or (and (boundp 'user-mail-address
) user-mail-address
)
2022 (concat (user-login-name) "@" (system-name)))
2023 " on " (current-time-string) "\n"
2024 ";;; from file " filename
"\n"
2025 ";;; in Emacs version " emacs-version
"\n"
2028 ((eq optimize
'source
) " source-level optimization only")
2029 ((eq optimize
'byte
) " byte-level optimization only")
2030 (optimize " all optimizations")
2031 (t "out optimization"))
2033 (if dynamic
";;; Function definitions are lazy-loaded.\n"
2035 "\n;;; This file uses "
2036 (if dynamic-docstrings
2037 "dynamic docstrings, first added in Emacs 19.29"
2038 "opcodes that do not exist in Emacs 18")
2040 ;; Note that byte-compile-fix-header may change this.
2041 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2042 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2043 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2044 ;; can delete them so as to keep the buffer positions
2045 ;; constant for the actual compiled code.
2046 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2047 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
2049 (defun byte-compile-output-file-form (form)
2050 ;; writes the given form to the output buffer, being careful of docstrings
2051 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
2052 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2053 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2054 ;; it does not pay to first build the defalias in defmumble and then parse
2056 (if (and (memq (car-safe form
) '(defun defmacro defvar defvaralias defconst
2057 autoload custom-declare-variable
))
2058 (stringp (nth 3 form
)))
2059 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
2061 '(defvaralias autoload
2062 custom-declare-variable
)))
2063 (let ((print-escape-newlines t
)
2068 (print-circle ; handle circular data structures
2069 (not byte-compile-disable-print-circle
)))
2070 (princ "\n" bytecomp-outbuffer
)
2071 (prin1 form bytecomp-outbuffer
)
2074 (defvar print-gensym-alist
) ;Used before print-circle existed.
2077 (defun byte-compile-output-docform (preface name info form specindex quoted
)
2078 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2079 If PREFACE and NAME are non-nil, print them too,
2080 before INFO and the FORM but after the doc string itself.
2081 If SPECINDEX is non-nil, it is the index in FORM
2082 of the function bytecode string. In that case,
2083 we output that argument and the following argument
2084 \(the constants vector) together, for lazy loading.
2085 QUOTED says that we have to put a quote before the
2086 list that represents a doc string reference.
2087 `defvaralias', `autoload' and `custom-declare-variable' need that."
2088 ;; We need to examine byte-compile-dynamic-docstrings
2089 ;; in the input buffer (now current), not in the output buffer.
2090 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
2091 (with-current-buffer bytecomp-outbuffer
2094 ;; Insert the doc string, and make it a comment with #@LENGTH.
2095 (and (>= (nth 1 info
) 0)
2098 ;; Make the doc string start at beginning of line
2099 ;; for make-docfile's sake.
2102 (byte-compile-output-as-comment
2103 (nth (nth 1 info
) form
) nil
))
2104 (setq position
(- (position-bytes position
) (point-min) -
1))
2105 ;; If the doc string starts with * (a user variable),
2107 (if (and (stringp (nth (nth 1 info
) form
))
2108 (> (length (nth (nth 1 info
) form
)) 0)
2109 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
2110 (setq position
(- position
)))))
2115 (prin1 name bytecomp-outbuffer
)))
2117 (let ((print-escape-newlines t
)
2119 ;; For compatibility with code before print-circle,
2120 ;; use a cons cell to say that we want
2121 ;; print-gensym-alist not to be cleared
2122 ;; between calls to print functions.
2124 (print-circle ; handle circular data structures
2125 (not byte-compile-disable-print-circle
))
2126 print-gensym-alist
; was used before print-circle existed.
2127 (print-continuous-numbering t
)
2130 (prin1 (car form
) bytecomp-outbuffer
)
2131 (while (setq form
(cdr form
))
2132 (setq index
(1+ index
))
2134 (cond ((and (numberp specindex
) (= index specindex
)
2135 ;; Don't handle the definition dynamically
2136 ;; if it refers (or might refer)
2137 ;; to objects already output
2138 ;; (for instance, gensyms in the arg list).
2140 (when (hash-table-p print-number-table
)
2141 (maphash (lambda (_k v
) (if v
(setq non-nil t
)))
2142 print-number-table
))
2144 ;; Output the byte code and constants specially
2145 ;; for lazy dynamic loading.
2147 (byte-compile-output-as-comment
2148 (cons (car form
) (nth 1 form
))
2150 (setq position
(- (position-bytes position
) (point-min) -
1))
2151 (princ (format "(#$ . %d) nil" position
) bytecomp-outbuffer
)
2152 (setq form
(cdr form
))
2153 (setq index
(1+ index
))))
2154 ((= index
(nth 1 info
))
2156 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
2159 (let ((print-escape-newlines nil
))
2160 (goto-char (prog1 (1+ (point))
2161 (prin1 (car form
) bytecomp-outbuffer
)))
2163 (goto-char (point-max)))))
2165 (prin1 (car form
) bytecomp-outbuffer
)))))
2166 (insert (nth 2 info
)))))
2169 (defun byte-compile-keep-pending (form &optional bytecomp-handler
)
2170 (if (memq byte-optimize
'(t source
))
2171 (setq form
(byte-optimize-form form t
)))
2172 (if bytecomp-handler
2173 (let ((for-effect t
))
2174 ;; To avoid consing up monstrously large forms at load time, we split
2175 ;; the output regularly.
2176 (and (memq (car-safe form
) '(fset defalias
))
2177 (nthcdr 300 byte-compile-output
)
2178 (byte-compile-flush-pending))
2179 (funcall bytecomp-handler form
)
2181 (byte-compile-discard)))
2182 (byte-compile-form form t
))
2185 (defun byte-compile-flush-pending ()
2186 (if byte-compile-output
2187 (let ((form (byte-compile-out-toplevel t
'file
)))
2188 (cond ((eq (car-safe form
) 'progn
)
2189 (mapc 'byte-compile-output-file-form
(cdr form
)))
2191 (byte-compile-output-file-form form
)))
2192 (setq byte-compile-constants nil
2193 byte-compile-variables nil
2194 byte-compile-depth
0
2195 byte-compile-maxdepth
0
2196 byte-compile-output nil
))))
2198 ;; byte-hunk-handlers cannot call this!
2199 (defun byte-compile-toplevel-file-form (form)
2200 (let ((byte-compile-current-form nil
)) ; close over this for warnings.
2201 (setq form
(macroexpand-all form byte-compile-macro-environment
))
2203 (setq form
(cconv-closure-convert form
)))
2204 (byte-compile-file-form form
)))
2206 ;; byte-hunk-handlers can call this.
2207 (defun byte-compile-file-form (form)
2208 (let (bytecomp-handler)
2209 (cond ((and (consp form
)
2210 (symbolp (car form
))
2211 (setq bytecomp-handler
(get (car form
) 'byte-hunk-handler
)))
2212 (cond ((setq form
(funcall bytecomp-handler form
))
2213 (byte-compile-flush-pending)
2214 (byte-compile-output-file-form form
))))
2216 (byte-compile-keep-pending form
)))))
2218 ;; Functions and variables with doc strings must be output separately,
2219 ;; so make-docfile can recognise them. Most other things can be output
2222 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
2223 (defun byte-compile-file-form-autoload (form)
2224 (and (let ((form form
))
2225 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
2226 (null form
)) ;Constants only
2227 (eval (nth 5 form
)) ;Macro
2228 (eval form
)) ;Define the autoload.
2229 ;; Avoid undefined function warnings for the autoload.
2230 (when (and (consp (nth 1 form
))
2231 (eq (car (nth 1 form
)) 'quote
)
2232 (consp (cdr (nth 1 form
)))
2233 (symbolp (nth 1 (nth 1 form
))))
2234 (push (cons (nth 1 (nth 1 form
))
2235 (cons 'autoload
(cdr (cdr form
))))
2236 byte-compile-function-environment
)
2237 ;; If an autoload occurs _before_ the first call to a function,
2238 ;; byte-compile-callargs-warn does not add an entry to
2239 ;; byte-compile-unresolved-functions. Here we mimic the logic
2240 ;; of byte-compile-callargs-warn so as not to warn if the
2241 ;; autoload comes _after_ the function call.
2242 ;; Alternatively, similar logic could go in
2243 ;; byte-compile-warn-about-unresolved-functions.
2244 (or (memq (nth 1 (nth 1 form
)) byte-compile-noruntime-functions
)
2245 (setq byte-compile-unresolved-functions
2246 (delq (assq (nth 1 (nth 1 form
))
2247 byte-compile-unresolved-functions
)
2248 byte-compile-unresolved-functions
))))
2249 (if (stringp (nth 3 form
))
2251 ;; No doc string, so we can compile this as a normal form.
2252 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
2254 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2255 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2256 (defun byte-compile-file-form-defvar (form)
2257 (if (null (nth 3 form
))
2258 ;; Since there is no doc string, we can compile this as a normal form,
2259 ;; and not do a file-boundary.
2260 (byte-compile-keep-pending form
)
2261 (when (and (symbolp (nth 1 form
))
2262 (not (string-match "[-*/:$]" (symbol-name (nth 1 form
))))
2263 (byte-compile-warning-enabled-p 'lexical
))
2264 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
2266 (push (nth 1 form
) byte-compile-bound-variables
)
2267 (if (eq (car form
) 'defconst
)
2268 (push (nth 1 form
) byte-compile-const-variables
))
2269 (cond ((consp (nth 2 form
))
2270 (setq form
(copy-sequence form
))
2271 (setcar (cdr (cdr form
))
2272 (byte-compile-top-level (nth 2 form
) nil
'file
))))
2275 (put 'define-abbrev-table
'byte-hunk-handler
'byte-compile-file-form-define-abbrev-table
)
2276 (defun byte-compile-file-form-define-abbrev-table (form)
2277 (if (eq 'quote
(car-safe (car-safe (cdr form
))))
2278 (push (car-safe (cdr (cadr form
))) byte-compile-bound-variables
))
2279 (byte-compile-keep-pending form
))
2281 (put 'custom-declare-variable
'byte-hunk-handler
2282 'byte-compile-file-form-custom-declare-variable
)
2283 (defun byte-compile-file-form-custom-declare-variable (form)
2284 (when (byte-compile-warning-enabled-p 'callargs
)
2285 (byte-compile-nogroup-warn form
))
2286 (push (nth 1 (nth 1 form
)) byte-compile-bound-variables
)
2287 ;; Don't compile the expression because it may be displayed to the user.
2288 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2289 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2290 ;; ;; final value already, we can byte-compile it.
2291 ;; (setcar (cdr (nth 2 form))
2292 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2293 (let ((tail (nthcdr 4 form
)))
2295 (unless (keywordp (car tail
)) ;No point optimizing keywords.
2296 ;; Compile the keyword arguments.
2297 (setcar tail
(byte-compile-top-level (car tail
) nil
'file
)))
2298 (setq tail
(cdr tail
))))
2301 (put 'require
'byte-hunk-handler
'byte-compile-file-form-require
)
2302 (defun byte-compile-file-form-require (form)
2303 (let ((args (mapcar 'eval
(cdr form
)))
2304 (hist-orig load-history
)
2306 (apply 'require args
)
2307 (when (byte-compile-warning-enabled-p 'cl-functions
)
2308 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2309 (if (member (car args
) '("cl" cl
))
2311 (byte-compile-warn "cl package required at runtime")
2312 (byte-compile-disable-warning 'cl-functions
))
2313 ;; We may have required something that causes cl to be loaded, eg
2314 ;; the uncompiled version of a file that requires cl when compiling.
2315 (setq hist-new load-history
)
2316 (while (and (not byte-compile-cl-functions
)
2317 hist-new
(not (eq hist-new hist-orig
)))
2318 (and (byte-compile-cl-file-p (car (pop hist-new
)))
2319 (byte-compile-find-cl-functions))))))
2320 (byte-compile-keep-pending form
'byte-compile-normal-call
))
2322 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
2323 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
2324 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
2325 (defun byte-compile-file-form-progn (form)
2326 (mapc 'byte-compile-file-form
(cdr form
))
2327 ;; Return nil so the forms are not output twice.
2330 (put 'with-no-warnings
'byte-hunk-handler
2331 'byte-compile-file-form-with-no-warnings
)
2332 (defun byte-compile-file-form-with-no-warnings (form)
2333 ;; cf byte-compile-file-form-progn.
2334 (let (byte-compile-warnings)
2335 (mapc 'byte-compile-file-form
(cdr form
))
2338 ;; This handler is not necessary, but it makes the output from dont-compile
2339 ;; and similar macros cleaner.
2340 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
2341 (defun byte-compile-file-form-eval (form)
2342 (if (eq (car-safe (nth 1 form
)) 'quote
)
2343 (nth 1 (nth 1 form
))
2344 (byte-compile-keep-pending form
)))
2346 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
2347 (defun byte-compile-file-form-defun (form)
2348 (byte-compile-file-form-defmumble form nil
))
2350 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
2351 (defun byte-compile-file-form-defmacro (form)
2352 (byte-compile-file-form-defmumble form t
))
2354 (defun byte-compile-defmacro-declaration (form)
2355 "Generate code for declarations in macro definitions.
2356 Remove declarations from the body of the macro definition
2358 (let ((tail (nthcdr 2 form
))
2360 (when (stringp (car (cdr tail
)))
2361 (setq tail
(cdr tail
)))
2362 (while (and (consp (car (cdr tail
)))
2363 (eq (car (car (cdr tail
))) 'declare
))
2364 (let ((declaration (car (cdr tail
))))
2365 (setcdr tail
(cdr (cdr tail
)))
2366 (push `(if macro-declaration-function
2367 (funcall macro-declaration-function
2368 ',(car (cdr form
)) ',declaration
))
2372 (defun byte-compile-file-form-defmumble (form macrop
)
2373 (let* ((bytecomp-name (car (cdr form
)))
2374 (bytecomp-this-kind (if macrop
'byte-compile-macro-environment
2375 'byte-compile-function-environment
))
2376 (bytecomp-that-kind (if macrop
'byte-compile-function-environment
2377 'byte-compile-macro-environment
))
2378 (bytecomp-this-one (assq bytecomp-name
2379 (symbol-value bytecomp-this-kind
)))
2380 (bytecomp-that-one (assq bytecomp-name
2381 (symbol-value bytecomp-that-kind
)))
2382 (byte-compile-free-references nil
)
2383 (byte-compile-free-assignments nil
))
2384 (byte-compile-set-symbol-position bytecomp-name
)
2385 ;; When a function or macro is defined, add it to the call tree so that
2386 ;; we can tell when functions are not used.
2387 (if byte-compile-generate-call-tree
2388 (or (assq bytecomp-name byte-compile-call-tree
)
2389 (setq byte-compile-call-tree
2390 (cons (list bytecomp-name nil nil
) byte-compile-call-tree
))))
2392 (setq byte-compile-current-form bytecomp-name
) ; for warnings
2393 (if (byte-compile-warning-enabled-p 'redefine
)
2394 (byte-compile-arglist-warn form macrop
))
2395 (if byte-compile-verbose
2396 (message "Compiling %s... (%s)"
2397 (or byte-compile-current-file
"") (nth 1 form
)))
2398 (cond (bytecomp-that-one
2399 (if (and (byte-compile-warning-enabled-p 'redefine
)
2400 ;; don't warn when compiling the stubs in byte-run...
2401 (not (assq (nth 1 form
)
2402 byte-compile-initial-macro-environment
)))
2404 "`%s' defined multiple times, as both function and macro"
2406 (setcdr bytecomp-that-one nil
))
2408 (when (and (byte-compile-warning-enabled-p 'redefine
)
2409 ;; hack: don't warn when compiling the magic internal
2410 ;; byte-compiler macros in byte-run.el...
2411 (not (assq (nth 1 form
)
2412 byte-compile-initial-macro-environment
)))
2413 (byte-compile-warn "%s `%s' defined multiple times in this file"
2414 (if macrop
"macro" "function")
2416 ((and (fboundp bytecomp-name
)
2417 (eq (car-safe (symbol-function bytecomp-name
))
2418 (if macrop
'lambda
'macro
)))
2419 (when (byte-compile-warning-enabled-p 'redefine
)
2420 (byte-compile-warn "%s `%s' being redefined as a %s"
2421 (if macrop
"function" "macro")
2423 (if macrop
"macro" "function")))
2424 ;; shadow existing definition
2425 (set bytecomp-this-kind
2426 (cons (cons bytecomp-name nil
)
2427 (symbol-value bytecomp-this-kind
))))
2429 (let ((body (nthcdr 3 form
)))
2430 (when (and (stringp (car body
))
2431 (symbolp (car-safe (cdr-safe body
)))
2432 (car-safe (cdr-safe body
))
2433 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
2434 (byte-compile-set-symbol-position (nth 1 form
))
2435 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2438 ;; Generate code for declarations in macro definitions.
2439 ;; Remove declarations from the body of the macro definition.
2441 (dolist (decl (byte-compile-defmacro-declaration form
))
2442 (prin1 decl bytecomp-outbuffer
)))
2444 (let* ((new-one (byte-compile-lambda (nthcdr 2 form
) t
))
2445 (code (byte-compile-byte-code-maker new-one
)))
2446 (if bytecomp-this-one
2447 (setcdr bytecomp-this-one new-one
)
2448 (set bytecomp-this-kind
2449 (cons (cons bytecomp-name new-one
)
2450 (symbol-value bytecomp-this-kind
))))
2451 (if (and (stringp (nth 3 form
))
2452 (eq 'quote
(car-safe code
))
2453 (eq 'lambda
(car-safe (nth 1 code
))))
2455 (cons bytecomp-name
(cdr (nth 1 code
))))
2456 (byte-compile-flush-pending)
2457 (if (not (stringp (nth 3 form
)))
2458 ;; No doc string. Provide -1 as the "doc string index"
2459 ;; so that no element will be treated as a doc string.
2460 (byte-compile-output-docform
2464 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]")))
2465 ((eq (car code
) 'quote
)
2467 (if macrop
'(" '(macro " -
1 ")") '(" '(" -
1 ")")))
2468 ((if macrop
'(" (cons 'macro (" -
1 "))") '(" (" -
1 ")"))))
2470 (and (atom code
) byte-compile-dynamic
2473 ;; Output the form by hand, that's much simpler than having
2474 ;; b-c-output-file-form analyze the defalias.
2475 (byte-compile-output-docform
2479 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2480 ((eq (car code
) 'quote
)
2482 (if macrop
'(" '(macro " 2 ")") '(" '(" 2 ")")))
2483 ((if macrop
'(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2485 (and (atom code
) byte-compile-dynamic
2488 (princ ")" bytecomp-outbuffer
)
2491 ;; Print Lisp object EXP in the output file, inside a comment,
2492 ;; and return the file position it will have.
2493 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2494 (defun byte-compile-output-as-comment (exp quoted
)
2495 (let ((position (point)))
2496 (with-current-buffer bytecomp-outbuffer
2498 ;; Insert EXP, and make it a comment with #@LENGTH.
2501 (prin1 exp bytecomp-outbuffer
)
2502 (princ exp bytecomp-outbuffer
))
2503 (goto-char position
)
2504 ;; Quote certain special characters as needed.
2505 ;; get_doc_string in doc.c does the unquoting.
2506 (while (search-forward "\^A" nil t
)
2507 (replace-match "\^A\^A" t t
))
2508 (goto-char position
)
2509 (while (search-forward "\000" nil t
)
2510 (replace-match "\^A0" t t
))
2511 (goto-char position
)
2512 (while (search-forward "\037" nil t
)
2513 (replace-match "\^A_" t t
))
2514 (goto-char (point-max))
2516 (goto-char position
)
2517 (insert "#@" (format "%d" (- (position-bytes (point-max))
2518 (position-bytes position
))))
2520 ;; Save the file position of the object.
2521 ;; Note we should add 1 to skip the space
2522 ;; that we inserted before the actual doc string,
2523 ;; and subtract 1 to convert from an 1-origin Emacs position
2524 ;; to a file position; they cancel.
2525 (setq position
(point))
2526 (goto-char (point-max)))
2532 (defun byte-compile (form)
2533 "If FORM is a symbol, byte-compile its function definition.
2534 If FORM is a lambda or a macro, byte-compile it as a function."
2535 (displaying-byte-compile-warnings
2536 (byte-compile-close-variables
2537 (let* ((fun (if (symbolp form
)
2538 (and (fboundp form
) (symbol-function form
))
2540 (macro (eq (car-safe fun
) 'macro
)))
2542 (setq fun
(cdr fun
)))
2543 (cond ((eq (car-safe fun
) 'lambda
)
2546 (macroexpand-all fun
2547 byte-compile-initial-macro-environment
))
2549 (setq fun
(cconv-closure-convert fun
)))
2550 ;; Get rid of the `function' quote added by the `lambda' macro.
2551 (if (eq (car-safe fun
) 'function
) (setq fun
(cadr fun
)))
2553 (cons 'macro
(byte-compile-lambda fun
))
2554 (byte-compile-lambda fun
)))
2559 (defun byte-compile-sexp (sexp)
2560 "Compile and return SEXP."
2561 (displaying-byte-compile-warnings
2562 (byte-compile-close-variables
2563 (byte-compile-top-level sexp
))))
2565 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2566 (defun byte-compile-byte-code-maker (fun)
2568 ;; ## atom is faster than compiled-func-p.
2569 ((atom fun
) ; compiled function.
2570 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2571 ;; would have produced a lambda.
2573 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2574 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2576 ;; FIXME: can this happen?
2577 (if (and (setq tmp
(assq 'byte-code
(cdr-safe (cdr fun
))))
2578 (null (cdr (memq tmp fun
))))
2579 ;; Generate a make-byte-code call.
2580 (let* ((interactive (assq 'interactive
(cdr (cdr fun
)))))
2581 (nconc (list 'make-byte-code
2582 (list 'quote
(nth 1 fun
)) ;arglist
2586 (cond ((stringp (nth 2 fun
))
2587 (list (nth 2 fun
))) ;doc
2591 (list (if (or (null (nth 1 interactive
))
2592 (stringp (nth 1 interactive
)))
2594 ;; Interactive spec is a list or a variable
2595 ;; (if it is correct).
2596 (list 'quote
(nth 1 interactive
))))))))
2597 ;; a non-compiled function (probably trivial)
2598 (list 'quote fun
))))))
2600 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2601 (defun byte-compile-byte-code-unmake (function) ;FIXME: what is it?
2602 (if (consp function
)
2603 function
;;It already is a lambda.
2604 (setq function
(append function nil
)) ; turn it into a list
2605 (nconc (list 'lambda
(nth 0 function
))
2606 (and (nth 4 function
) (list (nth 4 function
)))
2607 (if (nthcdr 5 function
)
2608 (list (cons 'interactive
(if (nth 5 function
)
2609 (nthcdr 5 function
)))))
2610 (list (list 'byte-code
2611 (nth 1 function
) (nth 2 function
)
2612 (nth 3 function
))))))
2615 (defun byte-compile-check-lambda-list (list)
2616 "Check lambda-list LIST for errors."
2619 (let ((arg (car list
)))
2621 (byte-compile-set-symbol-position arg
))
2622 (cond ((or (not (symbolp arg
))
2623 (byte-compile-const-symbol-p arg t
))
2624 (error "Invalid lambda variable %s" arg
))
2627 (error "&rest without variable name"))
2629 (error "Garbage following &rest VAR in lambda-list")))
2630 ((eq arg
'&optional
)
2632 (error "Variable name missing after &optional")))
2634 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2637 (setq list
(cdr list
)))))
2640 (defun byte-compile-arglist-vars (arglist)
2641 "Return a list of the variables in the lambda argument list ARGLIST."
2642 (remq '&rest
(remq '&optional arglist
)))
2644 (defun byte-compile-make-lambda-lexenv (form)
2645 "Return a new lexical environment for a lambda expression FORM."
2646 ;; See if this is a closure or not
2647 (let ((args (byte-compile-arglist-vars (cadr form
))))
2649 ;; Fill in the initial stack contents
2651 ;; Add entries for each argument
2653 (push (cons arg stackpos
) lexenv
)
2654 (setq stackpos
(1+ stackpos
)))
2655 ;; Return the new lexical environment
2658 (defun byte-compile-make-args-desc (arglist)
2661 (while (and arglist
(not (memq (car arglist
) '(&optional
&rest
))))
2662 (setq mandatory
(1+ mandatory
))
2663 (setq arglist
(cdr arglist
)))
2664 (setq nonrest mandatory
)
2665 (when (eq (car arglist
) '&optional
)
2666 (setq arglist
(cdr arglist
))
2667 (while (and arglist
(not (eq (car arglist
) '&rest
)))
2668 (setq nonrest
(1+ nonrest
))
2669 (setq arglist
(cdr arglist
))))
2672 (if (> mandatory
127)
2673 (byte-compile-report-error "Too many (>127) mandatory arguments")
2678 ;; Byte-compile a lambda-expression and return a valid function.
2679 ;; The value is usually a compiled function but may be the original
2680 ;; lambda-expression.
2681 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2682 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2683 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2684 ;; for symbols generated by the byte compiler itself.
2685 (defun byte-compile-lambda (bytecomp-fun &optional add-lambda reserved-csts
)
2687 (setq bytecomp-fun
(cons 'lambda bytecomp-fun
))
2688 (unless (eq 'lambda
(car-safe bytecomp-fun
))
2689 (error "Not a lambda list: %S" bytecomp-fun
))
2690 (byte-compile-set-symbol-position 'lambda
))
2691 (byte-compile-check-lambda-list (nth 1 bytecomp-fun
))
2692 (let* ((bytecomp-arglist (nth 1 bytecomp-fun
))
2693 (byte-compile-bound-variables
2694 (append (and (not lexical-binding
)
2695 (byte-compile-arglist-vars bytecomp-arglist
))
2696 byte-compile-bound-variables
))
2697 (bytecomp-body (cdr (cdr bytecomp-fun
)))
2698 (bytecomp-doc (if (stringp (car bytecomp-body
))
2699 (prog1 (car bytecomp-body
)
2700 ;; Discard the doc string
2701 ;; unless it is the last element of the body.
2702 (if (cdr bytecomp-body
)
2703 (setq bytecomp-body
(cdr bytecomp-body
))))))
2704 (bytecomp-int (assq 'interactive bytecomp-body
)))
2705 ;; Process the interactive spec.
2707 (byte-compile-set-symbol-position 'interactive
)
2708 ;; Skip (interactive) if it is in front (the most usual location).
2709 (if (eq bytecomp-int
(car bytecomp-body
))
2710 (setq bytecomp-body
(cdr bytecomp-body
)))
2711 (cond ((consp (cdr bytecomp-int
))
2712 (if (cdr (cdr bytecomp-int
))
2713 (byte-compile-warn "malformed interactive spec: %s"
2714 (prin1-to-string bytecomp-int
)))
2715 ;; If the interactive spec is a call to `list', don't
2716 ;; compile it, because `call-interactively' looks at the
2717 ;; args of `list'. Actually, compile it to get warnings,
2718 ;; but don't use the result.
2719 (let* ((form (nth 1 bytecomp-int
))
2720 (newform (byte-compile-top-level form
)))
2721 (while (memq (car-safe form
) '(let let
* progn save-excursion
))
2722 (while (consp (cdr form
))
2723 (setq form
(cdr form
)))
2724 (setq form
(car form
)))
2725 (if (and (eq (car-safe form
) 'list
)
2726 ;; The spec is evaled in callint.c in dynamic-scoping
2727 ;; mode, so just leaving the form unchanged would mean
2728 ;; it won't be eval'd in the right mode.
2729 (not lexical-binding
))
2731 (setq bytecomp-int
`(interactive ,newform
)))))
2733 (byte-compile-warn "malformed interactive spec: %s"
2734 (prin1-to-string bytecomp-int
)))))
2735 ;; Process the body.
2737 (byte-compile-top-level (cons 'progn bytecomp-body
) nil
'lambda
2738 ;; If doing lexical binding, push a new
2739 ;; lexical environment containing just the
2740 ;; args (since lambda expressions should be
2742 (and lexical-binding
2743 (byte-compile-make-lambda-lexenv
2746 ;; Build the actual byte-coded function.
2747 (if (eq 'byte-code
(car-safe compiled
))
2748 (apply 'make-byte-code
2750 (byte-compile-make-args-desc bytecomp-arglist
)
2753 ;; byte-string, constants-vector, stack depth
2755 ;; optionally, the doc string.
2756 (cond (lexical-binding
2758 (list (help-add-fundoc-usage
2759 bytecomp-doc bytecomp-arglist
)))
2760 ((or bytecomp-doc bytecomp-int
)
2761 (list bytecomp-doc
)))
2762 ;; optionally, the interactive spec.
2764 (list (nth 1 bytecomp-int
)))))
2766 (nconc (if bytecomp-int
(list bytecomp-int
))
2767 (cond ((eq (car-safe compiled
) 'progn
) (cdr compiled
))
2768 (compiled (list compiled
)))))
2769 (nconc (list 'lambda bytecomp-arglist
)
2770 (if (or bytecomp-doc
(stringp (car compiled
)))
2771 (cons bytecomp-doc
(cond (compiled)
2772 (bytecomp-body (list nil
))))
2775 (defun byte-compile-closure (form &optional add-lambda
)
2776 (let ((code (byte-compile-lambda form add-lambda
)))
2777 ;; A simple lambda is just a constant.
2778 (byte-compile-constant code
)))
2780 (defvar byte-compile-reserved-constants
0)
2782 (defun byte-compile-constants-vector ()
2783 ;; Builds the constants-vector from the current variables and constants.
2784 ;; This modifies the constants from (const . nil) to (const . offset).
2785 ;; To keep the byte-codes to look up the vector as short as possible:
2786 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2787 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2788 ;; Next variables again, to get 2-byte codes for variable lookup.
2789 ;; The rest of the constants and variables need 3-byte byte-codes.
2790 (let* ((i (1- byte-compile-reserved-constants
))
2791 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2792 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2794 (limits '(5 ; Use the 1-byte varref codes,
2795 63 ; 1-constlim ; 1-byte byte-constant codes,
2796 255 ; 2-byte varref codes,
2797 65535)) ; 3-byte codes for the rest.
2799 (while (or rest other
)
2800 (setq limit
(car limits
))
2801 (while (and rest
(< i limit
))
2803 ((numberp (car rest
))
2804 (assert (< (car rest
) byte-compile-reserved-constants
)))
2805 ((setq tmp
(assq (car (car rest
)) ret
))
2806 (setcdr (car rest
) (cdr tmp
)))
2808 (setcdr (car rest
) (setq i
(1+ i
)))
2809 (setq ret
(cons (car rest
) ret
))))
2810 (setq rest
(cdr rest
)))
2811 (setq limits
(cdr limits
)
2813 (setq other rest
))))
2814 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2816 ;; Given an expression FORM, compile it and return an equivalent byte-code
2817 ;; expression (a call to the function byte-code).
2818 (defun byte-compile-top-level (form &optional for-effect-arg output-type
2819 lexenv reserved-csts
)
2820 ;; OUTPUT-TYPE advises about how form is expected to be used:
2821 ;; 'eval or nil -> a single form,
2822 ;; 'progn or t -> a list of forms,
2823 ;; 'lambda -> body of a lambda,
2824 ;; 'file -> used at file-level.
2825 (let ((for-effect for-effect-arg
)
2826 (byte-compile-constants nil
)
2827 (byte-compile-variables nil
)
2828 (byte-compile-tag-number 0)
2829 (byte-compile-depth 0)
2830 (byte-compile-maxdepth 0)
2831 (byte-compile-lexical-environment lexenv
)
2832 (byte-compile-reserved-constants (or reserved-csts
0))
2833 (byte-compile-output nil
))
2834 (if (memq byte-optimize
'(t source
))
2835 (setq form
(byte-optimize-form form for-effect
)))
2836 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2837 (setq form
(nth 1 form
)))
2838 (if (and (eq 'byte-code
(car-safe form
))
2839 (not (memq byte-optimize
'(t byte
)))
2840 (stringp (nth 1 form
)) (vectorp (nth 2 form
))
2841 (natnump (nth 3 form
)))
2843 ;; Set up things for a lexically-bound function.
2844 (when (and lexical-binding
(eq output-type
'lambda
))
2845 ;; See how many arguments there are, and set the current stack depth
2847 (setq byte-compile-depth
(length byte-compile-lexical-environment
))
2848 ;; If there are args, output a tag to record the initial
2849 ;; stack-depth for the optimizer.
2850 (when (> byte-compile-depth
0)
2851 (byte-compile-out-tag (byte-compile-make-tag))))
2853 (byte-compile-form form for-effect
)
2854 (byte-compile-out-toplevel for-effect output-type
))))
2856 (defun byte-compile-out-toplevel (&optional for-effect-arg output-type
)
2858 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2859 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2860 (setq byte-compile-output
(cdr byte-compile-output
))
2861 (byte-compile-push-constant
2862 ;; Push any constant - preferably one which already is used, and
2863 ;; a number or symbol - ie not some big sequence. The return value
2864 ;; isn't returned, but it would be a shame if some textually large
2865 ;; constant was not optimized away because we chose to return it.
2866 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2867 (let ((tmp (reverse byte-compile-constants
)))
2868 (while (and tmp
(not (or (symbolp (caar tmp
))
2869 (numberp (caar tmp
)))))
2870 (setq tmp
(cdr tmp
)))
2872 (byte-compile-out 'byte-return
0)
2873 (setq byte-compile-output
(nreverse byte-compile-output
))
2874 (if (memq byte-optimize
'(t byte
))
2875 (setq byte-compile-output
2876 (byte-optimize-lapcode byte-compile-output
)))
2878 ;; Decompile trivial functions:
2879 ;; only constants and variables, or a single funcall except in lambdas.
2880 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2881 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2882 ;; Note that even (quote foo) must be parsed just as any subr by the
2883 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2884 ;; What to leave uncompiled:
2885 ;; lambda -> never. we used to leave it uncompiled if the body was
2886 ;; a single atom, but that causes confusion if the docstring
2887 ;; uses the (file . pos) syntax. Besides, now that we have
2888 ;; the Lisp_Compiled type, the compiled form is faster.
2889 ;; eval -> atom, quote or (function atom atom atom)
2890 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2891 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2893 (for-effect for-effect-arg
)
2894 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2897 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2898 ((or (eq output-type
'lambda
)
2899 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2900 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2901 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2903 (setq rest
(nreverse
2904 (cdr (memq tmp
(reverse byte-compile-output
)))))
2906 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2907 (setq tmp
(car (cdr (car rest
))))
2908 (if (if (eq (car (car rest
)) 'byte-constant
)
2911 (not (byte-compile-const-symbol-p tmp
)))))
2913 (setq body
(cons (list 'quote tmp
) body
)))
2914 (setq body
(cons tmp body
))))
2916 ;; Allow a funcall if at most one atom follows it.
2917 (null (nthcdr 3 rest
))
2918 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2919 (or (null (cdr rest
))
2920 (and (memq output-type
'(file progn t
))
2922 (eq (car (nth 1 rest
)) 'byte-discard
)
2923 (progn (setq rest
(cdr rest
)) t
))))
2924 (setq maycall nil
) ; Only allow one real function call.
2925 (setq body
(nreverse body
))
2927 (if (and (eq tmp
'funcall
)
2928 (eq (car-safe (car body
)) 'quote
))
2929 (cons (nth 1 (car body
)) (cdr body
))
2931 (or (eq output-type
'file
)
2932 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2933 (setq rest
(cdr rest
)))
2935 (let ((byte-compile-vector (byte-compile-constants-vector)))
2936 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2937 byte-compile-vector byte-compile-maxdepth
)))
2938 ;; it's a trivial function
2939 ((cdr body
) (cons 'progn
(nreverse body
)))
2942 ;; Given BYTECOMP-BODY, compile it and return a new body.
2943 (defun byte-compile-top-level-body (bytecomp-body &optional for-effect-arg
)
2945 (byte-compile-top-level (cons 'progn bytecomp-body
) for-effect-arg t
))
2946 (cond ((eq (car-safe bytecomp-body
) 'progn
)
2947 (cdr bytecomp-body
))
2949 (list bytecomp-body
))))
2951 ;; Special macro-expander used during byte-compilation.
2952 (defun byte-compile-macroexpand-declare-function (fn file
&rest args
)
2954 (if (and (consp args
) (listp (car args
)))
2955 (list 'declared
(car args
))
2956 t
)) ; arglist not specified
2957 byte-compile-function-environment
)
2958 ;; We are stating that it _will_ be defined at runtime.
2959 (setq byte-compile-noruntime-functions
2960 (delq fn byte-compile-noruntime-functions
))
2961 ;; Delegate the rest to the normal macro definition.
2962 (macroexpand `(declare-function ,fn
,file
,@args
)))
2965 ;; This is the recursive entry point for compiling each subform of an
2967 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2968 ;; before terminating (ie no value will be left on the stack).
2969 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2970 ;; which does not leave a value on the stack, and then set for-effect to nil
2971 ;; (to prevent byte-compile-form from outputting the byte-discard).
2972 ;; If a handler wants to call another handler, it should do so via
2973 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2974 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2976 (defun byte-compile-form (form &optional for-effect-arg
)
2977 (let ((for-effect for-effect-arg
))
2980 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2981 (when (symbolp form
)
2982 (byte-compile-set-symbol-position form
))
2983 (byte-compile-constant form
))
2984 ((and for-effect byte-compile-delete-errors
)
2985 (when (symbolp form
)
2986 (byte-compile-set-symbol-position form
))
2987 (setq for-effect nil
))
2989 (byte-compile-variable-ref form
))))
2990 ((symbolp (car form
))
2991 (let* ((bytecomp-fn (car form
))
2992 (bytecomp-handler (get bytecomp-fn
'byte-compile
)))
2993 (when (byte-compile-const-symbol-p bytecomp-fn
)
2994 (byte-compile-warn "`%s' called as a function" bytecomp-fn
))
2995 (and (byte-compile-warning-enabled-p 'interactive-only
)
2996 (memq bytecomp-fn byte-compile-interactive-only-functions
)
2997 (byte-compile-warn "`%s' used from Lisp code\n\
2998 That command is designed for interactive use only" bytecomp-fn
))
2999 (if (and (fboundp (car form
))
3000 (eq (car-safe (symbol-function (car form
))) 'macro
))
3001 (byte-compile-report-error
3002 (format "Forgot to expand macro %s" (car form
))))
3003 (if (and bytecomp-handler
3004 ;; Make sure that function exists. This is important
3005 ;; for CL compiler macros since the symbol may be
3006 ;; `cl-byte-compile-compiler-macro' but if CL isn't
3007 ;; loaded, this function doesn't exist.
3008 (and (not (eq bytecomp-handler
3009 ;; Already handled by macroexpand-all.
3010 'cl-byte-compile-compiler-macro
))
3011 (functionp bytecomp-handler
)))
3012 (funcall bytecomp-handler form
)
3013 (byte-compile-normal-call form
))
3014 (if (byte-compile-warning-enabled-p 'cl-functions
)
3015 (byte-compile-cl-warn form
))))
3016 ((and (or (byte-code-function-p (car form
))
3017 (eq (car-safe (car form
)) 'lambda
))
3018 ;; if the form comes out the same way it went in, that's
3019 ;; because it was malformed, and we couldn't unfold it.
3020 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
3021 (byte-compile-form form for-effect
)
3022 (setq for-effect nil
))
3023 ((byte-compile-normal-call form
)))
3025 (byte-compile-discard))))
3027 (defun byte-compile-normal-call (form)
3028 (when (and (byte-compile-warning-enabled-p 'callargs
)
3029 (symbolp (car form
)))
3030 (if (memq (car form
)
3031 '(custom-declare-group
3032 ;; custom-declare-variable custom-declare-face
3034 (byte-compile-nogroup-warn form
))
3035 (when (get (car form
) 'byte-obsolete-info
)
3036 (byte-compile-warn-obsolete (car form
)))
3037 (byte-compile-callargs-warn form
))
3038 (if byte-compile-generate-call-tree
3039 (byte-compile-annotate-call-tree form
))
3040 (when (and for-effect
(eq (car form
) 'mapcar
)
3041 (byte-compile-warning-enabled-p 'mapcar
))
3042 (byte-compile-set-symbol-position 'mapcar
)
3044 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
3045 (byte-compile-push-constant (car form
))
3046 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
3047 (byte-compile-out 'byte-call
(length (cdr form
))))
3049 (defun byte-compile-check-variable (var &optional binding
)
3050 "Do various error checks before a use of the variable VAR.
3051 If BINDING is non-nil, VAR is being bound."
3053 (byte-compile-set-symbol-position var
))
3054 (cond ((or (not (symbolp var
)) (byte-compile-const-symbol-p var
))
3055 (when (byte-compile-warning-enabled-p 'constants
)
3056 (byte-compile-warn (if binding
3057 "attempt to let-bind %s `%s`"
3058 "variable reference to %s `%s'")
3059 (if (symbolp var
) "constant" "nonvariable")
3060 (prin1-to-string var
))))
3061 ((and (get var
'byte-obsolete-variable
)
3062 (not (memq var byte-compile-not-obsolete-vars
)))
3063 (byte-compile-warn-obsolete var
))))
3065 (defsubst byte-compile-dynamic-variable-op
(base-op var
)
3066 (let ((tmp (assq var byte-compile-variables
)))
3068 (setq tmp
(list var
))
3069 (push tmp byte-compile-variables
))
3070 (byte-compile-out base-op tmp
)))
3072 (defun byte-compile-dynamic-variable-bind (var)
3073 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3074 (byte-compile-check-variable var t
)
3075 (push var byte-compile-bound-variables
)
3076 (byte-compile-dynamic-variable-op 'byte-varbind var
))
3078 (defun byte-compile-variable-ref (var)
3079 "Generate code to push the value of the variable VAR on the stack."
3080 (byte-compile-check-variable var
)
3081 (let ((lex-binding (assq var byte-compile-lexical-environment
)))
3083 ;; VAR is lexically bound
3084 (byte-compile-stack-ref (cdr lex-binding
))
3085 ;; VAR is dynamically bound
3086 (unless (or (not (byte-compile-warning-enabled-p 'free-vars
))
3088 (memq var byte-compile-bound-variables
)
3089 (memq var byte-compile-free-references
))
3090 (byte-compile-warn "reference to free variable `%S'" var
)
3091 (push var byte-compile-free-references
))
3092 (byte-compile-dynamic-variable-op 'byte-varref var
))))
3094 (defun byte-compile-variable-set (var)
3095 "Generate code to set the variable VAR from the top-of-stack value."
3096 (byte-compile-check-variable var
)
3097 (let ((lex-binding (assq var byte-compile-lexical-environment
)))
3099 ;; VAR is lexically bound
3100 (byte-compile-stack-set (cdr lex-binding
))
3101 ;; VAR is dynamically bound
3102 (unless (or (not (byte-compile-warning-enabled-p 'free-vars
))
3104 (memq var byte-compile-bound-variables
)
3105 (memq var byte-compile-free-assignments
))
3106 (byte-compile-warn "assignment to free variable `%s'" var
)
3107 (push var byte-compile-free-assignments
))
3108 (byte-compile-dynamic-variable-op 'byte-varset var
))))
3110 (defmacro byte-compile-get-constant
(const)
3111 `(or (if (stringp ,const
)
3112 ;; In a string constant, treat properties as significant.
3114 (dolist (elt byte-compile-constants
)
3115 (if (equal-including-properties (car elt
) ,const
)
3118 (assq ,const byte-compile-constants
))
3119 (car (setq byte-compile-constants
3120 (cons (list ,const
) byte-compile-constants
)))))
3122 ;; Use this when the value of a form is a constant. This obeys for-effect.
3123 (defun byte-compile-constant (const)
3125 (setq for-effect nil
)
3126 (when (symbolp const
)
3127 (byte-compile-set-symbol-position const
))
3128 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
3130 ;; Use this for a constant that is not the value of its containing form.
3131 ;; This ignores for-effect.
3132 (defun byte-compile-push-constant (const)
3133 (let ((for-effect nil
))
3134 (inline (byte-compile-constant const
))))
3136 ;; Compile those primitive ordinary functions
3137 ;; which have special byte codes just for speed.
3139 (defmacro byte-defop-compiler
(function &optional compile-handler
)
3140 "Add a compiler-form for FUNCTION.
3141 If function is a symbol, then the variable \"byte-SYMBOL\" must name
3142 the opcode to be used. If function is a list, the first element
3143 is the function and the second element is the bytecode-symbol.
3144 The second element may be nil, meaning there is no opcode.
3145 COMPILE-HANDLER is the function to use to compile this byte-op, or
3146 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3147 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
3149 (if (symbolp function
)
3150 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
3151 (setq opcode
(car (cdr function
))
3152 function
(car function
)))
3154 (list 'put
(list 'quote function
) ''byte-compile
3156 (or (cdr (assq compile-handler
3157 '((0 . byte-compile-no-args
)
3158 (1 . byte-compile-one-arg
)
3159 (2 . byte-compile-two-args
)
3160 (3 . byte-compile-three-args
)
3161 (0-1 . byte-compile-zero-or-one-arg
)
3162 (1-2 . byte-compile-one-or-two-args
)
3163 (2-3 . byte-compile-two-or-three-args
)
3166 (intern (concat "byte-compile-"
3167 (symbol-name function
))))))))
3170 (list 'put
(list 'quote function
)
3171 ''byte-opcode
(list 'quote opcode
))
3172 (list 'put
(list 'quote opcode
)
3173 ''byte-opcode-invert
(list 'quote function
)))
3176 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
3177 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
3180 (put 'byte-call
'byte-opcode-invert
'funcall
)
3181 (put 'byte-list1
'byte-opcode-invert
'list
)
3182 (put 'byte-list2
'byte-opcode-invert
'list
)
3183 (put 'byte-list3
'byte-opcode-invert
'list
)
3184 (put 'byte-list4
'byte-opcode-invert
'list
)
3185 (put 'byte-listN
'byte-opcode-invert
'list
)
3186 (put 'byte-concat2
'byte-opcode-invert
'concat
)
3187 (put 'byte-concat3
'byte-opcode-invert
'concat
)
3188 (put 'byte-concat4
'byte-opcode-invert
'concat
)
3189 (put 'byte-concatN
'byte-opcode-invert
'concat
)
3190 (put 'byte-insertN
'byte-opcode-invert
'insert
)
3192 (byte-defop-compiler point
0)
3193 ;;(byte-defop-compiler mark 0) ;; obsolete
3194 (byte-defop-compiler point-max
0)
3195 (byte-defop-compiler point-min
0)
3196 (byte-defop-compiler following-char
0)
3197 (byte-defop-compiler preceding-char
0)
3198 (byte-defop-compiler current-column
0)
3199 (byte-defop-compiler eolp
0)
3200 (byte-defop-compiler eobp
0)
3201 (byte-defop-compiler bolp
0)
3202 (byte-defop-compiler bobp
0)
3203 (byte-defop-compiler current-buffer
0)
3204 ;;(byte-defop-compiler read-char 0) ;; obsolete
3205 (byte-defop-compiler widen
0)
3206 (byte-defop-compiler end-of-line
0-
1)
3207 (byte-defop-compiler forward-char
0-
1)
3208 (byte-defop-compiler forward-line
0-
1)
3209 (byte-defop-compiler symbolp
1)
3210 (byte-defop-compiler consp
1)
3211 (byte-defop-compiler stringp
1)
3212 (byte-defop-compiler listp
1)
3213 (byte-defop-compiler not
1)
3214 (byte-defop-compiler (null byte-not
) 1)
3215 (byte-defop-compiler car
1)
3216 (byte-defop-compiler cdr
1)
3217 (byte-defop-compiler length
1)
3218 (byte-defop-compiler symbol-value
1)
3219 (byte-defop-compiler symbol-function
1)
3220 (byte-defop-compiler (1+ byte-add1
) 1)
3221 (byte-defop-compiler (1- byte-sub1
) 1)
3222 (byte-defop-compiler goto-char
1)
3223 (byte-defop-compiler char-after
0-
1)
3224 (byte-defop-compiler set-buffer
1)
3225 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3226 (byte-defop-compiler forward-word
0-
1)
3227 (byte-defop-compiler char-syntax
1)
3228 (byte-defop-compiler nreverse
1)
3229 (byte-defop-compiler car-safe
1)
3230 (byte-defop-compiler cdr-safe
1)
3231 (byte-defop-compiler numberp
1)
3232 (byte-defop-compiler integerp
1)
3233 (byte-defop-compiler skip-chars-forward
1-
2)
3234 (byte-defop-compiler skip-chars-backward
1-
2)
3235 (byte-defop-compiler eq
2)
3236 (byte-defop-compiler memq
2)
3237 (byte-defop-compiler cons
2)
3238 (byte-defop-compiler aref
2)
3239 (byte-defop-compiler set
2)
3240 (byte-defop-compiler (= byte-eqlsign
) 2)
3241 (byte-defop-compiler (< byte-lss
) 2)
3242 (byte-defop-compiler (> byte-gtr
) 2)
3243 (byte-defop-compiler (<= byte-leq
) 2)
3244 (byte-defop-compiler (>= byte-geq
) 2)
3245 (byte-defop-compiler get
2)
3246 (byte-defop-compiler nth
2)
3247 (byte-defop-compiler substring
2-
3)
3248 (byte-defop-compiler (move-marker byte-set-marker
) 2-
3)
3249 (byte-defop-compiler set-marker
2-
3)
3250 (byte-defop-compiler match-beginning
1)
3251 (byte-defop-compiler match-end
1)
3252 (byte-defop-compiler upcase
1)
3253 (byte-defop-compiler downcase
1)
3254 (byte-defop-compiler string
= 2)
3255 (byte-defop-compiler string
< 2)
3256 (byte-defop-compiler (string-equal byte-string
=) 2)
3257 (byte-defop-compiler (string-lessp byte-string
<) 2)
3258 (byte-defop-compiler equal
2)
3259 (byte-defop-compiler nthcdr
2)
3260 (byte-defop-compiler elt
2)
3261 (byte-defop-compiler member
2)
3262 (byte-defop-compiler assq
2)
3263 (byte-defop-compiler (rplaca byte-setcar
) 2)
3264 (byte-defop-compiler (rplacd byte-setcdr
) 2)
3265 (byte-defop-compiler setcar
2)
3266 (byte-defop-compiler setcdr
2)
3267 (byte-defop-compiler buffer-substring
2)
3268 (byte-defop-compiler delete-region
2)
3269 (byte-defop-compiler narrow-to-region
2)
3270 (byte-defop-compiler (% byte-rem
) 2)
3271 (byte-defop-compiler aset
3)
3273 (byte-defop-compiler max byte-compile-associative
)
3274 (byte-defop-compiler min byte-compile-associative
)
3275 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
3276 (byte-defop-compiler (* byte-mult
) byte-compile-associative
)
3278 ;;####(byte-defop-compiler move-to-column 1)
3279 (byte-defop-compiler-1 interactive byte-compile-noop
)
3282 (defun byte-compile-subr-wrong-args (form n
)
3283 (byte-compile-set-symbol-position (car form
))
3284 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3285 (car form
) (length (cdr form
))
3286 (if (= 1 (length (cdr form
))) "" "s") n
)
3287 ;; get run-time wrong-number-of-args error.
3288 (byte-compile-normal-call form
))
3290 (defun byte-compile-no-args (form)
3291 (if (not (= (length form
) 1))
3292 (byte-compile-subr-wrong-args form
"none")
3293 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3295 (defun byte-compile-one-arg (form)
3296 (if (not (= (length form
) 2))
3297 (byte-compile-subr-wrong-args form
1)
3298 (byte-compile-form (car (cdr form
))) ;; Push the argument
3299 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3301 (defun byte-compile-two-args (form)
3302 (if (not (= (length form
) 3))
3303 (byte-compile-subr-wrong-args form
2)
3304 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3305 (byte-compile-form (nth 2 form
))
3306 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3308 (defun byte-compile-three-args (form)
3309 (if (not (= (length form
) 4))
3310 (byte-compile-subr-wrong-args form
3)
3311 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3312 (byte-compile-form (nth 2 form
))
3313 (byte-compile-form (nth 3 form
))
3314 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3316 (defun byte-compile-zero-or-one-arg (form)
3317 (let ((len (length form
)))
3318 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
3319 ((= len
2) (byte-compile-one-arg form
))
3320 (t (byte-compile-subr-wrong-args form
"0-1")))))
3322 (defun byte-compile-one-or-two-args (form)
3323 (let ((len (length form
)))
3324 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
3325 ((= len
3) (byte-compile-two-args form
))
3326 (t (byte-compile-subr-wrong-args form
"1-2")))))
3328 (defun byte-compile-two-or-three-args (form)
3329 (let ((len (length form
)))
3330 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
3331 ((= len
4) (byte-compile-three-args form
))
3332 (t (byte-compile-subr-wrong-args form
"2-3")))))
3334 (defun byte-compile-noop (_form)
3335 (byte-compile-constant nil
))
3337 (defun byte-compile-discard (&optional num preserve-tos
)
3338 "Output byte codes to discard the NUM entries at the top of the stack (NUM defaults to 1).
3339 If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3340 popped before discarding the num values, and then pushed back again after
3342 (if (and (null num
) (not preserve-tos
))
3344 (byte-compile-out 'byte-discard
)
3348 (when (and preserve-tos
(> num
0))
3349 ;; Preserve the top-of-stack value by writing it directly to the stack
3350 ;; location which will be at the top-of-stack after popping.
3351 (byte-compile-stack-set (1- (- byte-compile-depth num
)))
3352 ;; Now we actually discard one less value, since we want to keep
3354 (setq num
(1- num
)))
3356 (byte-compile-out 'byte-discard
)
3357 (setq num
(1- num
)))))
3359 (defun byte-compile-stack-ref (stack-pos)
3360 "Output byte codes to push the value at position STACK-POS in the stack, on the top of the stack."
3361 (let ((dist (- byte-compile-depth
(1+ stack-pos
))))
3363 ;; A simple optimization
3364 (byte-compile-out 'byte-dup
)
3366 (byte-compile-out 'byte-stack-ref dist
))))
3368 (defun byte-compile-stack-set (stack-pos)
3369 "Output byte codes to store the top-of-stack value at position STACK-POS in the stack."
3370 (byte-compile-out 'byte-stack-set
(- byte-compile-depth
(1+ stack-pos
))))
3372 (byte-defop-compiler-1 internal-make-closure byte-compile-make-closure
)
3373 (byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var
)
3375 (defconst byte-compile--env-var
(make-symbol "env"))
3377 (defun byte-compile-make-closure (form)
3378 (if for-effect
(setq for-effect nil
)
3379 (let* ((vars (nth 1 form
))
3381 (body (nthcdr 3 form
))
3383 (byte-compile-lambda `(lambda ,vars .
,body
) nil
(length env
))))
3384 (assert (byte-code-function-p fun
))
3385 (byte-compile-form `(make-byte-code
3386 ',(aref fun
0) ',(aref fun
1)
3387 (vconcat (vector .
,env
) ',(aref fun
2))
3388 ,@(nthcdr 3 (mapcar (lambda (x) `',x
) fun
)))))))
3391 (defun byte-compile-get-closed-var (form)
3392 (if for-effect
(setq for-effect nil
)
3393 (byte-compile-out 'byte-constant
;; byte-closed-var
3396 ;; Compile a function that accepts one or more args and is right-associative.
3397 ;; We do it by left-associativity so that the operations
3398 ;; are done in the same order as in interpreted code.
3399 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3400 ;; in order to convert markers to numbers, and trigger expected errors.
3401 (defun byte-compile-associative (form)
3403 (let ((opcode (get (car form
) 'byte-opcode
))
3405 (if (and (< 3 (length form
))
3406 (memq opcode
(list (get '+ 'byte-opcode
)
3407 (get '* 'byte-opcode
))))
3408 ;; Don't use binary operations for > 2 operands, as that
3409 ;; may cause overflow/truncation in float operations.
3410 (byte-compile-normal-call form
)
3411 (setq args
(copy-sequence (cdr form
)))
3412 (byte-compile-form (car args
))
3413 (setq args
(cdr args
))
3414 (or args
(setq args
'(0)
3415 opcode
(get '+ 'byte-opcode
)))
3417 (byte-compile-form arg
)
3418 (byte-compile-out opcode
0))))
3419 (byte-compile-constant (eval form
))))
3422 ;; more complicated compiler macros
3424 (byte-defop-compiler char-before
)
3425 (byte-defop-compiler backward-char
)
3426 (byte-defop-compiler backward-word
)
3427 (byte-defop-compiler list
)
3428 (byte-defop-compiler concat
)
3429 (byte-defop-compiler fset
)
3430 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
3431 (byte-defop-compiler indent-to
)
3432 (byte-defop-compiler insert
)
3433 (byte-defop-compiler-1 function byte-compile-function-form
)
3434 (byte-defop-compiler-1 - byte-compile-minus
)
3435 (byte-defop-compiler (/ byte-quo
) byte-compile-quo
)
3436 (byte-defop-compiler nconc
)
3438 (defun byte-compile-char-before (form)
3439 (cond ((= 2 (length form
))
3440 (byte-compile-form (list 'char-after
(if (numberp (nth 1 form
))
3442 `(1- ,(nth 1 form
))))))
3443 ((= 1 (length form
))
3444 (byte-compile-form '(char-after (1- (point)))))
3445 (t (byte-compile-subr-wrong-args form
"0-1"))))
3447 ;; backward-... ==> forward-... with negated argument.
3448 (defun byte-compile-backward-char (form)
3449 (cond ((= 2 (length form
))
3450 (byte-compile-form (list 'forward-char
(if (numberp (nth 1 form
))
3452 `(- ,(nth 1 form
))))))
3453 ((= 1 (length form
))
3454 (byte-compile-form '(forward-char -
1)))
3455 (t (byte-compile-subr-wrong-args form
"0-1"))))
3457 (defun byte-compile-backward-word (form)
3458 (cond ((= 2 (length form
))
3459 (byte-compile-form (list 'forward-word
(if (numberp (nth 1 form
))
3461 `(- ,(nth 1 form
))))))
3462 ((= 1 (length form
))
3463 (byte-compile-form '(forward-word -
1)))
3464 (t (byte-compile-subr-wrong-args form
"0-1"))))
3466 (defun byte-compile-list (form)
3467 (let ((count (length (cdr form
))))
3469 (byte-compile-constant nil
))
3471 (mapc 'byte-compile-form
(cdr form
))
3473 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
3475 (mapc 'byte-compile-form
(cdr form
))
3476 (byte-compile-out 'byte-listN count
))
3477 (t (byte-compile-normal-call form
)))))
3479 (defun byte-compile-concat (form)
3480 (let ((count (length (cdr form
))))
3481 (cond ((and (< 1 count
) (< count
5))
3482 (mapc 'byte-compile-form
(cdr form
))
3484 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
3486 ;; Concat of one arg is not a no-op if arg is not a string.
3488 (byte-compile-form ""))
3490 (mapc 'byte-compile-form
(cdr form
))
3491 (byte-compile-out 'byte-concatN count
))
3492 ((byte-compile-normal-call form
)))))
3494 (defun byte-compile-minus (form)
3495 (let ((len (length form
)))
3497 ((= 1 len
) (byte-compile-constant 0))
3499 (byte-compile-form (cadr form
))
3500 (byte-compile-out 'byte-negate
0))
3502 (byte-compile-form (nth 1 form
))
3503 (byte-compile-form (nth 2 form
))
3504 (byte-compile-out 'byte-diff
0))
3505 ;; Don't use binary operations for > 2 operands, as that may
3506 ;; cause overflow/truncation in float operations.
3507 (t (byte-compile-normal-call form
)))))
3509 (defun byte-compile-quo (form)
3510 (let ((len (length form
)))
3512 (byte-compile-subr-wrong-args form
"2 or more"))
3514 (byte-compile-two-args form
))
3516 ;; Don't use binary operations for > 2 operands, as that
3517 ;; may cause overflow/truncation in float operations.
3518 (byte-compile-normal-call form
)))))
3520 (defun byte-compile-nconc (form)
3521 (let ((len (length form
)))
3523 (byte-compile-constant nil
))
3525 ;; nconc of one arg is a noop, even if that arg isn't a list.
3526 (byte-compile-form (nth 1 form
)))
3528 (byte-compile-form (car (setq form
(cdr form
))))
3529 (while (setq form
(cdr form
))
3530 (byte-compile-form (car form
))
3531 (byte-compile-out 'byte-nconc
0))))))
3533 (defun byte-compile-fset (form)
3534 ;; warn about forms like (fset 'foo '(lambda () ...))
3535 ;; (where the lambda expression is non-trivial...)
3536 (let ((fn (nth 2 form
))
3538 (if (and (eq (car-safe fn
) 'quote
)
3539 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
3541 (setq body
(cdr (cdr fn
)))
3542 (if (stringp (car body
)) (setq body
(cdr body
)))
3543 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
3544 (if (and (consp (car body
))
3545 (not (eq 'byte-code
(car (car body
)))))
3547 "A quoted lambda form is the second argument of `fset'. This is probably
3548 not what you want, as that lambda cannot be compiled. Consider using
3549 the syntax (function (lambda (...) ...)) instead.")))))
3550 (byte-compile-two-args form
))
3552 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3553 ;; Otherwise it will be incompatible with the interpreter,
3554 ;; and (funcall (function foo)) will lose with autoloads.
3556 (defun byte-compile-function-form (form)
3557 (if (symbolp (nth 1 form
))
3558 (byte-compile-constant (nth 1 form
))
3559 (byte-compile-closure (nth 1 form
))))
3561 (defun byte-compile-indent-to (form)
3562 (let ((len (length form
)))
3564 (byte-compile-form (car (cdr form
)))
3565 (byte-compile-out 'byte-indent-to
0))
3567 ;; no opcode for 2-arg case.
3568 (byte-compile-normal-call form
))
3570 (byte-compile-subr-wrong-args form
"1-2")))))
3572 (defun byte-compile-insert (form)
3573 (cond ((null (cdr form
))
3574 (byte-compile-constant nil
))
3575 ((<= (length form
) 256)
3576 (mapc 'byte-compile-form
(cdr form
))
3577 (if (cdr (cdr form
))
3578 (byte-compile-out 'byte-insertN
(length (cdr form
)))
3579 (byte-compile-out 'byte-insert
0)))
3580 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
3581 (byte-compile-normal-call form
))
3582 ;; We can split it; there is no function call after inserting 1st arg.
3584 (while (setq form
(cdr form
))
3585 (byte-compile-form (car form
))
3586 (byte-compile-out 'byte-insert
0)
3588 (byte-compile-discard))))))
3591 (byte-defop-compiler-1 setq
)
3592 (byte-defop-compiler-1 setq-default
)
3593 (byte-defop-compiler-1 quote
)
3595 (defun byte-compile-setq (form)
3596 (let ((bytecomp-args (cdr form
)))
3598 (while bytecomp-args
3599 (byte-compile-form (car (cdr bytecomp-args
)))
3600 (or for-effect
(cdr (cdr bytecomp-args
))
3601 (byte-compile-out 'byte-dup
0))
3602 (byte-compile-variable-set (car bytecomp-args
))
3603 (setq bytecomp-args
(cdr (cdr bytecomp-args
))))
3604 ;; (setq), with no arguments.
3605 (byte-compile-form nil for-effect
))
3606 (setq for-effect nil
)))
3608 (defun byte-compile-setq-default (form)
3609 (setq form
(cdr form
))
3610 (if (> (length form
) 2)
3613 (push `(setq-default ,(pop form
) ,(pop form
)) setters
))
3614 (byte-compile-form (cons 'progn
(nreverse setters
))))
3615 (let ((var (car form
)))
3616 (and (or (not (symbolp var
))
3617 (byte-compile-const-symbol-p var t
))
3618 (byte-compile-warning-enabled-p 'constants
)
3620 "variable assignment to %s `%s'"
3621 (if (symbolp var
) "constant" "nonvariable")
3622 (prin1-to-string var
)))
3623 (byte-compile-normal-call `(set-default ',var
,@(cdr form
))))))
3625 (byte-defop-compiler-1 set-default
)
3626 (defun byte-compile-set-default (form)
3627 (let ((varexp (car-safe (cdr-safe form
))))
3628 (if (eq (car-safe varexp
) 'quote
)
3629 ;; If the varexp is constant, compile it as a setq-default
3630 ;; so we get more warnings.
3631 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp
))
3633 (byte-compile-normal-call form
))))
3635 (defun byte-compile-quote (form)
3636 (byte-compile-constant (car (cdr form
))))
3638 ;;; control structures
3640 (defun byte-compile-body (bytecomp-body &optional for-effect-arg
)
3641 (while (cdr bytecomp-body
)
3642 (byte-compile-form (car bytecomp-body
) t
)
3643 (setq bytecomp-body
(cdr bytecomp-body
)))
3644 (byte-compile-form (car bytecomp-body
) for-effect-arg
))
3646 (defsubst byte-compile-body-do-effect
(bytecomp-body)
3647 (byte-compile-body bytecomp-body for-effect
)
3648 (setq for-effect nil
))
3650 (defsubst byte-compile-form-do-effect
(form)
3651 (byte-compile-form form for-effect
)
3652 (setq for-effect nil
))
3654 (byte-defop-compiler-1 inline byte-compile-progn
)
3655 (byte-defop-compiler-1 progn
)
3656 (byte-defop-compiler-1 prog1
)
3657 (byte-defop-compiler-1 prog2
)
3658 (byte-defop-compiler-1 if
)
3659 (byte-defop-compiler-1 cond
)
3660 (byte-defop-compiler-1 and
)
3661 (byte-defop-compiler-1 or
)
3662 (byte-defop-compiler-1 while
)
3663 (byte-defop-compiler-1 funcall
)
3664 (byte-defop-compiler-1 let
)
3665 (byte-defop-compiler-1 let
* byte-compile-let
)
3667 (defun byte-compile-progn (form)
3668 (byte-compile-body-do-effect (cdr form
)))
3670 (defun byte-compile-prog1 (form)
3671 (byte-compile-form-do-effect (car (cdr form
)))
3672 (byte-compile-body (cdr (cdr form
)) t
))
3674 (defun byte-compile-prog2 (form)
3675 (byte-compile-form (nth 1 form
) t
)
3676 (byte-compile-form-do-effect (nth 2 form
))
3677 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3679 (defmacro byte-compile-goto-if
(cond discard tag
)
3682 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3683 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3686 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3687 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3688 (defun byte-compile-find-bound-condition (condition-param
3690 &optional only-if-not-present
)
3694 (if (memq (car-safe condition-param
) pred-list
)
3695 ;; The condition appears by itself.
3696 (list condition-param
)
3697 ;; If the condition is an `and', look for matches among the
3699 (when (eq 'and
(car-safe condition-param
))
3700 (cdr condition-param
)))))
3702 (dolist (crt cond-list
)
3703 (when (and (memq (car-safe crt
) pred-list
)
3704 (eq 'quote
(car-safe (setq nth-one
(nth 1 crt
))))
3705 ;; Ignore if the symbol is already on the unresolved
3707 (not (assq (nth 1 nth-one
) ; the relevant symbol
3708 only-if-not-present
)))
3709 (push (nth 1 (nth 1 crt
)) result
)))
3712 (defmacro byte-compile-maybe-guarded
(condition &rest body
)
3713 "Execute forms in BODY, potentially guarded by CONDITION.
3714 CONDITION is a variable whose value is a test in an `if' or `cond'.
3715 BODY is the code to compile in the first arm of the if or the body of
3716 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3717 or (boundp 'foo), the relevant warnings from BODY about foo's
3718 being undefined (or obsolete) will be suppressed.
3720 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3721 that suppresses all warnings during execution of BODY."
3722 (declare (indent 1) (debug t
))
3723 `(let* ((fbound-list (byte-compile-find-bound-condition
3724 ,condition
(list 'fboundp
)
3725 byte-compile-unresolved-functions
))
3726 (bound-list (byte-compile-find-bound-condition
3727 ,condition
(list 'boundp
'default-boundp
)))
3728 ;; Maybe add to the bound list.
3729 (byte-compile-bound-variables
3730 (append bound-list byte-compile-bound-variables
)))
3732 ;; If things not being bound at all is ok, so must them being obsolete.
3733 ;; Note that we add to the existing lists since Tramp (ab)uses
3735 (let ((byte-compile-not-obsolete-vars
3736 (append byte-compile-not-obsolete-vars bound-list
))
3737 (byte-compile-not-obsolete-funcs
3738 (append byte-compile-not-obsolete-funcs fbound-list
)))
3740 ;; Maybe remove the function symbol from the unresolved list.
3741 (dolist (fbound fbound-list
)
3743 (setq byte-compile-unresolved-functions
3744 (delq (assq fbound byte-compile-unresolved-functions
)
3745 byte-compile-unresolved-functions
)))))))
3747 (defun byte-compile-if (form)
3748 (byte-compile-form (car (cdr form
)))
3749 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3750 ;; and avoid warnings about the relevent symbols in the consequent.
3751 (let ((clause (nth 1 form
))
3752 (donetag (byte-compile-make-tag)))
3753 (if (null (nthcdr 3 form
))
3756 (byte-compile-goto-if nil for-effect donetag
)
3757 (byte-compile-maybe-guarded clause
3758 (byte-compile-form (nth 2 form
) for-effect
))
3759 (byte-compile-out-tag donetag
))
3760 (let ((elsetag (byte-compile-make-tag)))
3761 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3762 (byte-compile-maybe-guarded clause
3763 (byte-compile-form (nth 2 form
) for-effect
))
3764 (byte-compile-goto 'byte-goto donetag
)
3765 (byte-compile-out-tag elsetag
)
3766 (byte-compile-maybe-guarded (list 'not clause
)
3767 (byte-compile-body (cdr (cdr (cdr form
))) for-effect
))
3768 (byte-compile-out-tag donetag
))))
3769 (setq for-effect nil
))
3771 (defun byte-compile-cond (clauses)
3772 (let ((donetag (byte-compile-make-tag))
3774 (while (setq clauses
(cdr clauses
))
3775 (setq clause
(car clauses
))
3776 (cond ((or (eq (car clause
) t
)
3777 (and (eq (car-safe (car clause
)) 'quote
)
3778 (car-safe (cdr-safe (car clause
)))))
3779 ;; Unconditional clause
3780 (setq clause
(cons t clause
)
3783 (byte-compile-form (car clause
))
3784 (if (null (cdr clause
))
3785 ;; First clause is a singleton.
3786 (byte-compile-goto-if t for-effect donetag
)
3787 (setq nexttag
(byte-compile-make-tag))
3788 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3789 (byte-compile-maybe-guarded (car clause
)
3790 (byte-compile-body (cdr clause
) for-effect
))
3791 (byte-compile-goto 'byte-goto donetag
)
3792 (byte-compile-out-tag nexttag
)))))
3794 (let ((guard (car clause
)))
3795 (and (cdr clause
) (not (eq guard t
))
3796 (progn (byte-compile-form guard
)
3797 (byte-compile-goto-if nil for-effect donetag
)
3798 (setq clause
(cdr clause
))))
3799 (byte-compile-maybe-guarded guard
3800 (byte-compile-body-do-effect clause
)))
3801 (byte-compile-out-tag donetag
)))
3803 (defun byte-compile-and (form)
3804 (let ((failtag (byte-compile-make-tag))
3805 (bytecomp-args (cdr form
)))
3806 (if (null bytecomp-args
)
3807 (byte-compile-form-do-effect t
)
3808 (byte-compile-and-recursion bytecomp-args failtag
))))
3810 ;; Handle compilation of a nontrivial `and' call.
3811 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3812 (defun byte-compile-and-recursion (rest failtag
)
3815 (byte-compile-form (car rest
))
3816 (byte-compile-goto-if nil for-effect failtag
)
3817 (byte-compile-maybe-guarded (car rest
)
3818 (byte-compile-and-recursion (cdr rest
) failtag
)))
3819 (byte-compile-form-do-effect (car rest
))
3820 (byte-compile-out-tag failtag
)))
3822 (defun byte-compile-or (form)
3823 (let ((wintag (byte-compile-make-tag))
3824 (bytecomp-args (cdr form
)))
3825 (if (null bytecomp-args
)
3826 (byte-compile-form-do-effect nil
)
3827 (byte-compile-or-recursion bytecomp-args wintag
))))
3829 ;; Handle compilation of a nontrivial `or' call.
3830 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3831 (defun byte-compile-or-recursion (rest wintag
)
3834 (byte-compile-form (car rest
))
3835 (byte-compile-goto-if t for-effect wintag
)
3836 (byte-compile-maybe-guarded (list 'not
(car rest
))
3837 (byte-compile-or-recursion (cdr rest
) wintag
)))
3838 (byte-compile-form-do-effect (car rest
))
3839 (byte-compile-out-tag wintag
)))
3841 (defun byte-compile-while (form)
3842 (let ((endtag (byte-compile-make-tag))
3843 (looptag (byte-compile-make-tag)))
3844 (byte-compile-out-tag looptag
)
3845 (byte-compile-form (car (cdr form
)))
3846 (byte-compile-goto-if nil for-effect endtag
)
3847 (byte-compile-body (cdr (cdr form
)) t
)
3848 (byte-compile-goto 'byte-goto looptag
)
3849 (byte-compile-out-tag endtag
)
3850 (setq for-effect nil
)))
3852 (defun byte-compile-funcall (form)
3853 (mapc 'byte-compile-form
(cdr form
))
3854 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3859 (defun byte-compile-push-binding-init (clause)
3860 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
3861 Return the offset in the form (VAR . OFFSET)."
3862 (let* ((var (if (consp clause
) (car clause
) clause
)))
3863 ;; We record the stack position even of dynamic bindings and
3864 ;; variables in non-stack lexical environments; we'll put
3865 ;; them in the proper place below.
3866 (prog1 (cons var byte-compile-depth
)
3868 (byte-compile-form (cadr clause
))
3869 (byte-compile-push-constant nil
)))))
3871 (defun byte-compile-not-lexical-var-p (var)
3872 (or (not (symbolp var
))
3873 (special-variable-p var
)
3874 (memq var byte-compile-bound-variables
)
3878 (defun byte-compile-bind (var init-lexenv
)
3879 "Emit byte-codes to bind VAR and update `byte-compile-lexical-environment'.
3880 INIT-LEXENV should be a lexical-environment alist describing the
3881 positions of the init value that have been pushed on the stack.
3882 Return non-nil if the TOS value was popped."
3883 ;; The presence of lexical bindings mean that we may have to
3884 ;; juggle things on the stack, to move them to TOS for
3886 (cond ((not (byte-compile-not-lexical-var-p var
))
3887 ;; VAR is a simple stack-allocated lexical variable
3888 (push (assq var init-lexenv
)
3889 byte-compile-lexical-environment
)
3891 ((eq var
(caar init-lexenv
))
3892 ;; VAR is dynamic and is on the top of the
3893 ;; stack, so we can just bind it like usual
3894 (byte-compile-dynamic-variable-bind var
)
3897 ;; VAR is dynamic, but we have to get its
3898 ;; value out of the middle of the stack
3899 (let ((stack-pos (cdr (assq var init-lexenv
))))
3900 (byte-compile-stack-ref stack-pos
)
3901 (byte-compile-dynamic-variable-bind var
)
3902 ;; Now we have to store nil into its temporary
3903 ;; stack position to avoid problems with GC
3904 (byte-compile-push-constant nil
)
3905 (byte-compile-stack-set stack-pos
))
3908 (defun byte-compile-unbind (clauses init-lexenv
3909 &optional preserve-body-value
)
3910 "Emit byte-codes to unbind the variables bound by CLAUSES.
3911 CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3912 lexical-environment alist describing the positions of the init value that
3913 have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3914 then an additional value on the top of the stack, above any lexical binding
3915 slots, is preserved, so it will be on the top of the stack after all
3916 binding slots have been popped."
3917 ;; Unbind dynamic variables
3918 (let ((num-dynamic-bindings 0))
3919 (dolist (clause clauses
)
3920 (unless (assq (if (consp clause
) (car clause
) clause
)
3921 byte-compile-lexical-environment
)
3922 (setq num-dynamic-bindings
(1+ num-dynamic-bindings
))))
3923 (unless (zerop num-dynamic-bindings
)
3924 (byte-compile-out 'byte-unbind num-dynamic-bindings
)))
3925 ;; Pop lexical variables off the stack, possibly preserving the
3926 ;; return value of the body.
3928 ;; INIT-LEXENV contains all init values left on the stack
3929 (byte-compile-discard (length init-lexenv
) preserve-body-value
)))
3931 (defun byte-compile-let (form)
3932 "Generate code for the `let' form FORM."
3933 (let ((clauses (cadr form
))
3935 (when (eq (car form
) 'let
)
3936 ;; First compute the binding values in the old scope.
3937 (dolist (var clauses
)
3938 (push (byte-compile-push-binding-init var
) init-lexenv
)))
3940 (let ((byte-compile-bound-variables byte-compile-bound-variables
)
3941 (byte-compile-lexical-environment byte-compile-lexical-environment
))
3942 ;; Bind the variables.
3943 ;; For `let', do it in reverse order, because it makes no
3944 ;; semantic difference, but it is a lot more efficient since the
3945 ;; values are now in reverse order on the stack.
3946 (dolist (var (if (eq (car form
) 'let
) (reverse clauses
) clauses
))
3947 (unless (eq (car form
) 'let
)
3948 (push (byte-compile-push-binding-init var
) init-lexenv
))
3949 (let ((var (if (consp var
) (car var
) var
)))
3950 (cond ((null lexical-binding
)
3951 ;; If there are no lexical bindings, we can do things simply.
3952 (byte-compile-dynamic-variable-bind var
))
3953 ((byte-compile-bind var init-lexenv
)
3954 (pop init-lexenv
)))))
3956 (let ((init-stack-depth byte-compile-depth
))
3957 (byte-compile-body-do-effect (cdr (cdr form
)))
3958 ;; Unbind the variables.
3960 ;; Unbind both lexical and dynamic variables.
3962 (assert (or (eq byte-compile-depth init-stack-depth
)
3963 (eq byte-compile-depth
(1+ init-stack-depth
))))
3964 (byte-compile-unbind clauses init-lexenv
(> byte-compile-depth
3966 ;; Unbind dynamic variables.
3967 (byte-compile-out 'byte-unbind
(length clauses
)))))))
3971 (byte-defop-compiler-1 /= byte-compile-negated
)
3972 (byte-defop-compiler-1 atom byte-compile-negated
)
3973 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3975 (put '/= 'byte-compile-negated-op
'=)
3976 (put 'atom
'byte-compile-negated-op
'consp
)
3977 (put 'nlistp
'byte-compile-negated-op
'listp
)
3979 (defun byte-compile-negated (form)
3980 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3982 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3983 (defun byte-compile-negation-optimizer (form)
3984 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3985 (byte-compile-set-symbol-position (car form
))
3987 (cons (or (get (car form
) 'byte-compile-negated-op
)
3989 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3994 ;;; other tricky macro-like special-forms
3996 (byte-defop-compiler-1 catch
)
3997 (byte-defop-compiler-1 unwind-protect
)
3998 (byte-defop-compiler-1 condition-case
)
3999 (byte-defop-compiler-1 save-excursion
)
4000 (byte-defop-compiler-1 save-current-buffer
)
4001 (byte-defop-compiler-1 save-restriction
)
4002 (byte-defop-compiler-1 track-mouse
)
4004 (defun byte-compile-catch (form)
4005 (byte-compile-form (car (cdr form
)))
4008 (byte-compile-form `(list 'funcall
,f
)))
4010 (byte-compile-push-constant
4011 (byte-compile-top-level (cons 'progn body
) for-effect
))))
4012 (byte-compile-out 'byte-catch
0))
4014 (defun byte-compile-unwind-protect (form)
4017 (byte-compile-form `(list (list 'funcall
,f
))))
4019 (byte-compile-push-constant
4020 (byte-compile-top-level-body handlers t
))))
4021 (byte-compile-out 'byte-unwind-protect
0)
4022 (byte-compile-form-do-effect (car (cdr form
)))
4023 (byte-compile-out 'byte-unbind
1))
4025 (defun byte-compile-track-mouse (form)
4028 (`(,_
:fun-body
,f
) `(eval (list 'track-mouse
(list 'funcall
,f
))))
4029 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form
))))))))
4031 (defun byte-compile-condition-case (form)
4032 (let* ((var (nth 1 form
))
4033 (fun-bodies (eq var
:fun-body
))
4034 (byte-compile-bound-variables
4035 (if (and var
(not fun-bodies
))
4036 (cons var byte-compile-bound-variables
)
4037 byte-compile-bound-variables
)))
4038 (byte-compile-set-symbol-position 'condition-case
)
4039 (unless (symbolp var
)
4041 "`%s' is not a variable-name or nil (in condition-case)" var
))
4042 (if fun-bodies
(setq var
(make-symbol "err")))
4043 (byte-compile-push-constant var
)
4045 (byte-compile-form `(list 'funcall
,(nth 2 form
)))
4046 (byte-compile-push-constant
4047 (byte-compile-top-level (nth 2 form
) for-effect
)))
4048 (let ((compiled-clauses
4051 (let ((condition (car clause
)))
4052 (cond ((not (or (symbolp condition
)
4053 (and (listp condition
)
4055 (dolist (sym condition
)
4056 (if (not (symbolp sym
))
4060 "`%S' is not a condition name or list of such (in condition-case)"
4062 ;; (not (or (eq condition 't)
4063 ;; (and (stringp (get condition 'error-message))
4064 ;; (consp (get condition
4065 ;; 'error-conditions)))))
4066 ;; (byte-compile-warn
4067 ;; "`%s' is not a known condition name
4068 ;; (in condition-case)"
4072 `(list ',condition
(list 'funcall
,(cadr clause
) ',var
))
4074 (byte-compile-top-level-body
4075 (cdr clause
) for-effect
)))))
4076 (cdr (cdr (cdr form
))))))
4078 (byte-compile-form `(list ,@compiled-clauses
))
4079 (byte-compile-push-constant compiled-clauses
)))
4080 (byte-compile-out 'byte-condition-case
0)))
4083 (defun byte-compile-save-excursion (form)
4084 (if (and (eq 'set-buffer
(car-safe (car-safe (cdr form
))))
4085 (byte-compile-warning-enabled-p 'suspicious
))
4086 (byte-compile-warn "`save-excursion' defeated by `set-buffer'"))
4087 (byte-compile-out 'byte-save-excursion
0)
4088 (byte-compile-body-do-effect (cdr form
))
4089 (byte-compile-out 'byte-unbind
1))
4091 (defun byte-compile-save-restriction (form)
4092 (byte-compile-out 'byte-save-restriction
0)
4093 (byte-compile-body-do-effect (cdr form
))
4094 (byte-compile-out 'byte-unbind
1))
4096 (defun byte-compile-save-current-buffer (form)
4097 (byte-compile-out 'byte-save-current-buffer
0)
4098 (byte-compile-body-do-effect (cdr form
))
4099 (byte-compile-out 'byte-unbind
1))
4101 ;;; top-level forms elsewhere
4103 (byte-defop-compiler-1 defun
)
4104 (byte-defop-compiler-1 defmacro
)
4105 (byte-defop-compiler-1 defvar
)
4106 (byte-defop-compiler-1 defconst byte-compile-defvar
)
4107 (byte-defop-compiler-1 autoload
)
4108 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
4110 (defun byte-compile-defun (form)
4111 ;; This is not used for file-level defuns with doc strings.
4112 (if (symbolp (car form
))
4113 (byte-compile-set-symbol-position (car form
))
4114 (byte-compile-set-symbol-position 'defun
)
4115 (error "defun name must be a symbol, not %s" (car form
)))
4116 (let ((for-effect nil
))
4117 (byte-compile-push-constant 'defalias
)
4118 (byte-compile-push-constant (nth 1 form
))
4119 (byte-compile-closure (cdr (cdr form
)) t
))
4120 (byte-compile-out 'byte-call
2))
4122 (defun byte-compile-defmacro (form)
4123 ;; This is not used for file-level defmacros with doc strings.
4124 (byte-compile-body-do-effect
4125 (let ((decls (byte-compile-defmacro-declaration form
))
4126 (code (byte-compile-byte-code-maker
4127 (byte-compile-lambda (cdr (cdr form
)) t
))))
4128 `((defalias ',(nth 1 form
)
4129 ,(if (eq (car-safe code
) 'make-byte-code
)
4130 `(cons 'macro
,code
)
4131 `'(macro .
,(eval code
))))
4135 (defun byte-compile-defvar (form)
4136 ;; This is not used for file-level defvar/consts with doc strings.
4137 (when (and (symbolp (nth 1 form
))
4138 (not (string-match "[-*/:$]" (symbol-name (nth 1 form
))))
4139 (byte-compile-warning-enabled-p 'lexical
))
4140 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4142 (let ((fun (nth 0 form
))
4144 (value (nth 2 form
))
4145 (string (nth 3 form
)))
4146 (byte-compile-set-symbol-position fun
)
4147 (when (or (> (length form
) 4)
4148 (and (eq fun
'defconst
) (null (cddr form
))))
4149 (let ((ncall (length (cdr form
))))
4151 "`%s' called with %d argument%s, but %s %s"
4153 (if (= 1 ncall
) "" "s")
4154 (if (< ncall
2) "requires" "accepts only")
4156 (push var byte-compile-bound-variables
)
4157 (if (eq fun
'defconst
)
4158 (push var byte-compile-const-variables
))
4159 (byte-compile-body-do-effect
4161 ;; Put the defined variable in this library's load-history entry
4162 ;; just as a real defvar would, but only in top-level forms.
4163 (when (and (cddr form
) (null byte-compile-current-form
))
4164 `(setq current-load-list
(cons ',var current-load-list
)))
4165 (when (> (length form
) 3)
4166 (when (and string
(not (stringp string
)))
4167 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4169 `(put ',var
'variable-documentation
,string
))
4170 (if (cddr form
) ; `value' provided
4171 (let ((byte-compile-not-obsolete-vars (list var
)))
4172 (if (eq fun
'defconst
)
4173 ;; `defconst' sets `var' unconditionally.
4174 (let ((tmp (make-symbol "defconst-tmp-var")))
4175 `(funcall '(lambda (,tmp
) (defconst ,var
,tmp
))
4177 ;; `defvar' sets `var' only when unbound.
4178 `(if (not (default-boundp ',var
)) (setq-default ,var
,value
))))
4179 (when (eq fun
'defconst
)
4180 ;; This will signal an appropriate error at runtime.
4184 (defun byte-compile-autoload (form)
4185 (byte-compile-set-symbol-position 'autoload
)
4186 (and (byte-compile-constp (nth 1 form
))
4187 (byte-compile-constp (nth 5 form
))
4188 (eval (nth 5 form
)) ; macro-p
4189 (not (fboundp (eval (nth 1 form
))))
4191 "The compiler ignores `autoload' except at top level. You should
4192 probably put the autoload of the macro `%s' at top-level."
4193 (eval (nth 1 form
))))
4194 (byte-compile-normal-call form
))
4196 ;; Lambdas in valid places are handled as special cases by various code.
4197 ;; The ones that remain are errors.
4198 (defun byte-compile-lambda-form (_form)
4199 (byte-compile-set-symbol-position 'lambda
)
4200 (error "`lambda' used as function name is invalid"))
4202 ;; Compile normally, but deal with warnings for the function being defined.
4203 (put 'defalias
'byte-hunk-handler
'byte-compile-file-form-defalias
)
4204 (defun byte-compile-file-form-defalias (form)
4205 (if (and (consp (cdr form
)) (consp (nth 1 form
))
4206 (eq (car (nth 1 form
)) 'quote
)
4207 (consp (cdr (nth 1 form
)))
4208 (symbolp (nth 1 (nth 1 form
))))
4210 (and (consp (nthcdr 2 form
))
4211 (consp (nth 2 form
))
4212 (eq (car (nth 2 form
)) 'quote
)
4213 (consp (cdr (nth 2 form
)))
4214 (symbolp (nth 1 (nth 2 form
))))))
4215 (byte-compile-defalias-warn (nth 1 (nth 1 form
)))
4216 (push (cons (nth 1 (nth 1 form
))
4217 (if constant
(nth 1 (nth 2 form
)) t
))
4218 byte-compile-function-environment
)))
4219 ;; We used to just do: (byte-compile-normal-call form)
4220 ;; But it turns out that this fails to optimize the code.
4221 ;; So instead we now do the same as what other byte-hunk-handlers do,
4222 ;; which is to call back byte-compile-file-form and then return nil.
4223 ;; Except that we can't just call byte-compile-file-form since it would
4224 ;; call us right back.
4225 (byte-compile-keep-pending form
)
4226 ;; Return nil so the form is not output twice.
4229 ;; Turn off warnings about prior calls to the function being defalias'd.
4230 ;; This could be smarter and compare those calls with
4231 ;; the function it is being aliased to.
4232 (defun byte-compile-defalias-warn (new)
4233 (let ((calls (assq new byte-compile-unresolved-functions
)))
4235 (setq byte-compile-unresolved-functions
4236 (delq calls byte-compile-unresolved-functions
)))))
4238 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings
)
4239 (defun byte-compile-no-warnings (form)
4240 (let (byte-compile-warnings)
4241 (byte-compile-form (cons 'progn
(cdr form
)))))
4243 ;; Warn about misuses of make-variable-buffer-local.
4244 (byte-defop-compiler-1 make-variable-buffer-local
4245 byte-compile-make-variable-buffer-local
)
4246 (defun byte-compile-make-variable-buffer-local (form)
4247 (if (and (eq (car-safe (car-safe (cdr-safe form
))) 'quote
)
4248 (byte-compile-warning-enabled-p 'make-local
))
4250 "`make-variable-buffer-local' should be called at toplevel"))
4251 (byte-compile-normal-call form
))
4252 (put 'make-variable-buffer-local
4253 'byte-hunk-handler
'byte-compile-form-make-variable-buffer-local
)
4254 (defun byte-compile-form-make-variable-buffer-local (form)
4255 (byte-compile-keep-pending form
'byte-compile-normal-call
))
4260 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4261 ;; optimization to have the 'TAG as a part of the tag.
4262 ;; Tags will be (TAG . (tag-number . stack-depth)).
4263 (defun byte-compile-make-tag ()
4264 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
4267 (defun byte-compile-out-tag (tag)
4268 (setq byte-compile-output
(cons tag byte-compile-output
))
4271 ;; ## remove this someday
4272 (and byte-compile-depth
4273 (not (= (cdr (cdr tag
)) byte-compile-depth
))
4274 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
4275 (setq byte-compile-depth
(cdr (cdr tag
))))
4276 (setcdr (cdr tag
) byte-compile-depth
)))
4278 (defun byte-compile-goto (opcode tag
)
4279 (push (cons opcode tag
) byte-compile-output
)
4280 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
4281 (1- byte-compile-depth
)
4282 byte-compile-depth
))
4283 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
4284 (1- byte-compile-depth
))))
4286 (defun byte-compile-stack-adjustment (op operand
)
4287 "Return the amount by which an operation adjusts the stack.
4288 OP and OPERAND are as passed to `byte-compile-out'."
4289 (if (memq op
'(byte-call byte-discardN byte-discardN-preserve-tos
))
4290 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4291 ;; elements, and the push the result, for a total of -OPERAND.
4292 ;; For discardN*, of course, we just pop OPERAND elements.
4294 (or (aref byte-stack
+-info
(symbol-value op
))
4295 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4296 ;; that take OPERAND values off the stack and push a result, for
4297 ;; a total of 1 - OPERAND
4300 (defun byte-compile-out (op &optional operand
)
4301 (push (cons op operand
) byte-compile-output
)
4302 (if (eq op
'byte-return
)
4303 ;; This is actually an unnecessary case, because there should be no
4304 ;; more ops behind byte-return.
4305 (setq byte-compile-depth nil
)
4306 (setq byte-compile-depth
4307 (+ byte-compile-depth
(byte-compile-stack-adjustment op operand
)))
4308 (setq byte-compile-maxdepth
(max byte-compile-depth byte-compile-maxdepth
))
4309 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4312 (defun byte-compile-delay-out (&optional stack-used stack-adjust
)
4313 "Add a placeholder to the output, which can be used to later add byte-codes.
4314 Return a position tag that can be passed to `byte-compile-delayed-out'
4315 to add the delayed byte-codes. STACK-USED is the maximum amount of
4316 stack-spaced used by the delayed byte-codes (defaulting to 0), and
4317 STACK-ADJUST is the amount by which the later-added code will adjust the
4318 stack (defaulting to 0); the byte-codes added later _must_ adjust the
4319 stack by this amount! If STACK-ADJUST is 0, then it's not necessary to
4320 actually add anything later; the effect as if nothing was added at all."
4321 ;; We just add a no-op to `byte-compile-output', and return a pointer to
4322 ;; the tail of the list; `byte-compile-delayed-out' uses list surgery
4323 ;; to add the byte-codes.
4325 (setq byte-compile-maxdepth
4326 (max byte-compile-depth
(+ byte-compile-depth
(or stack-used
0)))))
4328 (setq byte-compile-depth
4329 (+ byte-compile-depth stack-adjust
)))
4330 (push (cons nil
(or stack-adjust
0)) byte-compile-output
))
4332 (defun byte-compile-delayed-out (position op
&optional operand
)
4333 "Add at POSITION the byte-operation OP, with optional numeric arg OPERAND.
4334 POSITION should a position returned by `byte-compile-delay-out'.
4335 Return a new position, which can be used to add further operations."
4336 (unless (null (caar position
))
4337 (error "Bad POSITION arg to `byte-compile-delayed-out'"))
4338 ;; This is kind of like `byte-compile-out', but we splice into the list
4339 ;; where POSITION is. We don't bother updating `byte-compile-maxdepth'
4340 ;; because that was already done by `byte-compile-delay-out', but we do
4341 ;; update the relative operand stored in the no-op marker currently at
4342 ;; POSITION; since we insert before that marker, this means that if the
4343 ;; caller doesn't insert a sequence of byte-codes that matches the expected
4344 ;; operand passed to `byte-compile-delay-out', then the nop will still have
4345 ;; a non-zero operand when `byte-compile-lapcode' is called, which will
4346 ;; cause an error to be signaled.
4348 ;; Adjust the cumulative stack-adjustment stored in the cdr of the no-op
4349 (setcdr (car position
)
4350 (- (cdar position
) (byte-compile-stack-adjustment op operand
)))
4351 ;; Add the new operation onto the list tail at POSITION
4352 (setcdr position
(cons (cons op operand
) (cdr position
)))
4358 (defun byte-compile-annotate-call-tree (form)
4360 ;; annotate the current call
4361 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
4362 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
4364 (cons byte-compile-current-form
(nth 1 entry
))))
4365 (setq byte-compile-call-tree
4366 (cons (list (car form
) (list byte-compile-current-form
) nil
)
4367 byte-compile-call-tree
)))
4368 ;; annotate the current function
4369 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
4370 (or (memq (car form
) (nth 2 entry
)) ;called
4371 (setcar (cdr (cdr entry
))
4372 (cons (car form
) (nth 2 entry
))))
4373 (setq byte-compile-call-tree
4374 (cons (list byte-compile-current-form nil
(list (car form
)))
4375 byte-compile-call-tree
)))
4378 ;; Renamed from byte-compile-report-call-tree
4379 ;; to avoid interfering with completion of byte-compile-file.
4381 (defun display-call-tree (&optional filename
)
4382 "Display a call graph of a specified file.
4383 This lists which functions have been called, what functions called
4384 them, and what functions they call. The list includes all functions
4385 whose definitions have been compiled in this Emacs session, as well as
4386 all functions called by those functions.
4388 The call graph does not include macros, inline functions, or
4389 primitives that the byte-code interpreter knows about directly \(eq,
4392 The call tree also lists those functions which are not known to be called
4393 \(that is, to which no calls have been compiled\), and which cannot be
4394 invoked interactively."
4396 (message "Generating call tree...")
4397 (with-output-to-temp-buffer "*Call-Tree*"
4398 (set-buffer "*Call-Tree*")
4400 (message "Generating call tree... (sorting on %s)"
4401 byte-compile-call-tree-sort
)
4402 (insert "Call tree for "
4403 (cond ((null byte-compile-current-file
) (or filename
"???"))
4404 ((stringp byte-compile-current-file
)
4405 byte-compile-current-file
)
4406 (t (buffer-name byte-compile-current-file
)))
4408 (prin1-to-string byte-compile-call-tree-sort
)
4410 (if byte-compile-call-tree-sort
4411 (setq byte-compile-call-tree
4412 (sort byte-compile-call-tree
4413 (cond ((eq byte-compile-call-tree-sort
'callers
)
4414 (function (lambda (x y
) (< (length (nth 1 x
))
4415 (length (nth 1 y
))))))
4416 ((eq byte-compile-call-tree-sort
'calls
)
4417 (function (lambda (x y
) (< (length (nth 2 x
))
4418 (length (nth 2 y
))))))
4419 ((eq byte-compile-call-tree-sort
'calls
+callers
)
4420 (function (lambda (x y
) (< (+ (length (nth 1 x
))
4422 (+ (length (nth 1 y
))
4423 (length (nth 2 y
)))))))
4424 ((eq byte-compile-call-tree-sort
'name
)
4425 (function (lambda (x y
) (string< (car x
)
4427 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4428 byte-compile-call-tree-sort
))))))
4429 (message "Generating call tree...")
4430 (let ((rest byte-compile-call-tree
)
4431 (b (current-buffer))
4435 (prin1 (car (car rest
)) b
)
4436 (setq callers
(nth 1 (car rest
))
4437 calls
(nth 2 (car rest
)))
4439 (cond ((not (fboundp (setq f
(car (car rest
)))))
4441 " <top level>";; shouldn't insert nil then, actually -sk
4443 ((subrp (setq f
(symbol-function f
)))
4446 (format " ==> %s" f
))
4447 ((byte-code-function-p f
)
4448 "<compiled function>")
4450 "<malformed function>")
4451 ((eq 'macro
(car f
))
4452 (if (or (byte-code-function-p (cdr f
))
4453 (assq 'byte-code
(cdr (cdr (cdr f
)))))
4456 ((assq 'byte-code
(cdr (cdr f
)))
4457 "<compiled lambda>")
4458 ((eq 'lambda
(car f
))
4461 (format " (%d callers + %d calls = %d)"
4462 ;; Does the optimizer eliminate common subexpressions?-sk
4465 (+ (length callers
) (length calls
)))
4469 (insert " called by:\n")
4471 (insert " " (if (car callers
)
4472 (mapconcat 'symbol-name callers
", ")
4474 (let ((fill-prefix " "))
4475 (fill-region-as-paragraph p
(point)))
4476 (unless (= 0 (current-column))
4480 (insert " calls:\n")
4482 (insert " " (mapconcat 'symbol-name calls
", "))
4483 (let ((fill-prefix " "))
4484 (fill-region-as-paragraph p
(point)))
4485 (unless (= 0 (current-column))
4487 (setq rest
(cdr rest
)))
4489 (message "Generating call tree...(finding uncalled functions...)")
4490 (setq rest byte-compile-call-tree
)
4493 (or (nth 1 (car rest
))
4494 (null (setq f
(caar rest
)))
4496 (setq def
(byte-compile-fdefinition f t
))
4497 (and (eq (car-safe def
) 'macro
)
4498 (eq (car-safe (cdr-safe def
)) 'lambda
)
4499 (setq def
(cdr def
)))
4502 (setq def
(byte-compile-fdefinition f nil
))
4503 (and (eq (car-safe def
) 'macro
)
4504 (eq (car-safe (cdr-safe def
)) 'lambda
)
4505 (setq def
(cdr def
)))
4507 (setq uncalled
(cons f uncalled
)))
4508 (setq rest
(cdr rest
)))
4510 (let ((fill-prefix " "))
4511 (insert "Noninteractive functions not known to be called:\n ")
4513 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
4514 (fill-region-as-paragraph p
(point))))))
4515 (message "Generating call tree...done.")))
4519 (defun batch-byte-compile-if-not-done ()
4520 "Like `byte-compile-file' but doesn't recompile if already up to date.
4521 Use this from the command line, with `-batch';
4522 it won't work in an interactive Emacs."
4523 (batch-byte-compile t
))
4525 ;;; by crl@newton.purdue.edu
4526 ;;; Only works noninteractively.
4528 (defun batch-byte-compile (&optional noforce
)
4529 "Run `byte-compile-file' on the files remaining on the command line.
4530 Use this from the command line, with `-batch';
4531 it won't work in an interactive Emacs.
4532 Each file is processed even if an error occurred previously.
4533 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4534 If NOFORCE is non-nil, don't recompile a file that seems to be
4535 already up-to-date."
4536 ;; command-line-args-left is what is left of the command line (from startup.el)
4537 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4538 (if (not noninteractive
)
4539 (error "`batch-byte-compile' is to be used only with -batch"))
4540 (let ((bytecomp-error nil
))
4541 (while command-line-args-left
4542 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
4543 ;; Directory as argument.
4544 (let ((bytecomp-files (directory-files (car command-line-args-left
)))
4545 bytecomp-source bytecomp-dest
)
4546 (dolist (bytecomp-file bytecomp-files
)
4547 (if (and (string-match emacs-lisp-file-regexp bytecomp-file
)
4548 (not (auto-save-file-name-p bytecomp-file
))
4549 (setq bytecomp-source
4550 (expand-file-name bytecomp-file
4551 (car command-line-args-left
)))
4552 (setq bytecomp-dest
(byte-compile-dest-file
4554 (file-exists-p bytecomp-dest
)
4555 (file-newer-than-file-p bytecomp-source bytecomp-dest
))
4556 (if (null (batch-byte-compile-file bytecomp-source
))
4557 (setq bytecomp-error t
)))))
4558 ;; Specific file argument
4559 (if (or (not noforce
)
4560 (let* ((bytecomp-source (car command-line-args-left
))
4561 (bytecomp-dest (byte-compile-dest-file bytecomp-source
)))
4562 (or (not (file-exists-p bytecomp-dest
))
4563 (file-newer-than-file-p bytecomp-source bytecomp-dest
))))
4564 (if (null (batch-byte-compile-file (car command-line-args-left
)))
4565 (setq bytecomp-error t
))))
4566 (setq command-line-args-left
(cdr command-line-args-left
)))
4567 (kill-emacs (if bytecomp-error
1 0))))
4569 (defun batch-byte-compile-file (bytecomp-file)
4571 (byte-compile-file bytecomp-file
)
4573 (byte-compile-file bytecomp-file
)
4575 (message (if (cdr err
)
4576 ">>Error occurred processing %s: %s (%s)"
4577 ">>Error occurred processing %s: %s")
4579 (get (car err
) 'error-message
)
4580 (prin1-to-string (cdr err
)))
4581 (let ((bytecomp-destfile (byte-compile-dest-file bytecomp-file
)))
4582 (if (file-exists-p bytecomp-destfile
)
4583 (delete-file bytecomp-destfile
)))
4586 (message (if (cdr err
)
4587 ">>Error occurred processing %s: %s (%s)"
4588 ">>Error occurred processing %s: %s")
4590 (get (car err
) 'error-message
)
4591 (prin1-to-string (cdr err
)))
4594 (defun byte-compile-refresh-preloaded ()
4595 "Reload any Lisp file that was changed since Emacs was dumped.
4597 (let* ((argv0 (car command-line-args
))
4598 (emacs-file (executable-find argv0
)))
4599 (if (not (and emacs-file
(file-executable-p emacs-file
)))
4600 (message "Can't find %s to refresh preloaded Lisp files" argv0
)
4601 (dolist (f (reverse load-history
))
4603 (if (string-match "elc\\'" f
) (setq f
(substring f
0 -
1)))
4604 (when (and (file-readable-p f
)
4605 (file-newer-than-file-p f emacs-file
)
4606 ;; Don't reload the source version of the files below
4607 ;; because that causes subsequent byte-compilation to
4608 ;; be a lot slower and need a higher max-lisp-eval-depth,
4609 ;; so it can cause recompilation to fail.
4610 (not (member (file-name-nondirectory f
)
4611 '("pcase.el" "bytecomp.el" "macroexp.el"
4612 "cconv.el" "byte-opt.el"))))
4613 (message "Reloading stale %s" (file-name-nondirectory f
))
4615 (load f
'noerror nil
'nosuffix
)
4616 ;; Probably shouldn't happen, but in case of an error, it seems
4617 ;; at least as useful to ignore it as it is to stop compilation.
4621 (defun batch-byte-recompile-directory (&optional arg
)
4622 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4623 Must be used only with `-batch', and kills Emacs on completion.
4624 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4626 Optional argument ARG is passed as second argument ARG to
4627 `byte-recompile-directory'; see there for its possible values
4628 and corresponding effects."
4629 ;; command-line-args-left is what is left of the command line (startup.el)
4630 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4631 (if (not noninteractive
)
4632 (error "batch-byte-recompile-directory is to be used only with -batch"))
4633 (or command-line-args-left
4634 (setq command-line-args-left
'(".")))
4635 (while command-line-args-left
4636 (byte-recompile-directory (car command-line-args-left
) arg
)
4637 (setq command-line-args-left
(cdr command-line-args-left
)))
4640 (provide 'byte-compile
)
4644 ;;; report metering (see the hacks in bytecode.c)
4646 (defvar byte-code-meter
)
4647 (defun byte-compile-report-ops ()
4648 (or (boundp 'byte-metering-on
)
4649 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4650 (with-output-to-temp-buffer "*Meter*"
4651 (set-buffer "*Meter*")
4652 (let ((i 0) n op off
)
4654 (setq n
(aref (aref byte-code-meter
0) i
)
4656 (if t
;(not (zerop n))
4660 (cond ((< op byte-nth
)
4661 (setq off
(logand op
7))
4662 (setq op
(logand op
248)))
4663 ((>= op byte-constant
)
4664 (setq off
(- op byte-constant
)
4666 (setq op
(aref byte-code-vector op
))
4667 (insert (format "%-4d" i
))
4668 (insert (symbol-name op
))
4669 (if off
(insert " [" (int-to-string off
) "]"))
4671 (insert (int-to-string n
) "\n")))
4674 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4675 ;; itself, compile some of its most used recursive functions (at load time).
4678 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
4679 (assq 'byte-code
(symbol-function 'byte-compile-form
))
4680 (let ((byte-optimize nil
) ; do it fast
4681 (byte-compile-warnings nil
))
4683 (or noninteractive
(message "compiling %s..." x
))
4685 (or noninteractive
(message "compiling %s...done" x
)))
4686 '(byte-compile-normal-call
4689 ;; Inserted some more than necessary, to speed it up.
4690 byte-compile-top-level
4691 byte-compile-out-toplevel
4692 byte-compile-constant
4693 byte-compile-variable-ref
))))
4696 (run-hooks 'bytecomp-load-hook
)
4698 ;;; bytecomp.el ends here