1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
31 ;; of p-code (`lapcode') which takes up less space and can be interpreted
32 ;; faster. [`LAP' == `Lisp Assembly Program'.]
33 ;; The user entry points are byte-compile-file and byte-recompile-directory.
37 ;; ========================================================================
39 ;; byte-recompile-directory, byte-compile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables:
73 ;; byte-compile-verbose Whether to report the function currently being
74 ;; compiled in the echo area;
75 ;; byte-optimize Whether to do optimizations; this may be
76 ;; t, nil, 'source, or 'byte;
77 ;; byte-optimize-log Whether to report (in excruciating detail)
78 ;; exactly which optimizations have been made.
79 ;; This may be t, nil, 'source, or 'byte;
80 ;; byte-compile-error-on-warn Whether to stop compilation when a warning is
82 ;; byte-compile-delete-errors Whether the optimizer may delete calls or
83 ;; variable references that are side-effect-free
84 ;; except that they may return an error.
85 ;; byte-compile-generate-call-tree Whether to generate a histogram of
86 ;; function calls. This can be useful for
87 ;; finding unused functions, as well as simple
88 ;; performance metering.
89 ;; byte-compile-warnings List of warnings to issue, or t. May contain
90 ;; `free-vars' (references to variables not in the
91 ;; current lexical scope)
92 ;; `unresolved' (calls to unknown functions)
93 ;; `callargs' (lambda calls with args that don't
94 ;; match the lambda's definition)
95 ;; `redefine' (function cell redefined from
96 ;; a macro to a lambda or vice versa,
97 ;; or redefined to take other args)
98 ;; `obsolete' (obsolete variables and functions)
99 ;; `noruntime' (calls to functions only defined
100 ;; within `eval-when-compile')
101 ;; `cl-warnings' (calls to CL functions)
102 ;; `interactive-only' (calls to commands that are
103 ;; not good to call from Lisp)
104 ;; byte-compile-compatibility Whether the compiler should
105 ;; generate .elc files which can be loaded into
107 ;; emacs-lisp-file-regexp Regexp for the extension of source-files;
108 ;; see also the function byte-compile-dest-file.
112 ;; o The form `defsubst' is just like `defun', except that the function
113 ;; generated will be open-coded in compiled code which uses it. This
114 ;; means that no function call will be generated, it will simply be
115 ;; spliced in. Lisp functions calls are very slow, so this can be a
118 ;; You can generally accomplish the same thing with `defmacro', but in
119 ;; that case, the defined procedure can't be used as an argument to
122 ;; o You can also open-code one particular call to a function without
123 ;; open-coding all calls. Use the 'inline' form to do this, like so:
125 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
127 ;; (inline ;; `foo' and `baz' will be
128 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
131 ;; o It is possible to open-code a function in the same file it is defined
132 ;; in without having to load that file before compiling it. The
133 ;; byte-compiler has been modified to remember function definitions in
134 ;; the compilation environment in the same way that it remembers macro
137 ;; o Forms like ((lambda ...) ...) are open-coded.
139 ;; o The form `eval-when-compile' is like progn, except that the body
140 ;; is evaluated at compile-time. When it appears at top-level, this
141 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
142 ;; When it does not appear at top-level, it is similar to the
143 ;; Common Lisp #. reader macro (but not in interpreted code).
145 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
146 ;; the whole form is evalled both at compile-time and at run-time.
148 ;; o The command compile-defun is analogous to eval-defun.
150 ;; o If you run byte-compile-file on a filename which is visited in a
151 ;; buffer, and that buffer is modified, you are asked whether you want
152 ;; to save the buffer before compiling.
154 ;; o byte-compiled files now start with the string `;ELC'.
155 ;; Some versions of `file' can be customized to recognize that.
159 (or (fboundp 'defsubst)
160 ;; This really ought to be loaded already!
163 ;; The feature of compiling in a specific target Emacs version
164 ;; has been turned off because compile time options are a bad idea.
165 (defmacro byte-compile-single-version () nil)
166 (defmacro byte-compile-version-cond (cond) cond)
168 ;; The crud you see scattered through this file of the form
169 ;; (or (and (boundp 'epoch::version) epoch::version)
170 ;; (string-lessp emacs-version "19"))
171 ;; is because the Epoch folks couldn't be bothered to follow the
172 ;; normal emacs version numbering convention.
174 ;; (if (byte-compile-version-cond
175 ;; (or (and (boundp 'epoch::version) epoch::version)
176 ;; (string-lessp emacs-version "19")))
178 ;; ;; emacs-18 compatibility.
179 ;; (defvar baud-rate (baud-rate)) ;Define baud-rate if it's undefined
181 ;; (if (byte-compile-single-version)
182 ;; (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil)
183 ;; (defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil))
185 ;; (or (and (fboundp 'member)
186 ;; ;; avoid using someone else's possibly bogus definition of this.
187 ;; (subrp (symbol-function 'member)))
188 ;; (defun member (elt list)
189 ;; "like memq, but uses equal instead of eq. In v19, this is a subr."
190 ;; (while (and list (not (equal elt (car list))))
191 ;; (setq list (cdr list)))
195 (defgroup bytecomp nil
196 "Emacs Lisp byte-compiler."
199 (defcustom emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
200 "\\.EL\\(;[0-9]+\\)?$"
202 "*Regexp which matches Emacs Lisp source files.
203 You may want to redefine the function `byte-compile-dest-file'
204 if you change this variable."
208 ;; This enables file name handlers such as jka-compr
209 ;; to remove parts of the file name that should not be copied
210 ;; through to the output file name.
211 (defun byte-compiler-base-file-name (filename)
212 (let ((handler (find-file-name-handler filename
213 'byte-compiler-base-file-name)))
215 (funcall handler 'byte-compiler-base-file-name filename)
218 (or (fboundp 'byte-compile-dest-file)
219 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
220 ;; so only define it if it is undefined.
221 (defun byte-compile-dest-file (filename)
222 "Convert an Emacs Lisp source file name to a compiled file name."
223 (setq filename (byte-compiler-base-file-name filename))
224 (setq filename (file-name-sans-versions filename))
225 (cond ((eq system-type 'vax-vms)
226 (concat (substring filename 0 (string-match ";" filename)) "c"))
227 ((string-match emacs-lisp-file-regexp filename)
228 (concat (substring filename 0 (match-beginning 0)) ".elc"))
229 (t (concat filename ".elc")))))
231 ;; This can be the 'byte-compile property of any symbol.
232 (autoload 'byte-compile-inline-expand "byte-opt")
234 ;; This is the entrypoint to the lapcode optimizer pass1.
235 (autoload 'byte-optimize-form "byte-opt")
236 ;; This is the entrypoint to the lapcode optimizer pass2.
237 (autoload 'byte-optimize-lapcode "byte-opt")
238 (autoload 'byte-compile-unfold-lambda "byte-opt")
240 ;; This is the entry point to the decompiler, which is used by the
241 ;; disassembler. The disassembler just requires 'byte-compile, but
242 ;; that doesn't define this function, so this seems to be a reasonable
244 (autoload 'byte-decompile-bytecode "byte-opt")
246 (defcustom byte-compile-verbose
247 (and (not noninteractive) (> baud-rate search-slow-speed))
248 "*Non-nil means print messages describing progress of byte-compiler."
252 (defcustom byte-compile-compatibility nil
253 "*Non-nil means generate output that can run in Emacs 18.
254 This only means that it can run in principle, if it doesn't require
255 facilities that have been added more recently."
259 ;; (defvar byte-compile-generate-emacs19-bytecodes
260 ;; (not (or (and (boundp 'epoch::version) epoch::version)
261 ;; (string-lessp emacs-version "19")))
262 ;; "*If this is true, then the byte-compiler will generate bytecode which
263 ;; makes use of byte-ops which are present only in Emacs 19. Code generated
264 ;; this way can never be run in Emacs 18, and may even cause it to crash.")
266 (defcustom byte-optimize t
267 "*Enables optimization in the byte compiler.
268 nil means don't do any optimization.
269 t means do all optimizations.
270 `source' means do source-level optimizations only.
271 `byte' means do code-level optimizations only."
273 :type '(choice (const :tag "none" nil)
275 (const :tag "source-level" source)
276 (const :tag "byte-level" byte)))
278 (defcustom byte-compile-delete-errors nil
279 "*If non-nil, the optimizer may delete forms that may signal an error.
280 This includes variable references and calls to functions such as `car'."
284 (defvar byte-compile-dynamic nil
285 "If non-nil, compile function bodies so they load lazily.
286 They are hidden in comments in the compiled file,
287 and each one is brought into core when the
290 To enable this option, make it a file-local variable
291 in the source file you want it to apply to.
292 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
294 When this option is true, if you load the compiled file and then move it,
295 the functions you loaded will not be able to run.")
297 (defcustom byte-compile-dynamic-docstrings t
298 "*If non-nil, compile doc strings for lazy access.
299 We bury the doc strings of functions and variables
300 inside comments in the file, and bring them into core only when they
303 When this option is true, if you load the compiled file and then move it,
304 you won't be able to find the documentation of anything in that file.
306 To disable this option for a certain file, make it a file-local variable
307 in the source file. For example, add this to the first line:
308 -*-byte-compile-dynamic-docstrings:nil;-*-
309 You can also set the variable globally.
311 This option is enabled by default because it reduces Emacs memory usage."
315 (defcustom byte-optimize-log nil
316 "*If true, the byte-compiler will log its optimizations into *Compile-Log*.
317 If this is 'source, then only source-level optimizations will be logged.
318 If it is 'byte, then only byte-level optimizations will be logged."
320 :type '(choice (const :tag "none" nil)
322 (const :tag "source-level" source)
323 (const :tag "byte-level" byte)))
325 (defcustom byte-compile-error-on-warn nil
326 "*If true, the byte-compiler reports warnings with `error'."
330 (defconst byte-compile-warning-types
331 '(redefine callargs free-vars unresolved
332 obsolete noruntime cl-functions interactive-only)
333 "The list of warning types used when `byte-compile-warnings' is t.")
334 (defcustom byte-compile-warnings t
335 "*List of warnings that the byte-compiler should issue (t for all).
337 Elements of the list may be be:
339 free-vars references to variables not in the current lexical scope.
340 unresolved calls to unknown functions.
341 callargs function calls with args that don't match the definition.
342 redefine function name redefined from a macro to ordinary function or vice
343 versa, or redefined to take a different number of arguments.
344 obsolete obsolete variables and functions.
345 noruntime functions that may not be defined at runtime (typically
346 defined only under `eval-when-compile').
347 cl-functions calls to runtime functions from the CL package (as
348 distinguished from macros and aliases).
350 commands that normally shouldn't be called from Lisp code."
352 :type `(choice (const :tag "All" t)
353 (set :menu-tag "Some"
354 (const free-vars) (const unresolved)
355 (const callargs) (const redefine)
356 (const obsolete) (const noruntime)
357 (const cl-functions) (const interactive-only))))
359 (defvar byte-compile-interactive-only-functions
360 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
361 insert-file insert-buffer insert-file-literally)
362 "List of commands that are not meant to be called from Lisp.")
364 (defvar byte-compile-not-obsolete-var nil
365 "If non-nil, this is a variable that shouldn't be reported as obsolete.")
367 (defcustom byte-compile-generate-call-tree nil
368 "*Non-nil means collect call-graph information when compiling.
369 This records which functions were called and from where.
370 If the value is t, compilation displays the call graph when it finishes.
371 If the value is neither t nor nil, compilation asks you whether to display
374 The call tree only lists functions called, not macros used. Those functions
375 which the byte-code interpreter knows about directly (eq, cons, etc.) are
378 The call tree also lists those functions which are not known to be called
379 \(that is, to which no calls have been compiled). Functions which can be
380 invoked interactively are excluded from this list."
382 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
383 (other :tag "Ask" lambda)))
385 (defvar byte-compile-call-tree nil "Alist of functions and their call tree.
386 Each element looks like
388 \(FUNCTION CALLERS CALLS\)
390 where CALLERS is a list of functions that call FUNCTION, and CALLS
391 is a list of functions for which calls were generated while compiling
394 (defcustom byte-compile-call-tree-sort 'name
395 "*If non-nil, sort the call tree.
396 The values `name', `callers', `calls', `calls+callers'
397 specify different fields to sort on."
399 :type '(choice (const name) (const callers) (const calls)
400 (const calls+callers) (const nil)))
402 (defvar byte-compile-debug nil)
404 ;; (defvar byte-compile-overwrite-file t
405 ;; "If nil, old .elc files are deleted before the new is saved, and .elc
406 ;; files will have the same modes as the corresponding .el file. Otherwise,
407 ;; existing .elc files will simply be overwritten, and the existing modes
408 ;; will not be changed. If this variable is nil, then an .elc file which
409 ;; is a symbolic link will be turned into a normal file, instead of the file
410 ;; which the link points to being overwritten.")
412 (defvar byte-compile-constants nil
413 "List of all constants encountered during compilation of this form.")
414 (defvar byte-compile-variables nil
415 "List of all variables encountered during compilation of this form.")
416 (defvar byte-compile-bound-variables nil
417 "List of variables bound in the context of the current form.
418 This list lives partly on the stack.")
419 (defvar byte-compile-const-variables nil
420 "List of variables declared as constants during compilation of this file.")
421 (defvar byte-compile-free-references)
422 (defvar byte-compile-free-assignments)
424 (defvar byte-compiler-error-flag)
426 (defconst byte-compile-initial-macro-environment
428 ;; (byte-compiler-options . (lambda (&rest forms)
429 ;; (apply 'byte-compiler-options-handler forms)))
430 (eval-when-compile . (lambda (&rest body)
432 (byte-compile-eval (byte-compile-top-level
433 (cons 'progn body))))))
434 (eval-and-compile . (lambda (&rest body)
435 (byte-compile-eval-before-compile (cons 'progn body))
436 (cons 'progn body))))
437 "The default macro-environment passed to macroexpand by the compiler.
438 Placing a macro here will cause a macro to have different semantics when
439 expanded by the compiler as when expanded by the interpreter.")
441 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
442 "Alist of macros defined in the file being compiled.
443 Each element looks like (MACRONAME . DEFINITION). It is
444 \(MACRONAME . nil) when a macro is redefined as a function.")
446 (defvar byte-compile-function-environment nil
447 "Alist of functions defined in the file being compiled.
448 This is so we can inline them when necessary.
449 Each element looks like (FUNCTIONNAME . DEFINITION). It is
450 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
451 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
452 and we don't know the definition.")
454 (defvar byte-compile-unresolved-functions nil
455 "Alist of undefined functions to which calls have been compiled.
456 Used for warnings when the function is not known to be defined or is later
457 defined with incorrect args.")
459 (defvar byte-compile-noruntime-functions nil
460 "Alist of functions called that may not be defined when the compiled code is run.
461 Used for warnings about calling a function that is defined during compilation
462 but won't necessarily be defined when the compiled file is loaded.")
464 (defvar byte-compile-tag-number 0)
465 (defvar byte-compile-output nil
466 "Alist describing contents to put in byte code string.
467 Each element is (INDEX . VALUE)")
468 (defvar byte-compile-depth 0 "Current depth of execution stack.")
469 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
472 ;;; The byte codes; this information is duplicated in bytecomp.c
474 (defvar byte-code-vector nil
475 "An array containing byte-code names indexed by byte-code values.")
477 (defvar byte-stack+-info nil
478 "An array with the stack adjustment for each byte-code.")
480 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
481 ;; This is a speed-hack for building the byte-code-vector at compile-time.
482 ;; We fill in the vector at macroexpand-time, and then after the last call
483 ;; to byte-defop, we write the vector out as a constant instead of writing
484 ;; out a bunch of calls to aset.
485 ;; Actually, we don't fill in the vector itself, because that could make
486 ;; it problematic to compile big changes to this compiler; we store the
487 ;; values on its plist, and remove them later in -extrude.
488 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
489 (put 'byte-code-vector 'tmp-compile-time-value
490 (make-vector 256 nil))))
491 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
492 (put 'byte-stack+-info 'tmp-compile-time-value
493 (make-vector 256 nil)))))
494 (aset v1 opcode opname)
495 (aset v2 opcode stack-adjust))
497 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
498 (list 'defconst opname opcode)))
500 (defmacro byte-extrude-byte-code-vectors ()
501 (prog1 (list 'setq 'byte-code-vector
502 (get 'byte-code-vector 'tmp-compile-time-value)
504 (get 'byte-stack+-info 'tmp-compile-time-value))
505 (put 'byte-code-vector 'tmp-compile-time-value nil)
506 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
511 ;; These opcodes are special in that they pack their argument into the
514 (byte-defop 8 1 byte-varref "for variable reference")
515 (byte-defop 16 -1 byte-varset "for setting a variable")
516 (byte-defop 24 -1 byte-varbind "for binding a variable")
517 (byte-defop 32 0 byte-call "for calling a function")
518 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
519 ;; codes 8-47 are consumed by the preceding opcodes
523 (byte-defop 56 -1 byte-nth)
524 (byte-defop 57 0 byte-symbolp)
525 (byte-defop 58 0 byte-consp)
526 (byte-defop 59 0 byte-stringp)
527 (byte-defop 60 0 byte-listp)
528 (byte-defop 61 -1 byte-eq)
529 (byte-defop 62 -1 byte-memq)
530 (byte-defop 63 0 byte-not)
531 (byte-defop 64 0 byte-car)
532 (byte-defop 65 0 byte-cdr)
533 (byte-defop 66 -1 byte-cons)
534 (byte-defop 67 0 byte-list1)
535 (byte-defop 68 -1 byte-list2)
536 (byte-defop 69 -2 byte-list3)
537 (byte-defop 70 -3 byte-list4)
538 (byte-defop 71 0 byte-length)
539 (byte-defop 72 -1 byte-aref)
540 (byte-defop 73 -2 byte-aset)
541 (byte-defop 74 0 byte-symbol-value)
542 (byte-defop 75 0 byte-symbol-function) ; this was commented out
543 (byte-defop 76 -1 byte-set)
544 (byte-defop 77 -1 byte-fset) ; this was commented out
545 (byte-defop 78 -1 byte-get)
546 (byte-defop 79 -2 byte-substring)
547 (byte-defop 80 -1 byte-concat2)
548 (byte-defop 81 -2 byte-concat3)
549 (byte-defop 82 -3 byte-concat4)
550 (byte-defop 83 0 byte-sub1)
551 (byte-defop 84 0 byte-add1)
552 (byte-defop 85 -1 byte-eqlsign)
553 (byte-defop 86 -1 byte-gtr)
554 (byte-defop 87 -1 byte-lss)
555 (byte-defop 88 -1 byte-leq)
556 (byte-defop 89 -1 byte-geq)
557 (byte-defop 90 -1 byte-diff)
558 (byte-defop 91 0 byte-negate)
559 (byte-defop 92 -1 byte-plus)
560 (byte-defop 93 -1 byte-max)
561 (byte-defop 94 -1 byte-min)
562 (byte-defop 95 -1 byte-mult) ; v19 only
563 (byte-defop 96 1 byte-point)
564 (byte-defop 98 0 byte-goto-char)
565 (byte-defop 99 0 byte-insert)
566 (byte-defop 100 1 byte-point-max)
567 (byte-defop 101 1 byte-point-min)
568 (byte-defop 102 0 byte-char-after)
569 (byte-defop 103 1 byte-following-char)
570 (byte-defop 104 1 byte-preceding-char)
571 (byte-defop 105 1 byte-current-column)
572 (byte-defop 106 0 byte-indent-to)
573 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
574 (byte-defop 108 1 byte-eolp)
575 (byte-defop 109 1 byte-eobp)
576 (byte-defop 110 1 byte-bolp)
577 (byte-defop 111 1 byte-bobp)
578 (byte-defop 112 1 byte-current-buffer)
579 (byte-defop 113 0 byte-set-buffer)
580 (byte-defop 114 0 byte-save-current-buffer
581 "To make a binding to record the current buffer")
582 (byte-defop 115 0 byte-set-mark-OBSOLETE)
583 (byte-defop 116 1 byte-interactive-p)
585 ;; These ops are new to v19
586 (byte-defop 117 0 byte-forward-char)
587 (byte-defop 118 0 byte-forward-word)
588 (byte-defop 119 -1 byte-skip-chars-forward)
589 (byte-defop 120 -1 byte-skip-chars-backward)
590 (byte-defop 121 0 byte-forward-line)
591 (byte-defop 122 0 byte-char-syntax)
592 (byte-defop 123 -1 byte-buffer-substring)
593 (byte-defop 124 -1 byte-delete-region)
594 (byte-defop 125 -1 byte-narrow-to-region)
595 (byte-defop 126 1 byte-widen)
596 (byte-defop 127 0 byte-end-of-line)
600 ;; These store their argument in the next two bytes
601 (byte-defop 129 1 byte-constant2
602 "for reference to a constant with vector index >= byte-constant-limit")
603 (byte-defop 130 0 byte-goto "for unconditional jump")
604 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
605 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
606 (byte-defop 133 -1 byte-goto-if-nil-else-pop
607 "to examine top-of-stack, jump and don't pop it if it's nil,
609 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
610 "to examine top-of-stack, jump and don't pop it if it's non nil,
613 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
614 (byte-defop 136 -1 byte-discard "to discard one value from stack")
615 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
617 (byte-defop 138 0 byte-save-excursion
618 "to make a binding to record the buffer, point and mark")
619 (byte-defop 139 0 byte-save-window-excursion
620 "to make a binding to record entire window configuration")
621 (byte-defop 140 0 byte-save-restriction
622 "to make a binding to record the current buffer clipping restrictions")
623 (byte-defop 141 -1 byte-catch
624 "for catch. Takes, on stack, the tag and an expression for the body")
625 (byte-defop 142 -1 byte-unwind-protect
626 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
628 ;; For condition-case. Takes, on stack, the variable to bind,
629 ;; an expression for the body, and a list of clauses.
630 (byte-defop 143 -2 byte-condition-case)
632 ;; For entry to with-output-to-temp-buffer.
633 ;; Takes, on stack, the buffer name.
634 ;; Binds standard-output and does some other things.
635 ;; Returns with temp buffer on the stack in place of buffer name.
636 (byte-defop 144 0 byte-temp-output-buffer-setup)
638 ;; For exit from with-output-to-temp-buffer.
639 ;; Expects the temp buffer on the stack underneath value to return.
640 ;; Pops them both, then pushes the value back on.
641 ;; Unbinds standard-output and makes the temp buffer visible.
642 (byte-defop 145 -1 byte-temp-output-buffer-show)
644 ;; these ops are new to v19
646 ;; To unbind back to the beginning of this frame.
647 ;; Not used yet, but will be needed for tail-recursion elimination.
648 (byte-defop 146 0 byte-unbind-all)
650 ;; these ops are new to v19
651 (byte-defop 147 -2 byte-set-marker)
652 (byte-defop 148 0 byte-match-beginning)
653 (byte-defop 149 0 byte-match-end)
654 (byte-defop 150 0 byte-upcase)
655 (byte-defop 151 0 byte-downcase)
656 (byte-defop 152 -1 byte-string=)
657 (byte-defop 153 -1 byte-string<)
658 (byte-defop 154 -1 byte-equal)
659 (byte-defop 155 -1 byte-nthcdr)
660 (byte-defop 156 -1 byte-elt)
661 (byte-defop 157 -1 byte-member)
662 (byte-defop 158 -1 byte-assq)
663 (byte-defop 159 0 byte-nreverse)
664 (byte-defop 160 -1 byte-setcar)
665 (byte-defop 161 -1 byte-setcdr)
666 (byte-defop 162 0 byte-car-safe)
667 (byte-defop 163 0 byte-cdr-safe)
668 (byte-defop 164 -1 byte-nconc)
669 (byte-defop 165 -1 byte-quo)
670 (byte-defop 166 -1 byte-rem)
671 (byte-defop 167 0 byte-numberp)
672 (byte-defop 168 0 byte-integerp)
675 (byte-defop 175 nil byte-listN)
676 (byte-defop 176 nil byte-concatN)
677 (byte-defop 177 nil byte-insertN)
681 (byte-defop 192 1 byte-constant "for reference to a constant")
682 ;; codes 193-255 are consumed by byte-constant.
683 (defconst byte-constant-limit 64
684 "Exclusive maximum index usable in the `byte-constant' opcode.")
686 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
687 byte-goto-if-nil-else-pop
688 byte-goto-if-not-nil-else-pop)
689 "List of byte-codes whose offset is a pc.")
691 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
693 (byte-extrude-byte-code-vectors)
695 ;;; lapcode generator
697 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
698 ;; source -> bytecode, because it's a lot easier to make optimizations
699 ;; on lapcode than on bytecode.
701 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
702 ;; where instruction is a symbol naming a byte-code instruction,
703 ;; and parameter is an argument to that instruction, if any.
705 ;; The instruction can be the pseudo-op TAG, which means that this position
706 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
707 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
708 ;; parameter for some goto op.
710 ;; If the operation is varbind, varref, varset or push-constant, then the
711 ;; parameter is (variable/constant . index_in_constant_vector).
713 ;; First, the source code is macroexpanded and optimized in various ways.
714 ;; Then the resultant code is compiled into lapcode. Another set of
715 ;; optimizations are then run over the lapcode. Then the variables and
716 ;; constants referenced by the lapcode are collected and placed in the
717 ;; constants-vector. (This happens now so that variables referenced by dead
718 ;; code don't consume space.) And finally, the lapcode is transformed into
719 ;; compacted byte-code.
721 ;; A distinction is made between variables and constants because the variable-
722 ;; referencing instructions are more sensitive to the variables being near the
723 ;; front of the constants-vector than the constant-referencing instructions.
724 ;; Also, this lets us notice references to free variables.
726 (defun byte-compile-lapcode (lap)
727 "Turns lapcode into bytecode. The lapcode is destroyed."
728 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
729 (let ((pc 0) ; Program counter
730 op off ; Operation & offset
731 (bytes '()) ; Put the output bytes here
732 (patchlist nil)) ; List of tags and goto's to patch
734 (setq op (car (car lap))
736 (cond ((not (symbolp op))
737 (error "Non-symbolic opcode `%s'" op))
740 (setq patchlist (cons off patchlist)))
741 ((memq op byte-goto-ops)
743 (setq bytes (cons (cons pc (cdr off))
745 (cons (symbol-value op) bytes))))
746 (setq patchlist (cons bytes patchlist)))
749 (cond ((cond ((consp off)
750 ;; Variable or constant reference
752 (eq op 'byte-constant)))
753 (cond ((< off byte-constant-limit)
755 (cons (+ byte-constant off) bytes))
759 (cons (logand off 255)
760 (cons byte-constant2 bytes))))))
761 ((<= byte-listN (symbol-value op))
763 (cons off (cons (symbol-value op) bytes)))
766 (cons (+ (symbol-value op) off) bytes))
769 (cons off (cons (+ (symbol-value op) 6) bytes)))
773 (cons (logand off 255)
774 (cons (+ (symbol-value op) 7)
776 (setq lap (cdr lap)))
777 ;;(if (not (= pc (length bytes)))
778 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
779 ;; Patch PC into jumps
782 (setq bytes (car patchlist))
783 (cond ((atom (car bytes))) ; Tag
785 (setq pc (car (cdr (car bytes)))) ; Pick PC from tag
786 (setcar (cdr bytes) (logand pc 255))
787 (setcar bytes (lsh pc -8))))
788 (setq patchlist (cdr patchlist))))
789 (string-make-unibyte (concat (nreverse bytes)))))
792 ;;; compile-time evaluation
794 (defun byte-compile-eval (form)
795 "Eval FORM and mark the functions defined therein.
796 Each function's symbol gets added to `byte-compile-noruntime-functions'."
797 (let ((hist-orig load-history)
798 (hist-nil-orig current-load-list))
800 (when (memq 'noruntime byte-compile-warnings)
801 (let ((hist-new load-history)
802 (hist-nil-new current-load-list))
803 ;; Go through load-history, look for newly loaded files
804 ;; and mark all the functions defined therein.
805 (while (and hist-new (not (eq hist-new hist-orig)))
806 (let ((xs (pop hist-new))
808 ;; Make sure the file was not already loaded before.
809 (unless (or (assoc (car xs) hist-orig)
810 (equal (car xs) "cl"))
814 (unless (memq s old-autoloads)
815 (push s byte-compile-noruntime-functions)))
816 ((and (consp s) (eq t (car s)))
817 (push (cdr s) old-autoloads))
818 ((and (consp s) (eq 'autoload (car s)))
819 (push (cdr s) byte-compile-noruntime-functions)))))))
820 ;; Go through current-load-list for the locally defined funs.
822 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
823 (let ((s (pop hist-nil-new)))
824 (when (and (symbolp s) (not (memq s old-autoloads)))
825 (push s byte-compile-noruntime-functions))
826 (when (and (consp s) (eq t (car s)))
827 (push (cdr s) old-autoloads)))))))
828 (when (memq 'cl-functions byte-compile-warnings)
829 (let ((hist-new load-history)
830 (hist-nil-new current-load-list))
831 ;; Go through load-history, look for newly loaded files
832 ;; and mark all the functions defined therein.
833 (while (and hist-new (not (eq hist-new hist-orig)))
834 (let ((xs (pop hist-new))
836 ;; Make sure the file was not already loaded before.
837 (when (and (equal (car xs) "cl") (not (assoc (car xs) hist-orig)))
838 (byte-compile-find-cl-functions)))))))))
840 (defun byte-compile-eval-before-compile (form)
841 "Evaluate FORM for `eval-and-compile'."
842 (let ((hist-nil-orig current-load-list))
844 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
845 (let ((tem current-load-list))
846 (while (not (eq tem hist-nil-orig))
847 (when (equal (car tem) '(require . cl))
848 (setq byte-compile-warnings
849 (remq 'cl-functions byte-compile-warnings)))
850 (setq tem (cdr tem)))))))
852 ;;; byte compiler messages
854 (defvar byte-compile-current-form nil)
855 (defvar byte-compile-dest-file nil)
856 (defvar byte-compile-current-file nil)
857 (defvar byte-compile-current-buffer nil)
859 ;; Log something that isn't a warning.
860 (defmacro byte-compile-log (format-string &rest args)
863 (memq byte-optimize-log '(t source))
864 (let ((print-escape-newlines t)
871 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
874 ;; Log something that isn't a warning.
875 (defun byte-compile-log-1 (string)
876 (with-current-buffer "*Compile-Log*"
877 (let ((inhibit-read-only t))
878 (goto-char (point-max))
879 (byte-compile-warning-prefix nil nil)
880 (cond (noninteractive
881 (message " %s" string))
883 (insert (format "%s\n" string)))))))
885 (defvar byte-compile-read-position nil
886 "Character position we began the last `read' from.")
887 (defvar byte-compile-last-position nil
888 "Last known character position in the input.")
890 ;; copied from gnus-util.el
891 (defsubst byte-compile-delete-first (elt list)
892 (if (eq (car list) elt)
895 (while (and (cdr list)
896 (not (eq (cadr list) elt)))
897 (setq list (cdr list)))
899 (setcdr list (cddr list)))
902 ;; The purpose of this function is to iterate through the
903 ;; `read-symbol-positions-list'. Each time we process, say, a
904 ;; function definition (`defun') we remove `defun' from
905 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
906 ;; to that symbol's character position. Similarly, if we encounter a
907 ;; variable reference, like in (1+ foo), we remove `foo' from the
908 ;; list. If our current position is after the symbol's position, we
909 ;; assume we've already passed that point, and look for the next
910 ;; occurrence of the symbol.
911 ;; So your're probably asking yourself: Isn't this function a
912 ;; gross hack? And the answer, of course, would be yes.
913 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
914 (when byte-compile-read-position
917 (setq last byte-compile-last-position
918 entry (assq sym read-symbol-positions-list))
920 (setq byte-compile-last-position
921 (+ byte-compile-read-position (cdr entry))
922 read-symbol-positions-list
923 (byte-compile-delete-first
924 entry read-symbol-positions-list)))
925 (or (and allow-previous (not (= last byte-compile-last-position)))
926 (> last byte-compile-last-position)))))))
928 (defvar byte-compile-last-warned-form nil)
929 (defvar byte-compile-last-logged-file nil)
931 ;; This is used as warning-prefix for the compiler.
932 ;; It is always called with the warnings buffer current.
933 (defun byte-compile-warning-prefix (level entry)
934 (let* ((inhibit-read-only t)
935 (dir default-directory)
936 (file (cond ((stringp byte-compile-current-file)
937 (format "%s:" (file-relative-name byte-compile-current-file dir)))
938 ((bufferp byte-compile-current-file)
940 (buffer-name byte-compile-current-file)))
942 (pos (if (and byte-compile-current-file
943 (integerp byte-compile-read-position))
944 (with-current-buffer byte-compile-current-buffer
945 (format "%d:%d:" (count-lines (point-min)
946 byte-compile-last-position)
948 (goto-char byte-compile-last-position)
949 (1+ (current-column)))))
951 (form (if (eq byte-compile-current-form :end) "end of data"
952 (or byte-compile-current-form "toplevel form"))))
953 (when (or (and byte-compile-current-file
954 (not (equal byte-compile-current-file
955 byte-compile-last-logged-file)))
956 (and byte-compile-current-form
957 (not (eq byte-compile-current-form
958 byte-compile-last-warned-form))))
959 (insert (format "\nIn %s:\n" form)))
961 (insert (format "%s%s" file pos))))
962 (setq byte-compile-last-logged-file byte-compile-current-file
963 byte-compile-last-warned-form byte-compile-current-form)
966 ;; This no-op function is used as the value of warning-series
967 ;; to tell inner calls to displaying-byte-compile-warnings
968 ;; not to bind warning-series.
969 (defun byte-compile-warning-series (&rest ignore)
972 ;; Log the start of a file in *Compile-Log*, and mark it as done.
973 ;; Return the position of the start of the page in the log buffer.
974 ;; But do nothing in batch mode.
975 (defun byte-compile-log-file ()
976 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
979 (set-buffer (get-buffer-create "*Compile-Log*"))
980 (goto-char (point-max))
981 (let* ((inhibit-read-only t)
982 (dir (and byte-compile-current-file
983 (file-name-directory byte-compile-current-file)))
984 (was-same (equal default-directory dir))
988 (insert (format "Leaving directory `%s'\n" default-directory))))
991 (setq pt (point-marker))
992 (if byte-compile-current-file
993 (insert "\f\nCompiling "
994 (if (stringp byte-compile-current-file)
995 (concat "file " byte-compile-current-file)
996 (concat "buffer " (buffer-name byte-compile-current-file)))
997 " at " (current-time-string) "\n")
998 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1000 (setq default-directory dir)
1002 (insert (format "Entering directory `%s'\n" default-directory))))
1003 (setq byte-compile-last-logged-file byte-compile-current-file
1004 byte-compile-last-warned-form nil)
1005 ;; Do this after setting default-directory.
1006 (unless (eq major-mode 'compilation-mode)
1008 (compilation-forget-errors)
1011 ;; Log a message STRING in *Compile-Log*.
1012 ;; Also log the current function and file if not already done.
1013 (defun byte-compile-log-warning (string &optional fill level)
1014 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1015 (warning-type-format "")
1016 (warning-fill-prefix (if fill " "))
1017 (inhibit-read-only t))
1018 (display-warning 'bytecomp string level "*Compile-Log*")))
1020 (defun byte-compile-warn (format &rest args)
1021 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1022 (setq format (apply 'format format args))
1023 (if byte-compile-error-on-warn
1024 (error "%s" format) ; byte-compile-file catches and logs it
1025 (byte-compile-log-warning format t :warning)))
1027 (defun byte-compile-report-error (error-info)
1028 "Report Lisp error in compilation. ERROR-INFO is the error data."
1029 (setq byte-compiler-error-flag t)
1030 (byte-compile-log-warning
1031 (error-message-string error-info)
1034 ;;; Used by make-obsolete.
1035 (defun byte-compile-obsolete (form)
1036 (let* ((new (get (car form) 'byte-obsolete-info))
1037 (handler (nth 1 new))
1039 (byte-compile-set-symbol-position (car form))
1040 (if (memq 'obsolete byte-compile-warnings)
1041 (byte-compile-warn "`%s' is an obsolete function%s; %s" (car form)
1042 (if when (concat " (as of Emacs " when ")") "")
1043 (if (stringp (car new))
1045 (format "use `%s' instead." (car new)))))
1046 (funcall (or handler 'byte-compile-normal-call) form)))
1050 ;; (defvar byte-compiler-valid-options
1051 ;; '((optimize byte-optimize (t nil source byte) val)
1052 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1053 ;; (eq val 'emacs18))
1054 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1055 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1056 ;; (verbose byte-compile-verbose (t nil) val)
1057 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1060 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1061 ;; #### This should print a warning if the user tries to change something
1062 ;; than can't be changed because the running compiler doesn't support it.
1064 ;; ((byte-compile-single-version)
1065 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1066 ;; (list (byte-compile-version-cond
1067 ;; byte-compile-generate-emacs19-bytecodes)))
1068 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1069 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1070 ;; '(emacs18) '(emacs19)))))
1072 ;; (defun byte-compiler-options-handler (&rest args)
1073 ;; (let (key val desc choices)
1075 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1076 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1077 ;; (setq key (car (car args))
1078 ;; val (car (cdr (car args)))
1079 ;; desc (assq key byte-compiler-valid-options))
1081 ;; (error "Unknown byte-compiler option `%s'" key))
1082 ;; (setq choices (nth 2 desc))
1083 ;; (if (consp (car choices))
1086 ;; (ret (and (memq (car val) '(+ -))
1087 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1089 ;; (symbol-value (nth 1 desc)))))))
1090 ;; (setq choices (car choices))
1092 ;; (setq this (car val))
1093 ;; (cond ((memq this choices)
1094 ;; (setq ret (funcall handler this ret)))
1095 ;; ((eq this '+) (setq handler 'cons))
1096 ;; ((eq this '-) (setq handler 'delq))
1097 ;; ((error "`%s' only accepts %s" key choices)))
1098 ;; (setq val (cdr val)))
1099 ;; (set (nth 1 desc) ret))
1100 ;; (or (memq val choices)
1101 ;; (error "`%s' must be one of `%s'" key choices))
1102 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1103 ;; (setq args (cdr args)))
1106 ;;; sanity-checking arglists
1108 ;; If a function has an entry saying (FUNCTION . t).
1109 ;; that means we know it is defined but we don't know how.
1110 ;; If a function has an entry saying (FUNCTION . nil),
1111 ;; that means treat it as not defined.
1112 (defun byte-compile-fdefinition (name macro-p)
1113 (let* ((list (if macro-p
1114 byte-compile-macro-environment
1115 byte-compile-function-environment))
1116 (env (cdr (assq name list))))
1119 (while (and (symbolp fn)
1121 (or (symbolp (symbol-function fn))
1122 (consp (symbol-function fn))
1124 (byte-code-function-p (symbol-function fn)))))
1125 (setq fn (symbol-function fn)))
1126 (if (and (not macro-p) (byte-code-function-p fn))
1129 (if (eq 'macro (car fn))
1133 (if (eq 'autoload (car fn))
1137 (defun byte-compile-arglist-signature (arglist)
1142 (cond ((eq (car arglist) '&optional)
1143 (or opts (setq opts 0)))
1144 ((eq (car arglist) '&rest)
1150 (setq opts (1+ opts))
1151 (setq args (1+ args)))))
1152 (setq arglist (cdr arglist)))
1153 (cons args (if restp nil (if opts (+ args opts) args)))))
1156 (defun byte-compile-arglist-signatures-congruent-p (old new)
1158 (> (car new) (car old)) ; requires more args now
1159 (and (null (cdr old)) ; took rest-args, doesn't any more
1161 (and (cdr new) (cdr old) ; can't take as many args now
1162 (< (cdr new) (cdr old)))
1165 (defun byte-compile-arglist-signature-string (signature)
1166 (cond ((null (cdr signature))
1167 (format "%d+" (car signature)))
1168 ((= (car signature) (cdr signature))
1169 (format "%d" (car signature)))
1170 (t (format "%d-%d" (car signature) (cdr signature)))))
1173 ;; Warn if the form is calling a function with the wrong number of arguments.
1174 (defun byte-compile-callargs-warn (form)
1175 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1176 (byte-compile-fdefinition (car form) t)))
1177 (sig (if (and def (not (eq def t)))
1178 (byte-compile-arglist-signature
1179 (if (eq 'lambda (car-safe def))
1181 (if (byte-code-function-p def)
1184 (if (and (fboundp (car form))
1185 (subrp (symbol-function (car form))))
1186 (subr-arity (symbol-function (car form))))))
1187 (ncall (length (cdr form))))
1188 ;; Check many or unevalled from subr-arity.
1189 (if (and (cdr-safe sig)
1190 (not (numberp (cdr sig))))
1193 (when (or (< ncall (car sig))
1194 (and (cdr sig) (> ncall (cdr sig))))
1195 (byte-compile-set-symbol-position (car form))
1197 "%s called with %d argument%s, but %s %s"
1199 (if (= 1 ncall) "" "s")
1200 (if (< ncall (car sig))
1203 (byte-compile-arglist-signature-string sig))))
1204 (byte-compile-format-warn form)
1205 ;; Check to see if the function will be available at runtime
1206 ;; and/or remember its arity if it's unknown.
1207 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1208 (not (memq (car form) byte-compile-noruntime-functions)))
1209 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1211 ;; It's a currently-undefined function.
1212 ;; Remember number of args in call.
1213 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1214 (n (length (cdr form))))
1216 (or (memq n (cdr cons))
1217 (setcdr cons (cons n (cdr cons))))
1218 (push (list (car form) n)
1219 byte-compile-unresolved-functions))))))
1221 (defun byte-compile-format-warn (form)
1222 "Warn if FORM is `format'-like with inconsistent args.
1223 Applies if head of FORM is a symbol with non-nil property
1224 `byte-compile-format-like' and first arg is a constant string.
1225 Then check the number of format fields matches the number of
1227 (when (and (symbolp (car form))
1228 (stringp (nth 1 form))
1229 (get (car form) 'byte-compile-format-like))
1230 (let ((nfields (with-temp-buffer
1231 (insert (nth 1 form))
1234 (while (re-search-forward "%." nil t)
1235 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1238 (nargs (- (length form) 2)))
1239 (unless (= nargs nfields)
1241 "`%s' called with %d args to fill %d format field(s)" (car form)
1244 (dolist (elt '(format message error))
1245 (put elt 'byte-compile-format-like t))
1247 ;; Warn if a custom definition fails to specify :group.
1248 (defun byte-compile-nogroup-warn (form)
1249 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1251 (or (not (eq (car-safe name) 'quote))
1252 (and (eq (car form) 'custom-declare-group)
1253 (equal name ''emacs))
1254 (plist-get keyword-args :group)
1255 (not (and (consp name) (eq (car name) 'quote)))
1257 "%s for `%s' fails to specify containing group"
1258 (cdr (assq (car form)
1259 '((custom-declare-group . defgroup)
1260 (custom-declare-face . defface)
1261 (custom-declare-variable . defcustom))))
1264 ;; Warn if the function or macro is being redefined with a different
1265 ;; number of arguments.
1266 (defun byte-compile-arglist-warn (form macrop)
1267 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
1268 (if (and old (not (eq old t)))
1269 (let ((sig1 (byte-compile-arglist-signature
1270 (if (eq 'lambda (car-safe old))
1272 (if (byte-code-function-p old)
1275 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1276 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1277 (byte-compile-set-symbol-position (nth 1 form))
1279 "%s %s used to take %s %s, now takes %s"
1280 (if (eq (car form) 'defun) "function" "macro")
1282 (byte-compile-arglist-signature-string sig1)
1283 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1284 (byte-compile-arglist-signature-string sig2))))
1285 ;; This is the first definition. See if previous calls are compatible.
1286 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1290 (setq sig (byte-compile-arglist-signature (nth 2 form))
1291 nums (sort (copy-sequence (cdr calls)) (function <))
1293 max (car (nreverse nums)))
1294 (when (or (< min (car sig))
1295 (and (cdr sig) (> max (cdr sig))))
1296 (byte-compile-set-symbol-position (nth 1 form))
1298 "%s being defined to take %s%s, but was previously called with %s"
1300 (byte-compile-arglist-signature-string sig)
1301 (if (equal sig '(1 . 1)) " arg" " args")
1302 (byte-compile-arglist-signature-string (cons min max))))
1304 (setq byte-compile-unresolved-functions
1305 (delq calls byte-compile-unresolved-functions)))))
1308 (defvar byte-compile-cl-functions nil
1309 "List of functions defined in CL.")
1311 (defun byte-compile-find-cl-functions ()
1312 (unless byte-compile-cl-functions
1313 (dolist (elt load-history)
1314 (when (and (stringp (car elt))
1315 (string-match "^cl\\>" (car elt)))
1316 (setq byte-compile-cl-functions
1317 (append byte-compile-cl-functions
1319 (let ((tail byte-compile-cl-functions))
1321 (if (and (consp (car tail))
1322 (eq (car (car tail)) 'autoload))
1323 (setcar tail (cdr (car tail))))
1324 (setq tail (cdr tail))))))
1326 (defun byte-compile-cl-warn (form)
1327 "Warn if FORM is a call of a function from the CL package."
1328 (let ((func (car-safe form)))
1329 (if (and byte-compile-cl-functions
1330 (memq func byte-compile-cl-functions)
1331 ;; Aliases which won't have been expanded at this point.
1332 ;; These aren't all aliases of subrs, so not trivial to
1333 ;; avoid hardwiring the list.
1335 '(cl-block-wrapper cl-block-throw
1336 multiple-value-call nth-value
1337 copy-seq first second rest endp cl-member
1338 ;; These are included in generated code
1339 ;; that can't be called except at compile time
1340 ;; or unless cl is loaded anyway.
1341 cl-defsubst-expand cl-struct-setf-expander
1342 ;; These would sometimes be warned about
1343 ;; but such warnings are never useful,
1344 ;; so don't warn about them.
1345 macroexpand cl-macroexpand-all
1346 cl-compiling-file)))
1347 ;; Avoid warnings for things which are safe because they
1348 ;; have suitable compiler macros, but those aren't
1349 ;; expanded at this stage. There should probably be more
1350 ;; here than caaar and friends.
1351 (not (and (eq (get func 'byte-compile)
1352 'cl-byte-compile-compiler-macro)
1353 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
1354 (byte-compile-warn "Function `%s' from cl package called at runtime"
1358 (defun byte-compile-print-syms (str1 strn syms)
1360 (byte-compile-set-symbol-position (car syms) t))
1361 (cond ((and (cdr syms) (not noninteractive))
1366 (setq s (symbol-name (pop syms))
1367 L (+ L (length s) 2))
1368 (if (< L (1- fill-column))
1369 (setq str (concat str " " s (and syms ",")))
1370 (setq str (concat str "\n " s (and syms ","))
1371 L (+ (length s) 4))))
1372 (byte-compile-warn "%s" str)))
1374 (byte-compile-warn "%s %s"
1376 (mapconcat #'symbol-name syms ", ")))
1379 (byte-compile-warn str1 (car syms)))))
1381 ;; If we have compiled any calls to functions which are not known to be
1382 ;; defined, issue a warning enumerating them.
1383 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1384 (defun byte-compile-warn-about-unresolved-functions ()
1385 (when (memq 'unresolved byte-compile-warnings)
1386 (let ((byte-compile-current-form :end)
1389 ;; Separate the functions that will not be available at runtime
1390 ;; from the truly unresolved ones.
1391 (dolist (f byte-compile-unresolved-functions)
1393 (if (fboundp f) (push f noruntime) (push f unresolved)))
1394 ;; Complain about the no-run-time functions
1395 (byte-compile-print-syms
1396 "the function `%s' might not be defined at runtime."
1397 "the following functions might not be defined at runtime:"
1399 ;; Complain about the unresolved functions
1400 (byte-compile-print-syms
1401 "the function `%s' is not known to be defined."
1402 "the following functions are not known to be defined:"
1407 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1408 "Non-nil if SYMBOL is constant.
1409 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1411 (or (memq symbol '(nil t))
1413 (if any-value (memq symbol byte-compile-const-variables))))
1415 (defmacro byte-compile-constp (form)
1416 "Return non-nil if FORM is a constant."
1417 `(cond ((consp ,form) (eq (car ,form) 'quote))
1418 ((not (symbolp ,form)))
1419 ((byte-compile-const-symbol-p ,form))))
1421 (defmacro byte-compile-close-variables (&rest body)
1424 ;; Close over these variables to encapsulate the
1425 ;; compilation state
1427 (byte-compile-macro-environment
1428 ;; Copy it because the compiler may patch into the
1429 ;; macroenvironment.
1430 (copy-alist byte-compile-initial-macro-environment))
1431 (byte-compile-function-environment nil)
1432 (byte-compile-bound-variables nil)
1433 (byte-compile-const-variables nil)
1434 (byte-compile-free-references nil)
1435 (byte-compile-free-assignments nil)
1437 ;; Close over these variables so that `byte-compiler-options'
1438 ;; can change them on a per-file basis.
1440 (byte-compile-verbose byte-compile-verbose)
1441 (byte-optimize byte-optimize)
1442 (byte-compile-compatibility byte-compile-compatibility)
1443 (byte-compile-dynamic byte-compile-dynamic)
1444 (byte-compile-dynamic-docstrings
1445 byte-compile-dynamic-docstrings)
1446 ;; (byte-compile-generate-emacs19-bytecodes
1447 ;; byte-compile-generate-emacs19-bytecodes)
1448 (byte-compile-warnings (if (eq byte-compile-warnings t)
1449 byte-compile-warning-types
1450 byte-compile-warnings))
1454 (defmacro displaying-byte-compile-warnings (&rest body)
1455 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1456 (warning-series-started
1457 (and (markerp warning-series)
1458 (eq (marker-buffer warning-series)
1459 (get-buffer "*Compile-Log*")))))
1460 (byte-compile-find-cl-functions)
1461 (if (or (eq warning-series 'byte-compile-warning-series)
1462 warning-series-started)
1463 ;; warning-series does come from compilation,
1464 ;; so don't bind it, but maybe do set it.
1466 ;; Log the file name. Record position of that text.
1467 (setq tem (byte-compile-log-file))
1468 (unless warning-series-started
1469 (setq warning-series (or tem 'byte-compile-warning-series)))
1470 (if byte-compile-debug
1471 (funcall --displaying-byte-compile-warnings-fn)
1472 (condition-case error-info
1473 (funcall --displaying-byte-compile-warnings-fn)
1474 (error (byte-compile-report-error error-info)))))
1475 ;; warning-series does not come from compilation, so bind it.
1476 (let ((warning-series
1477 ;; Log the file name. Record position of that text.
1478 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1479 (if byte-compile-debug
1480 (funcall --displaying-byte-compile-warnings-fn)
1481 (condition-case error-info
1482 (funcall --displaying-byte-compile-warnings-fn)
1483 (error (byte-compile-report-error error-info))))))))
1486 (defun byte-force-recompile (directory)
1487 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1488 Files in subdirectories of DIRECTORY are processed also."
1489 (interactive "DByte force recompile (directory): ")
1490 (byte-recompile-directory directory nil t))
1493 (defun byte-recompile-directory (directory &optional arg force)
1494 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1495 This is if a `.elc' file exists but is older than the `.el' file.
1496 Files in subdirectories of DIRECTORY are processed also.
1498 If the `.elc' file does not exist, normally this function *does not*
1499 compile the corresponding `.el' file. However,
1500 if ARG (the prefix argument) is 0, that means do compile all those files.
1501 A nonzero ARG means ask the user, for each such `.el' file,
1502 whether to compile it.
1504 A nonzero ARG also means ask about each subdirectory before scanning it.
1506 If the third argument FORCE is non-nil,
1507 recompile every `.el' file that already has a `.elc' file."
1508 (interactive "DByte recompile directory: \nP")
1510 (setq arg (prefix-numeric-value arg)))
1514 (force-mode-line-update))
1515 (save-current-buffer
1516 (set-buffer (get-buffer-create "*Compile-Log*"))
1517 (setq default-directory (expand-file-name directory))
1518 ;; compilation-mode copies value of default-directory.
1519 (unless (eq major-mode 'compilation-mode)
1521 (let ((directories (list (expand-file-name directory)))
1522 (default-directory default-directory)
1528 (displaying-byte-compile-warnings
1530 (setq directory (car directories))
1531 (message "Checking %s..." directory)
1532 (let ((files (directory-files directory))
1534 (dolist (file files)
1535 (setq source (expand-file-name file directory))
1536 (if (and (not (member file '("RCS" "CVS")))
1537 (not (eq ?\. (aref file 0)))
1538 (file-directory-p source)
1539 (not (file-symlink-p source)))
1540 ;; This file is a subdirectory. Handle them differently.
1541 (when (or (null arg)
1543 (y-or-n-p (concat "Check " source "? ")))
1545 (nconc directories (list source))))
1546 ;; It is an ordinary file. Decide whether to compile it.
1547 (if (and (string-match emacs-lisp-file-regexp source)
1548 (file-readable-p source)
1549 (not (auto-save-file-name-p source))
1550 (setq dest (byte-compile-dest-file source))
1551 (if (file-exists-p dest)
1552 ;; File was already compiled.
1553 (or force (file-newer-than-file-p source dest))
1554 ;; No compiled file exists yet.
1557 (y-or-n-p (concat "Compile " source "? "))))))
1558 (progn (if (and noninteractive (not byte-compile-verbose))
1559 (message "Compiling %s..." source))
1560 (let ((res (byte-compile-file source)))
1561 (cond ((eq res 'no-byte-compile)
1562 (setq skip-count (1+ skip-count)))
1564 (setq file-count (1+ file-count)))
1566 (setq fail-count (1+ fail-count)))))
1568 (message "Checking %s..." directory))
1569 (if (not (eq last-dir directory))
1570 (setq last-dir directory
1571 dir-count (1+ dir-count)))
1573 (setq directories (cdr directories))))
1574 (message "Done (Total of %d file%s compiled%s%s%s)"
1575 file-count (if (= file-count 1) "" "s")
1576 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1577 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1578 (if (> dir-count 1) (format " in %d directories" dir-count) "")))))
1580 (defvar no-byte-compile nil
1581 "Non-nil to prevent byte-compiling of emacs-lisp code.
1582 This is normally set in local file variables at the end of the elisp file:
1584 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1587 (defun byte-compile-file (filename &optional load)
1588 "Compile a file of Lisp code named FILENAME into a file of byte code.
1589 The output file's name is made by appending `c' to the end of FILENAME.
1590 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1591 The value is non-nil if there were no errors, nil if errors."
1592 ;; (interactive "fByte compile file: \nP")
1594 (let ((file buffer-file-name)
1598 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1600 (setq file-name (file-name-nondirectory file)
1601 file-dir (file-name-directory file)))
1602 (list (read-file-name (if current-prefix-arg
1603 "Byte compile and load file: "
1604 "Byte compile file: ")
1605 file-dir file-name nil)
1606 current-prefix-arg)))
1607 ;; Expand now so we get the current buffer's defaults
1608 (setq filename (expand-file-name filename))
1610 ;; If we're compiling a file that's in a buffer and is modified, offer
1611 ;; to save it first.
1613 (let ((b (get-file-buffer (expand-file-name filename))))
1614 (if (and b (buffer-modified-p b)
1615 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1616 (save-excursion (set-buffer b) (save-buffer)))))
1618 ;; Force logging of the file name for each file compiled.
1619 (setq byte-compile-last-logged-file nil)
1620 (let ((byte-compile-current-file filename)
1621 (set-auto-coding-for-load t)
1622 target-file input-buffer output-buffer
1623 byte-compile-dest-file)
1624 (setq target-file (byte-compile-dest-file filename))
1625 (setq byte-compile-dest-file target-file)
1627 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1628 (set-buffer input-buffer)
1630 (setq buffer-file-coding-system nil)
1631 ;; Always compile an Emacs Lisp file as multibyte
1632 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1633 (set-buffer-multibyte t)
1634 (insert-file-contents filename)
1635 ;; Mimic the way after-insert-file-set-coding can make the
1636 ;; buffer unibyte when visiting this file.
1637 (when (or (eq last-coding-system-used 'no-conversion)
1638 (eq (coding-system-type last-coding-system-used) 5))
1639 ;; For coding systems no-conversion and raw-text...,
1640 ;; edit the buffer as unibyte.
1641 (set-buffer-multibyte nil))
1642 ;; Run hooks including the uncompression hook.
1643 ;; If they change the file name, then change it for the output also.
1644 (let ((buffer-file-name filename)
1645 (default-major-mode 'emacs-lisp-mode)
1646 (enable-local-eval nil))
1648 (setq filename buffer-file-name))
1649 ;; Set the default directory, in case an eval-when-compile uses it.
1650 (setq default-directory (file-name-directory filename)))
1651 ;; Check if the file's local variables explicitly specify not to
1652 ;; compile this file.
1653 (if (with-current-buffer input-buffer no-byte-compile)
1655 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1656 ;; (file-relative-name filename)
1657 ;; (with-current-buffer input-buffer no-byte-compile))
1658 (when (file-exists-p target-file)
1659 (message "%s deleted because of `no-byte-compile: %s'"
1660 (file-relative-name target-file)
1661 (buffer-local-value 'no-byte-compile input-buffer))
1662 (condition-case nil (delete-file target-file) (error nil)))
1663 ;; We successfully didn't compile this file.
1665 (when byte-compile-verbose
1666 (message "Compiling %s..." filename))
1667 (setq byte-compiler-error-flag nil)
1668 ;; It is important that input-buffer not be current at this call,
1669 ;; so that the value of point set in input-buffer
1670 ;; within byte-compile-from-buffer lingers in that buffer.
1672 (save-current-buffer
1673 (byte-compile-from-buffer input-buffer filename)))
1674 (if byte-compiler-error-flag
1676 (when byte-compile-verbose
1677 (message "Compiling %s...done" filename))
1678 (kill-buffer input-buffer)
1679 (with-current-buffer output-buffer
1680 (goto-char (point-max))
1681 (insert "\n") ; aaah, unix.
1682 (let ((vms-stmlf-recfm t))
1683 (if (file-writable-p target-file)
1684 ;; We must disable any code conversion here.
1685 (let ((coding-system-for-write 'no-conversion))
1686 (if (memq system-type '(ms-dos 'windows-nt))
1687 (setq buffer-file-type t))
1688 (when (file-exists-p target-file)
1689 ;; Remove the target before writing it, so that any
1690 ;; hard-links continue to point to the old file (this makes
1691 ;; it possible for installed files to share disk space with
1692 ;; the build tree, without causing problems when emacs-lisp
1693 ;; files in the build tree are recompiled).
1694 (delete-file target-file))
1695 (write-region (point-min) (point-max) target-file))
1696 ;; This is just to give a better error message than write-region
1698 (list "Opening output file"
1699 (if (file-exists-p target-file)
1700 "cannot overwrite file"
1701 "directory not writable or nonexistent")
1703 (kill-buffer (current-buffer)))
1704 (if (and byte-compile-generate-call-tree
1705 (or (eq t byte-compile-generate-call-tree)
1706 (y-or-n-p (format "Report call tree for %s? " filename))))
1708 (display-call-tree filename)))
1713 ;;(defun byte-compile-and-load-file (&optional filename)
1714 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1715 ;;and then load it. The output file's name is made by appending \"c\" to
1716 ;;the end of FILENAME."
1718 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1719 ;; (byte-compile-file filename t)
1720 ;; (let ((current-prefix-arg '(4)))
1721 ;; (call-interactively 'byte-compile-file))))
1723 ;;(defun byte-compile-buffer (&optional buffer)
1724 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1725 ;; (interactive "bByte compile buffer: ")
1726 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1727 ;; (message "Compiling %s..." (buffer-name buffer))
1728 ;; (let* ((filename (or (buffer-file-name buffer)
1729 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1730 ;; (byte-compile-current-file buffer))
1731 ;; (byte-compile-from-buffer buffer nil))
1732 ;; (message "Compiling %s...done" (buffer-name buffer))
1735 ;;; compiling a single function
1737 (defun compile-defun (&optional arg)
1738 "Compile and evaluate the current top-level form.
1739 Print the result in the echo area.
1740 With argument, insert value in current buffer after the form."
1744 (beginning-of-defun)
1745 (let* ((byte-compile-current-file nil)
1746 (byte-compile-current-buffer (current-buffer))
1747 (byte-compile-read-position (point))
1748 (byte-compile-last-position byte-compile-read-position)
1749 (byte-compile-last-warned-form 'nothing)
1751 (let ((read-with-symbol-positions (current-buffer))
1752 (read-symbol-positions-list nil))
1753 (displaying-byte-compile-warnings
1754 (byte-compile-sexp (read (current-buffer))))))))
1756 (message "Compiling from buffer... done.")
1757 (prin1 value (current-buffer))
1759 ((message "%s" (prin1-to-string value)))))))
1762 (defun byte-compile-from-buffer (inbuffer &optional filename)
1763 ;; Filename is used for the loading-into-Emacs-18 error message.
1765 (byte-compile-current-buffer inbuffer)
1766 (byte-compile-read-position nil)
1767 (byte-compile-last-position nil)
1768 ;; Prevent truncation of flonums and lists as we read and print them
1769 (float-output-format nil)
1770 (case-fold-search nil)
1773 ;; Prevent edebug from interfering when we compile
1774 ;; and put the output into a file.
1775 ;; (edebug-all-defs nil)
1776 ;; (edebug-all-forms nil)
1777 ;; Simulate entry to byte-compile-top-level
1778 (byte-compile-constants nil)
1779 (byte-compile-variables nil)
1780 (byte-compile-tag-number 0)
1781 (byte-compile-depth 0)
1782 (byte-compile-maxdepth 0)
1783 (byte-compile-output nil)
1784 ;; This allows us to get the positions of symbols read; it's
1785 ;; new in Emacs 22.1.
1786 (read-with-symbol-positions inbuffer)
1787 (read-symbol-positions-list nil)
1788 ;; #### This is bound in b-c-close-variables.
1789 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1790 ;; byte-compile-warning-types
1791 ;; byte-compile-warnings))
1793 (byte-compile-close-variables
1796 (set-buffer (get-buffer-create " *Compiler Output*")))
1797 (set-buffer-multibyte t)
1799 ;; (emacs-lisp-mode)
1800 (setq case-fold-search nil)
1801 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1802 ;; write files containing binary information specially.
1803 ;; Under most circumstances, such files will be in binary
1804 ;; overwrite mode, so those OS's use that flag to guess how
1805 ;; they should write their data. Advise them that .elc files
1806 ;; need to be written carefully.
1807 (setq overwrite-mode 'overwrite-mode-binary))
1808 (displaying-byte-compile-warnings
1809 (and filename (byte-compile-insert-header filename inbuffer outbuffer))
1811 (set-buffer inbuffer)
1814 ;; Compile the forms from the input buffer.
1816 (while (progn (skip-chars-forward " \t\n\^l")
1820 (setq byte-compile-read-position (point)
1821 byte-compile-last-position byte-compile-read-position)
1822 (let ((form (read inbuffer)))
1823 (byte-compile-file-form form)))
1824 ;; Compile pending forms at end of file.
1825 (byte-compile-flush-pending)
1826 ;; Make warnings about unresolved functions
1827 ;; give the end of the file as their position.
1828 (setq byte-compile-last-position (point-max))
1829 (byte-compile-warn-about-unresolved-functions)
1830 ;; Should we always do this? When calling multiple files, it
1831 ;; would be useful to delay this warning until all have
1833 (setq byte-compile-unresolved-functions nil))
1834 ;; Fix up the header at the front of the output
1835 ;; if the buffer contains multibyte characters.
1836 (and filename (byte-compile-fix-header filename inbuffer outbuffer))))
1839 (defun byte-compile-fix-header (filename inbuffer outbuffer)
1840 (with-current-buffer outbuffer
1841 ;; See if the buffer has any multibyte characters.
1842 (when (< (point-max) (position-bytes (point-max)))
1843 (when (byte-compile-version-cond byte-compile-compatibility)
1844 (error "Version-18 compatibility not valid with multibyte characters"))
1845 (goto-char (point-min))
1846 ;; Find the comment that describes the version test.
1847 (search-forward "\n;;; This file")
1849 (narrow-to-region (point) (point-max))
1850 ;; Find the line of ballast semicolons.
1851 (search-forward ";;;;;;;;;;")
1854 (narrow-to-region (point-min) (point))
1855 (let ((old-header-end (point))
1857 (goto-char (point-min))
1858 (delete-region (point) (progn (re-search-forward "^(")
1861 (insert ";;; This file contains utf-8 non-ASCII characters\n"
1862 ";;; and therefore cannot be loaded into Emacs 21 or earlier.\n")
1863 ;; Replace "19" or "19.29" with "22", twice.
1864 (re-search-forward "19\\(\\.[0-9]+\\)")
1865 (replace-match "23")
1866 (re-search-forward "19\\(\\.[0-9]+\\)")
1867 (replace-match "23")
1868 ;; Now compensate for the change in size,
1869 ;; to make sure all positions in the file remain valid.
1870 (setq delta (- (point-max) old-header-end))
1871 (goto-char (point-max))
1873 (delete-char delta)))))
1875 (defun byte-compile-insert-header (filename inbuffer outbuffer)
1876 (set-buffer inbuffer)
1877 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1878 (dynamic byte-compile-dynamic))
1879 (set-buffer outbuffer)
1881 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1882 ;; that is the file-format version number (18, 19, 20, or 23) as a
1883 ;; byte, followed by some nulls. The primary motivation for doing
1884 ;; this is to get some binary characters up in the first line of
1885 ;; the file so that `diff' will simply say "Binary files differ"
1886 ;; instead of actually doing a diff of two .elc files. An extra
1887 ;; benefit is that you can add this to /etc/magic:
1889 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1890 ;; >4 byte x version %d
1894 (if (byte-compile-version-cond byte-compile-compatibility) 18 23)
1897 (insert ";;; Compiled by "
1898 (or (and (boundp 'user-mail-address) user-mail-address)
1899 (concat (user-login-name) "@" (system-name)))
1901 (current-time-string) "\n;;; from file " filename "\n")
1902 (insert ";;; in Emacs version " emacs-version "\n")
1905 ((eq byte-optimize 'source) "with source-level optimization only")
1906 ((eq byte-optimize 'byte) "with byte-level optimization only")
1907 (byte-optimize "with all optimizations")
1908 (t "without optimization"))
1909 (if (byte-compile-version-cond byte-compile-compatibility)
1910 "; compiled with Emacs 18 compatibility.\n"
1913 (insert ";;; Function definitions are lazy-loaded.\n"))
1914 (if (not (byte-compile-version-cond byte-compile-compatibility))
1915 (let (intro-string minimum-version)
1916 ;; Figure out which Emacs version to require,
1917 ;; and what comment to use to explain why.
1918 ;; Note that this fails to take account of whether
1919 ;; the buffer contains multibyte characters. We may have to
1920 ;; compensate at the end in byte-compile-fix-header.
1921 (if dynamic-docstrings
1923 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1924 minimum-version "19.29")
1926 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1927 minimum-version "19"))
1928 ;; Now insert the comment and the error check.
1932 ;; Have to check if emacs-version is bound so that this works
1933 ;; in files loaded early in loadup.el.
1934 "(if (and (boundp 'emacs-version)\n"
1935 ;; If there is a name at the end of emacs-version,
1936 ;; don't try to check the version number.
1937 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1938 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1939 (format "\t (string-lessp emacs-version \"%s\")))\n"
1942 ;; prin1-to-string is used to quote backslashes.
1943 (substring (prin1-to-string (file-name-nondirectory filename))
1945 (format "' was compiled for Emacs %s or later\"))\n\n"
1947 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1948 ;; can delete them so as to keep the buffer positions
1949 ;; constant for the actual compiled code.
1950 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1951 ;; Here if we want Emacs 18 compatibility.
1952 (when dynamic-docstrings
1953 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1954 (when byte-compile-dynamic
1955 (error "Version-18 compatibility doesn't support dynamic byte code"))
1956 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1959 (defun byte-compile-output-file-form (form)
1960 ;; writes the given form to the output buffer, being careful of docstrings
1961 ;; in defun, defmacro, defvar, defconst, autoload and
1962 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1963 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1964 ;; it does not pay to first build the defalias in defmumble and then parse
1966 (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload
1967 custom-declare-variable))
1968 (stringp (nth 3 form)))
1969 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
1971 '(autoload custom-declare-variable)))
1972 (let ((print-escape-newlines t)
1977 (princ "\n" outbuffer)
1978 (prin1 form outbuffer)
1981 (defvar print-gensym-alist) ;Used before print-circle existed.
1983 (defun byte-compile-output-docform (preface name info form specindex quoted)
1984 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1985 If PREFACE and NAME are non-nil, print them too,
1986 before INFO and the FORM but after the doc string itself.
1987 If SPECINDEX is non-nil, it is the index in FORM
1988 of the function bytecode string. In that case,
1989 we output that argument and the following argument (the constants vector)
1990 together, for lazy loading.
1991 QUOTED says that we have to put a quote before the
1992 list that represents a doc string reference.
1993 `autoload' and `custom-declare-variable' need that."
1994 ;; We need to examine byte-compile-dynamic-docstrings
1995 ;; in the input buffer (now current), not in the output buffer.
1996 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
1998 (prog1 (current-buffer)
1999 (set-buffer outbuffer)
2002 ;; Insert the doc string, and make it a comment with #@LENGTH.
2003 (and (>= (nth 1 info) 0)
2005 (not byte-compile-compatibility)
2007 ;; Make the doc string start at beginning of line
2008 ;; for make-docfile's sake.
2011 (byte-compile-output-as-comment
2012 (nth (nth 1 info) form) nil))
2013 (setq position (- (position-bytes position) (point-min) -1))
2014 ;; If the doc string starts with * (a user variable),
2016 (if (and (stringp (nth (nth 1 info) form))
2017 (> (length (nth (nth 1 info) form)) 0)
2018 (eq (aref (nth (nth 1 info) form) 0) ?*))
2019 (setq position (- position)))))
2024 (prin1 name outbuffer)))
2026 (let ((print-escape-newlines t)
2028 ;; For compatibility with code before print-circle,
2029 ;; use a cons cell to say that we want
2030 ;; print-gensym-alist not to be cleared
2031 ;; between calls to print functions.
2033 print-gensym-alist ; was used before print-circle existed.
2034 (print-continuous-numbering t)
2037 (prin1 (car form) outbuffer)
2038 (while (setq form (cdr form))
2039 (setq index (1+ index))
2041 (cond ((and (numberp specindex) (= index specindex)
2042 ;; Don't handle the definition dynamically
2043 ;; if it refers (or might refer)
2044 ;; to objects already output
2045 ;; (for instance, gensyms in the arg list).
2047 (dotimes (i (length print-number-table))
2048 (if (aref print-number-table i)
2051 ;; Output the byte code and constants specially
2052 ;; for lazy dynamic loading.
2054 (byte-compile-output-as-comment
2055 (cons (car form) (nth 1 form))
2057 (setq position (- (position-bytes position) (point-min) -1))
2058 (princ (format "(#$ . %d) nil" position) outbuffer)
2059 (setq form (cdr form))
2060 (setq index (1+ index))))
2061 ((= index (nth 1 info))
2063 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2066 (let ((print-escape-newlines nil))
2067 (goto-char (prog1 (1+ (point))
2068 (prin1 (car form) outbuffer)))
2070 (goto-char (point-max)))))
2072 (prin1 (car form) outbuffer)))))
2073 (insert (nth 2 info))))))
2076 (defun byte-compile-keep-pending (form &optional handler)
2077 (if (memq byte-optimize '(t source))
2078 (setq form (byte-optimize-form form t)))
2080 (let ((for-effect t))
2081 ;; To avoid consing up monstrously large forms at load time, we split
2082 ;; the output regularly.
2083 (and (memq (car-safe form) '(fset defalias))
2084 (nthcdr 300 byte-compile-output)
2085 (byte-compile-flush-pending))
2086 (funcall handler form)
2088 (byte-compile-discard)))
2089 (byte-compile-form form t))
2092 (defun byte-compile-flush-pending ()
2093 (if byte-compile-output
2094 (let ((form (byte-compile-out-toplevel t 'file)))
2095 (cond ((eq (car-safe form) 'progn)
2096 (mapc 'byte-compile-output-file-form (cdr form)))
2098 (byte-compile-output-file-form form)))
2099 (setq byte-compile-constants nil
2100 byte-compile-variables nil
2101 byte-compile-depth 0
2102 byte-compile-maxdepth 0
2103 byte-compile-output nil))))
2105 (defun byte-compile-file-form (form)
2106 (let ((byte-compile-current-form nil) ; close over this for warnings.
2110 (byte-compile-keep-pending form))
2111 ((and (symbolp (car form))
2112 (setq handler (get (car form) 'byte-hunk-handler)))
2113 (cond ((setq form (funcall handler form))
2114 (byte-compile-flush-pending)
2115 (byte-compile-output-file-form form))))
2116 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2117 (byte-compile-keep-pending form))
2119 (byte-compile-file-form form)))))
2121 ;; Functions and variables with doc strings must be output separately,
2122 ;; so make-docfile can recognise them. Most other things can be output
2125 (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2126 (defun byte-compile-file-form-defsubst (form)
2127 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2128 (setq byte-compile-current-form (nth 1 form))
2129 (byte-compile-warn "defsubst `%s' was used before it was defined"
2131 (byte-compile-file-form
2132 (macroexpand form byte-compile-macro-environment))
2133 ;; Return nil so the form is not output twice.
2136 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2137 (defun byte-compile-file-form-autoload (form)
2138 (and (let ((form form))
2139 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2140 (null form)) ;Constants only
2141 (eval (nth 5 form)) ;Macro
2142 (eval form)) ;Define the autoload.
2143 ;; Avoid undefined function warnings for the autoload.
2144 (if (and (consp (nth 1 form))
2145 (eq (car (nth 1 form)) 'quote)
2146 (consp (cdr (nth 1 form)))
2147 (symbolp (nth 1 (nth 1 form))))
2148 (push (cons (nth 1 (nth 1 form))
2149 (cons 'autoload (cdr (cdr form))))
2150 byte-compile-function-environment))
2151 (if (stringp (nth 3 form))
2153 ;; No doc string, so we can compile this as a normal form.
2154 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2156 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2157 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2158 (defun byte-compile-file-form-defvar (form)
2159 (if (null (nth 3 form))
2160 ;; Since there is no doc string, we can compile this as a normal form,
2161 ;; and not do a file-boundary.
2162 (byte-compile-keep-pending form)
2163 (when (memq 'free-vars byte-compile-warnings)
2164 (push (nth 1 form) byte-compile-bound-variables)
2165 (if (eq (car form) 'defconst)
2166 (push (nth 1 form) byte-compile-const-variables)))
2167 (cond ((consp (nth 2 form))
2168 (setq form (copy-sequence form))
2169 (setcar (cdr (cdr form))
2170 (byte-compile-top-level (nth 2 form) nil 'file))))
2173 (put 'custom-declare-variable 'byte-hunk-handler
2174 'byte-compile-file-form-custom-declare-variable)
2175 (defun byte-compile-file-form-custom-declare-variable (form)
2176 (when (memq 'callargs byte-compile-warnings)
2177 (byte-compile-nogroup-warn form))
2178 (when (memq 'free-vars byte-compile-warnings)
2179 (push (nth 1 (nth 1 form)) byte-compile-bound-variables))
2180 (let ((tail (nthcdr 4 form)))
2182 ;; If there are any (function (lambda ...)) expressions, compile
2184 (if (and (consp (car tail))
2185 (eq (car (car tail)) 'function)
2186 (consp (nth 1 (car tail))))
2187 (setcar tail (byte-compile-lambda (nth 1 (car tail))))
2188 ;; Likewise for a bare lambda.
2189 (if (and (consp (car tail))
2190 (eq (car (car tail)) 'lambda))
2191 (setcar tail (byte-compile-lambda (car tail)))))
2192 (setq tail (cdr tail))))
2195 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2196 (defun byte-compile-file-form-require (form)
2197 (let ((old-load-list current-load-list)
2198 (args (mapcar 'eval (cdr form))))
2199 (apply 'require args)
2200 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2201 (if (member (car args) '("cl" cl))
2202 (setq byte-compile-warnings
2203 (remq 'cl-functions byte-compile-warnings))))
2204 (byte-compile-keep-pending form 'byte-compile-normal-call))
2206 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2207 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2208 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2209 (defun byte-compile-file-form-progn (form)
2210 (mapc 'byte-compile-file-form (cdr form))
2211 ;; Return nil so the forms are not output twice.
2214 ;; This handler is not necessary, but it makes the output from dont-compile
2215 ;; and similar macros cleaner.
2216 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2217 (defun byte-compile-file-form-eval (form)
2218 (if (eq (car-safe (nth 1 form)) 'quote)
2219 (nth 1 (nth 1 form))
2220 (byte-compile-keep-pending form)))
2222 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2223 (defun byte-compile-file-form-defun (form)
2224 (byte-compile-file-form-defmumble form nil))
2226 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2227 (defun byte-compile-file-form-defmacro (form)
2228 (byte-compile-file-form-defmumble form t))
2230 (defun byte-compile-file-form-defmumble (form macrop)
2231 (let* ((name (car (cdr form)))
2232 (this-kind (if macrop 'byte-compile-macro-environment
2233 'byte-compile-function-environment))
2234 (that-kind (if macrop 'byte-compile-function-environment
2235 'byte-compile-macro-environment))
2236 (this-one (assq name (symbol-value this-kind)))
2237 (that-one (assq name (symbol-value that-kind)))
2238 (byte-compile-free-references nil)
2239 (byte-compile-free-assignments nil))
2240 (byte-compile-set-symbol-position name)
2241 ;; When a function or macro is defined, add it to the call tree so that
2242 ;; we can tell when functions are not used.
2243 (if byte-compile-generate-call-tree
2244 (or (assq name byte-compile-call-tree)
2245 (setq byte-compile-call-tree
2246 (cons (list name nil nil) byte-compile-call-tree))))
2248 (setq byte-compile-current-form name) ; for warnings
2249 (if (memq 'redefine byte-compile-warnings)
2250 (byte-compile-arglist-warn form macrop))
2251 (if byte-compile-verbose
2252 (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
2254 (if (and (memq 'redefine byte-compile-warnings)
2255 ;; don't warn when compiling the stubs in byte-run...
2256 (not (assq (nth 1 form)
2257 byte-compile-initial-macro-environment)))
2259 "`%s' defined multiple times, as both function and macro"
2261 (setcdr that-one nil))
2263 (when (and (memq 'redefine byte-compile-warnings)
2264 ;; hack: don't warn when compiling the magic internal
2265 ;; byte-compiler macros in byte-run.el...
2266 (not (assq (nth 1 form)
2267 byte-compile-initial-macro-environment)))
2268 (byte-compile-warn "%s `%s' defined multiple times in this file"
2269 (if macrop "macro" "function")
2271 ((and (fboundp name)
2272 (eq (car-safe (symbol-function name))
2273 (if macrop 'lambda 'macro)))
2274 (when (memq 'redefine byte-compile-warnings)
2275 (byte-compile-warn "%s `%s' being redefined as a %s"
2276 (if macrop "function" "macro")
2278 (if macrop "macro" "function")))
2279 ;; shadow existing definition
2281 (cons (cons name nil) (symbol-value this-kind))))
2283 (let ((body (nthcdr 3 form)))
2284 (when (and (stringp (car body))
2285 (symbolp (car-safe (cdr-safe body)))
2286 (car-safe (cdr-safe body))
2287 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2288 (byte-compile-set-symbol-position (nth 1 form))
2289 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2292 ;; Generate code for declarations in macro definitions.
2293 ;; Remove declarations from the body of the macro definition.
2295 (let ((tail (nthcdr 2 form)))
2296 (when (stringp (car (cdr tail)))
2297 (setq tail (cdr tail)))
2298 (while (and (consp (car (cdr tail)))
2299 (eq (car (car (cdr tail))) 'declare))
2300 (let ((declaration (car (cdr tail))))
2301 (setcdr tail (cdr (cdr tail)))
2302 (princ `(if macro-declaration-function
2303 (funcall macro-declaration-function
2304 ',name ',declaration))
2307 (let* ((new-one (byte-compile-lambda (cons 'lambda (nthcdr 2 form))))
2308 (code (byte-compile-byte-code-maker new-one)))
2310 (setcdr this-one new-one)
2312 (cons (cons name new-one) (symbol-value this-kind))))
2313 (if (and (stringp (nth 3 form))
2314 (eq 'quote (car-safe code))
2315 (eq 'lambda (car-safe (nth 1 code))))
2317 (cons name (cdr (nth 1 code))))
2318 (byte-compile-flush-pending)
2319 (if (not (stringp (nth 3 form)))
2320 ;; No doc string. Provide -1 as the "doc string index"
2321 ;; so that no element will be treated as a doc string.
2322 (byte-compile-output-docform
2323 (if (byte-compile-version-cond byte-compile-compatibility)
2324 "\n(fset '" "\n(defalias '")
2327 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2328 ((eq (car code) 'quote)
2330 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2331 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2333 (and (atom code) byte-compile-dynamic
2336 ;; Output the form by hand, that's much simpler than having
2337 ;; b-c-output-file-form analyze the defalias.
2338 (byte-compile-output-docform
2339 (if (byte-compile-version-cond byte-compile-compatibility)
2340 "\n(fset '" "\n(defalias '")
2343 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2344 ((eq (car code) 'quote)
2346 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2347 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2349 (and (atom code) byte-compile-dynamic
2352 (princ ")" outbuffer)
2355 ;; Print Lisp object EXP in the output file, inside a comment,
2356 ;; and return the file position it will have.
2357 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2358 (defun byte-compile-output-as-comment (exp quoted)
2359 (let ((position (point)))
2361 (prog1 (current-buffer)
2362 (set-buffer outbuffer)
2364 ;; Insert EXP, and make it a comment with #@LENGTH.
2367 (prin1 exp outbuffer)
2368 (princ exp outbuffer))
2369 (goto-char position)
2370 ;; Quote certain special characters as needed.
2371 ;; get_doc_string in doc.c does the unquoting.
2372 (while (search-forward "\^A" nil t)
2373 (replace-match "\^A\^A" t t))
2374 (goto-char position)
2375 (while (search-forward "\000" nil t)
2376 (replace-match "\^A0" t t))
2377 (goto-char position)
2378 (while (search-forward "\037" nil t)
2379 (replace-match "\^A_" t t))
2380 (goto-char (point-max))
2382 (goto-char position)
2383 (insert "#@" (format "%d" (- (position-bytes (point-max))
2384 (position-bytes position))))
2386 ;; Save the file position of the object.
2387 ;; Note we should add 1 to skip the space
2388 ;; that we inserted before the actual doc string,
2389 ;; and subtract 1 to convert from an 1-origin Emacs position
2390 ;; to a file position; they cancel.
2391 (setq position (point))
2392 (goto-char (point-max))))
2398 (defun byte-compile (form)
2399 "If FORM is a symbol, byte-compile its function definition.
2400 If FORM is a lambda or a macro, byte-compile it as a function."
2401 (displaying-byte-compile-warnings
2402 (byte-compile-close-variables
2403 (let* ((fun (if (symbolp form)
2404 (and (fboundp form) (symbol-function form))
2406 (macro (eq (car-safe fun) 'macro)))
2408 (setq fun (cdr fun)))
2409 (cond ((eq (car-safe fun) 'lambda)
2411 (cons 'macro (byte-compile-lambda fun))
2412 (byte-compile-lambda fun)))
2417 (defun byte-compile-sexp (sexp)
2418 "Compile and return SEXP."
2419 (displaying-byte-compile-warnings
2420 (byte-compile-close-variables
2421 (byte-compile-top-level sexp))))
2423 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2424 (defun byte-compile-byte-code-maker (fun)
2426 ((byte-compile-version-cond byte-compile-compatibility)
2427 ;; Return (quote (lambda ...)).
2428 (list 'quote (byte-compile-byte-code-unmake fun)))
2429 ;; ## atom is faster than compiled-func-p.
2430 ((atom fun) ; compiled function.
2431 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2432 ;; would have produced a lambda.
2434 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2435 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2437 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2438 (null (cdr (memq tmp fun))))
2439 ;; Generate a make-byte-code call.
2440 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2441 (nconc (list 'make-byte-code
2442 (list 'quote (nth 1 fun)) ;arglist
2446 (cond ((stringp (nth 2 fun))
2447 (list (nth 2 fun))) ;doc
2451 (list (if (or (null (nth 1 interactive))
2452 (stringp (nth 1 interactive)))
2454 ;; Interactive spec is a list or a variable
2455 ;; (if it is correct).
2456 (list 'quote (nth 1 interactive))))))))
2457 ;; a non-compiled function (probably trivial)
2458 (list 'quote fun))))))
2460 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2461 (defun byte-compile-byte-code-unmake (function)
2462 (if (consp function)
2463 function;;It already is a lambda.
2464 (setq function (append function nil)) ; turn it into a list
2465 (nconc (list 'lambda (nth 0 function))
2466 (and (nth 4 function) (list (nth 4 function)))
2467 (if (nthcdr 5 function)
2468 (list (cons 'interactive (if (nth 5 function)
2469 (nthcdr 5 function)))))
2470 (list (list 'byte-code
2471 (nth 1 function) (nth 2 function)
2472 (nth 3 function))))))
2475 (defun byte-compile-check-lambda-list (list)
2476 "Check lambda-list LIST for errors."
2479 (let ((arg (car list)))
2481 (byte-compile-set-symbol-position arg))
2482 (cond ((or (not (symbolp arg))
2483 (byte-compile-const-symbol-p arg t))
2484 (error "Invalid lambda variable %s" arg))
2487 (error "&rest without variable name"))
2489 (error "Garbage following &rest VAR in lambda-list")))
2490 ((eq arg '&optional)
2492 (error "Variable name missing after &optional")))
2494 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2497 (setq list (cdr list)))))
2500 ;; Byte-compile a lambda-expression and return a valid function.
2501 ;; The value is usually a compiled function but may be the original
2502 ;; lambda-expression.
2503 (defun byte-compile-lambda (fun)
2504 (unless (eq 'lambda (car-safe fun))
2505 (error "Not a lambda list: %S" fun))
2506 (byte-compile-set-symbol-position 'lambda)
2507 (byte-compile-check-lambda-list (nth 1 fun))
2508 (let* ((arglist (nth 1 fun))
2509 (byte-compile-bound-variables
2510 (nconc (and (memq 'free-vars byte-compile-warnings)
2511 (delq '&rest (delq '&optional (copy-sequence arglist))))
2512 byte-compile-bound-variables))
2513 (body (cdr (cdr fun)))
2514 (doc (if (stringp (car body))
2516 ;; Discard the doc string
2517 ;; unless it is the last element of the body.
2519 (setq body (cdr body))))))
2520 (int (assq 'interactive body)))
2521 ;; Process the interactive spec.
2523 (byte-compile-set-symbol-position 'interactive)
2524 ;; Skip (interactive) if it is in front (the most usual location).
2525 (if (eq int (car body))
2526 (setq body (cdr body)))
2527 (cond ((consp (cdr int))
2529 (byte-compile-warn "malformed interactive spec: %s"
2530 (prin1-to-string int)))
2531 ;; If the interactive spec is a call to `list', don't
2532 ;; compile it, because `call-interactively' looks at the
2533 ;; args of `list'. Actually, compile it to get warnings,
2534 ;; but don't use the result.
2535 (let ((form (nth 1 int)))
2536 (while (memq (car-safe form) '(let let* progn save-excursion))
2537 (while (consp (cdr form))
2538 (setq form (cdr form)))
2539 (setq form (car form)))
2540 (if (eq (car-safe form) 'list)
2541 (byte-compile-top-level (nth 1 int))
2542 (setq int (list 'interactive
2543 (byte-compile-top-level (nth 1 int)))))))
2545 (byte-compile-warn "malformed interactive spec: %s"
2546 (prin1-to-string int)))))
2547 ;; Process the body.
2548 (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
2549 ;; Build the actual byte-coded function.
2550 (if (and (eq 'byte-code (car-safe compiled))
2551 (not (byte-compile-version-cond
2552 byte-compile-compatibility)))
2553 (apply 'make-byte-code
2554 (append (list arglist)
2555 ;; byte-string, constants-vector, stack depth
2557 ;; optionally, the doc string.
2560 ;; optionally, the interactive spec.
2562 (list (nth 1 int)))))
2564 (nconc (if int (list int))
2565 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2566 (compiled (list compiled)))))
2567 (nconc (list 'lambda arglist)
2568 (if (or doc (stringp (car compiled)))
2569 (cons doc (cond (compiled)
2573 (defun byte-compile-constants-vector ()
2574 ;; Builds the constants-vector from the current variables and constants.
2575 ;; This modifies the constants from (const . nil) to (const . offset).
2576 ;; To keep the byte-codes to look up the vector as short as possible:
2577 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2578 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2579 ;; Next variables again, to get 2-byte codes for variable lookup.
2580 ;; The rest of the constants and variables need 3-byte byte-codes.
2582 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2583 (other (nreverse byte-compile-constants)) ; vars often are used most.
2585 (limits '(5 ; Use the 1-byte varref codes,
2586 63 ; 1-constlim ; 1-byte byte-constant codes,
2587 255 ; 2-byte varref codes,
2588 65535)) ; 3-byte codes for the rest.
2590 (while (or rest other)
2591 (setq limit (car limits))
2592 (while (and rest (not (eq i limit)))
2593 (if (setq tmp (assq (car (car rest)) ret))
2594 (setcdr (car rest) (cdr tmp))
2595 (setcdr (car rest) (setq i (1+ i)))
2596 (setq ret (cons (car rest) ret)))
2597 (setq rest (cdr rest)))
2598 (setq limits (cdr limits)
2600 (setq other rest))))
2601 (apply 'vector (nreverse (mapcar 'car ret)))))
2603 ;; Given an expression FORM, compile it and return an equivalent byte-code
2604 ;; expression (a call to the function byte-code).
2605 (defun byte-compile-top-level (form &optional for-effect output-type)
2606 ;; OUTPUT-TYPE advises about how form is expected to be used:
2607 ;; 'eval or nil -> a single form,
2608 ;; 'progn or t -> a list of forms,
2609 ;; 'lambda -> body of a lambda,
2610 ;; 'file -> used at file-level.
2611 (let ((byte-compile-constants nil)
2612 (byte-compile-variables nil)
2613 (byte-compile-tag-number 0)
2614 (byte-compile-depth 0)
2615 (byte-compile-maxdepth 0)
2616 (byte-compile-output nil))
2617 (if (memq byte-optimize '(t source))
2618 (setq form (byte-optimize-form form for-effect)))
2619 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2620 (setq form (nth 1 form)))
2621 (if (and (eq 'byte-code (car-safe form))
2622 (not (memq byte-optimize '(t byte)))
2623 (stringp (nth 1 form)) (vectorp (nth 2 form))
2624 (natnump (nth 3 form)))
2626 (byte-compile-form form for-effect)
2627 (byte-compile-out-toplevel for-effect output-type))))
2629 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2631 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2632 (if (eq (car (car byte-compile-output)) 'byte-discard)
2633 (setq byte-compile-output (cdr byte-compile-output))
2634 (byte-compile-push-constant
2635 ;; Push any constant - preferably one which already is used, and
2636 ;; a number or symbol - ie not some big sequence. The return value
2637 ;; isn't returned, but it would be a shame if some textually large
2638 ;; constant was not optimized away because we chose to return it.
2639 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2640 (let ((tmp (reverse byte-compile-constants)))
2641 (while (and tmp (not (or (symbolp (caar tmp))
2642 (numberp (caar tmp)))))
2643 (setq tmp (cdr tmp)))
2645 (byte-compile-out 'byte-return 0)
2646 (setq byte-compile-output (nreverse byte-compile-output))
2647 (if (memq byte-optimize '(t byte))
2648 (setq byte-compile-output
2649 (byte-optimize-lapcode byte-compile-output for-effect)))
2651 ;; Decompile trivial functions:
2652 ;; only constants and variables, or a single funcall except in lambdas.
2653 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2654 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2655 ;; Note that even (quote foo) must be parsed just as any subr by the
2656 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2657 ;; What to leave uncompiled:
2658 ;; lambda -> never. we used to leave it uncompiled if the body was
2659 ;; a single atom, but that causes confusion if the docstring
2660 ;; uses the (file . pos) syntax. Besides, now that we have
2661 ;; the Lisp_Compiled type, the compiled form is faster.
2662 ;; eval -> atom, quote or (function atom atom atom)
2663 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2664 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2666 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2669 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2670 ((or (eq output-type 'lambda)
2671 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2672 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2673 (not (setq tmp (assq 'byte-return byte-compile-output)))
2675 (setq rest (nreverse
2676 (cdr (memq tmp (reverse byte-compile-output)))))
2678 ((memq (car (car rest)) '(byte-varref byte-constant))
2679 (setq tmp (car (cdr (car rest))))
2680 (if (if (eq (car (car rest)) 'byte-constant)
2683 (not (byte-compile-const-symbol-p tmp)))))
2685 (setq body (cons (list 'quote tmp) body)))
2686 (setq body (cons tmp body))))
2688 ;; Allow a funcall if at most one atom follows it.
2689 (null (nthcdr 3 rest))
2690 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2691 (or (null (cdr rest))
2692 (and (memq output-type '(file progn t))
2694 (eq (car (nth 1 rest)) 'byte-discard)
2695 (progn (setq rest (cdr rest)) t))))
2696 (setq maycall nil) ; Only allow one real function call.
2697 (setq body (nreverse body))
2699 (if (and (eq tmp 'funcall)
2700 (eq (car-safe (car body)) 'quote))
2701 (cons (nth 1 (car body)) (cdr body))
2703 (or (eq output-type 'file)
2704 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2705 (setq rest (cdr rest)))
2707 (let ((byte-compile-vector (byte-compile-constants-vector)))
2708 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2709 byte-compile-vector byte-compile-maxdepth)))
2710 ;; it's a trivial function
2711 ((cdr body) (cons 'progn (nreverse body)))
2714 ;; Given BODY, compile it and return a new body.
2715 (defun byte-compile-top-level-body (body &optional for-effect)
2716 (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
2717 (cond ((eq (car-safe body) 'progn)
2722 ;; This is the recursive entry point for compiling each subform of an
2724 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2725 ;; before terminating (ie no value will be left on the stack).
2726 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2727 ;; which does not leave a value on the stack, and then set for-effect to nil
2728 ;; (to prevent byte-compile-form from outputting the byte-discard).
2729 ;; If a handler wants to call another handler, it should do so via
2730 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2731 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2733 (defun byte-compile-form (form &optional for-effect)
2734 (setq form (macroexpand form byte-compile-macro-environment))
2735 (cond ((not (consp form))
2736 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2737 (when (symbolp form)
2738 (byte-compile-set-symbol-position form))
2739 (byte-compile-constant form))
2740 ((and for-effect byte-compile-delete-errors)
2741 (when (symbolp form)
2742 (byte-compile-set-symbol-position form))
2743 (setq for-effect nil))
2744 (t (byte-compile-variable-ref 'byte-varref form))))
2745 ((symbolp (car form))
2746 (let* ((fn (car form))
2747 (handler (get fn 'byte-compile)))
2748 (when (byte-compile-const-symbol-p fn)
2749 (byte-compile-warn "`%s' called as a function" fn))
2750 (and (memq 'interactive-only byte-compile-warnings)
2751 (memq fn byte-compile-interactive-only-functions)
2752 (byte-compile-warn "`%s' used from Lisp code\n\
2753 That command is designed for interactive use only" fn))
2755 (or (not (byte-compile-version-cond
2756 byte-compile-compatibility))
2757 (not (get (get fn 'byte-opcode) 'emacs19-opcode))))
2759 (byte-compile-set-symbol-position fn)
2760 (funcall handler form))
2761 (when (memq 'callargs byte-compile-warnings)
2762 (if (memq fn '(custom-declare-group custom-declare-variable custom-declare-face))
2763 (byte-compile-nogroup-warn form))
2764 (byte-compile-callargs-warn form))
2765 (byte-compile-normal-call form))
2766 (if (memq 'cl-functions byte-compile-warnings)
2767 (byte-compile-cl-warn form))))
2768 ((and (or (byte-code-function-p (car form))
2769 (eq (car-safe (car form)) 'lambda))
2770 ;; if the form comes out the same way it went in, that's
2771 ;; because it was malformed, and we couldn't unfold it.
2772 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2773 (byte-compile-form form for-effect)
2774 (setq for-effect nil))
2775 ((byte-compile-normal-call form)))
2777 (byte-compile-discard)))
2779 (defun byte-compile-normal-call (form)
2780 (if byte-compile-generate-call-tree
2781 (byte-compile-annotate-call-tree form))
2782 (byte-compile-push-constant (car form))
2783 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2784 (byte-compile-out 'byte-call (length (cdr form))))
2786 (defun byte-compile-variable-ref (base-op var)
2788 (byte-compile-set-symbol-position var))
2789 (if (or (not (symbolp var))
2790 (byte-compile-const-symbol-p var (not (eq base-op 'byte-varref))))
2792 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2793 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2794 (t "variable reference to %s `%s'"))
2795 (if (symbolp var) "constant" "nonvariable")
2796 (prin1-to-string var))
2797 (if (and (get var 'byte-obsolete-variable)
2798 (memq 'obsolete byte-compile-warnings)
2799 (not (eq var byte-compile-not-obsolete-var)))
2800 (let* ((ob (get var 'byte-obsolete-variable))
2802 (byte-compile-warn "`%s' is an obsolete variable%s; %s" var
2803 (if when (concat " (as of Emacs " when ")") "")
2804 (if (stringp (car ob))
2806 (format "use `%s' instead." (car ob))))))
2807 (if (memq 'free-vars byte-compile-warnings)
2808 (if (eq base-op 'byte-varbind)
2809 (push var byte-compile-bound-variables)
2811 (memq var byte-compile-bound-variables)
2812 (if (eq base-op 'byte-varset)
2813 (or (memq var byte-compile-free-assignments)
2815 (byte-compile-warn "assignment to free variable `%s'" var)
2816 (push var byte-compile-free-assignments)))
2817 (or (memq var byte-compile-free-references)
2819 (byte-compile-warn "reference to free variable `%s'" var)
2820 (push var byte-compile-free-references))))))))
2821 (let ((tmp (assq var byte-compile-variables)))
2823 (setq tmp (list var))
2824 (push tmp byte-compile-variables))
2825 (byte-compile-out base-op tmp)))
2827 (defmacro byte-compile-get-constant (const)
2828 `(or (if (stringp ,const)
2829 (assoc-default ,const byte-compile-constants
2830 'equal-including-properties nil)
2831 (assq ,const byte-compile-constants))
2832 (car (setq byte-compile-constants
2833 (cons (list ,const) byte-compile-constants)))))
2835 ;; Use this when the value of a form is a constant. This obeys for-effect.
2836 (defun byte-compile-constant (const)
2838 (setq for-effect nil)
2839 (when (symbolp const)
2840 (byte-compile-set-symbol-position const))
2841 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2843 ;; Use this for a constant that is not the value of its containing form.
2844 ;; This ignores for-effect.
2845 (defun byte-compile-push-constant (const)
2846 (let ((for-effect nil))
2847 (inline (byte-compile-constant const))))
2850 ;; Compile those primitive ordinary functions
2851 ;; which have special byte codes just for speed.
2853 (defmacro byte-defop-compiler (function &optional compile-handler)
2854 ;; add a compiler-form for FUNCTION.
2855 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2856 ;; the opcode to be used. If function is a list, the first element
2857 ;; is the function and the second element is the bytecode-symbol.
2858 ;; The second element may be nil, meaning there is no opcode.
2859 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2860 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2861 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2863 (if (symbolp function)
2864 (setq opcode (intern (concat "byte-" (symbol-name function))))
2865 (setq opcode (car (cdr function))
2866 function (car function)))
2868 (list 'put (list 'quote function) ''byte-compile
2870 (or (cdr (assq compile-handler
2871 '((0 . byte-compile-no-args)
2872 (1 . byte-compile-one-arg)
2873 (2 . byte-compile-two-args)
2874 (3 . byte-compile-three-args)
2875 (0-1 . byte-compile-zero-or-one-arg)
2876 (1-2 . byte-compile-one-or-two-args)
2877 (2-3 . byte-compile-two-or-three-args)
2880 (intern (concat "byte-compile-"
2881 (symbol-name function))))))))
2884 (list 'put (list 'quote function)
2885 ''byte-opcode (list 'quote opcode))
2886 (list 'put (list 'quote opcode)
2887 ''byte-opcode-invert (list 'quote function)))
2890 (defmacro byte-defop-compiler19 (function &optional compile-handler)
2891 ;; Just like byte-defop-compiler, but defines an opcode that will only
2892 ;; be used when byte-compile-compatibility is false.
2893 (if (and (byte-compile-single-version)
2894 byte-compile-compatibility)
2895 ;; #### instead of doing nothing, this should do some remprops,
2896 ;; #### to protect against the case where a single-version compiler
2897 ;; #### is loaded into a world that has contained a multi-version one.
2902 (or (car (cdr-safe function))
2903 (intern (concat "byte-"
2904 (symbol-name (or (car-safe function) function))))))
2906 (list 'byte-defop-compiler function compile-handler))))
2908 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
2909 (list 'byte-defop-compiler (list function nil) compile-handler))
2912 (put 'byte-call 'byte-opcode-invert 'funcall)
2913 (put 'byte-list1 'byte-opcode-invert 'list)
2914 (put 'byte-list2 'byte-opcode-invert 'list)
2915 (put 'byte-list3 'byte-opcode-invert 'list)
2916 (put 'byte-list4 'byte-opcode-invert 'list)
2917 (put 'byte-listN 'byte-opcode-invert 'list)
2918 (put 'byte-concat2 'byte-opcode-invert 'concat)
2919 (put 'byte-concat3 'byte-opcode-invert 'concat)
2920 (put 'byte-concat4 'byte-opcode-invert 'concat)
2921 (put 'byte-concatN 'byte-opcode-invert 'concat)
2922 (put 'byte-insertN 'byte-opcode-invert 'insert)
2924 (byte-defop-compiler point 0)
2925 ;;(byte-defop-compiler mark 0) ;; obsolete
2926 (byte-defop-compiler point-max 0)
2927 (byte-defop-compiler point-min 0)
2928 (byte-defop-compiler following-char 0)
2929 (byte-defop-compiler preceding-char 0)
2930 (byte-defop-compiler current-column 0)
2931 (byte-defop-compiler eolp 0)
2932 (byte-defop-compiler eobp 0)
2933 (byte-defop-compiler bolp 0)
2934 (byte-defop-compiler bobp 0)
2935 (byte-defop-compiler current-buffer 0)
2936 ;;(byte-defop-compiler read-char 0) ;; obsolete
2937 (byte-defop-compiler interactive-p 0)
2938 (byte-defop-compiler19 widen 0)
2939 (byte-defop-compiler19 end-of-line 0-1)
2940 (byte-defop-compiler19 forward-char 0-1)
2941 (byte-defop-compiler19 forward-line 0-1)
2942 (byte-defop-compiler symbolp 1)
2943 (byte-defop-compiler consp 1)
2944 (byte-defop-compiler stringp 1)
2945 (byte-defop-compiler listp 1)
2946 (byte-defop-compiler not 1)
2947 (byte-defop-compiler (null byte-not) 1)
2948 (byte-defop-compiler car 1)
2949 (byte-defop-compiler cdr 1)
2950 (byte-defop-compiler length 1)
2951 (byte-defop-compiler symbol-value 1)
2952 (byte-defop-compiler symbol-function 1)
2953 (byte-defop-compiler (1+ byte-add1) 1)
2954 (byte-defop-compiler (1- byte-sub1) 1)
2955 (byte-defop-compiler goto-char 1)
2956 (byte-defop-compiler char-after 0-1)
2957 (byte-defop-compiler set-buffer 1)
2958 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2959 (byte-defop-compiler19 forward-word 0-1)
2960 (byte-defop-compiler19 char-syntax 1)
2961 (byte-defop-compiler19 nreverse 1)
2962 (byte-defop-compiler19 car-safe 1)
2963 (byte-defop-compiler19 cdr-safe 1)
2964 (byte-defop-compiler19 numberp 1)
2965 (byte-defop-compiler19 integerp 1)
2966 (byte-defop-compiler19 skip-chars-forward 1-2)
2967 (byte-defop-compiler19 skip-chars-backward 1-2)
2968 (byte-defop-compiler eq 2)
2969 (byte-defop-compiler memq 2)
2970 (byte-defop-compiler cons 2)
2971 (byte-defop-compiler aref 2)
2972 (byte-defop-compiler set 2)
2973 (byte-defop-compiler (= byte-eqlsign) 2)
2974 (byte-defop-compiler (< byte-lss) 2)
2975 (byte-defop-compiler (> byte-gtr) 2)
2976 (byte-defop-compiler (<= byte-leq) 2)
2977 (byte-defop-compiler (>= byte-geq) 2)
2978 (byte-defop-compiler get 2)
2979 (byte-defop-compiler nth 2)
2980 (byte-defop-compiler substring 2-3)
2981 (byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
2982 (byte-defop-compiler19 set-marker 2-3)
2983 (byte-defop-compiler19 match-beginning 1)
2984 (byte-defop-compiler19 match-end 1)
2985 (byte-defop-compiler19 upcase 1)
2986 (byte-defop-compiler19 downcase 1)
2987 (byte-defop-compiler19 string= 2)
2988 (byte-defop-compiler19 string< 2)
2989 (byte-defop-compiler19 (string-equal byte-string=) 2)
2990 (byte-defop-compiler19 (string-lessp byte-string<) 2)
2991 (byte-defop-compiler19 equal 2)
2992 (byte-defop-compiler19 nthcdr 2)
2993 (byte-defop-compiler19 elt 2)
2994 (byte-defop-compiler19 member 2)
2995 (byte-defop-compiler19 assq 2)
2996 (byte-defop-compiler19 (rplaca byte-setcar) 2)
2997 (byte-defop-compiler19 (rplacd byte-setcdr) 2)
2998 (byte-defop-compiler19 setcar 2)
2999 (byte-defop-compiler19 setcdr 2)
3000 (byte-defop-compiler19 buffer-substring 2)
3001 (byte-defop-compiler19 delete-region 2)
3002 (byte-defop-compiler19 narrow-to-region 2)
3003 (byte-defop-compiler19 (% byte-rem) 2)
3004 (byte-defop-compiler aset 3)
3006 (byte-defop-compiler max byte-compile-associative)
3007 (byte-defop-compiler min byte-compile-associative)
3008 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3009 (byte-defop-compiler19 (* byte-mult) byte-compile-associative)
3011 ;;####(byte-defop-compiler19 move-to-column 1)
3012 (byte-defop-compiler-1 interactive byte-compile-noop)
3015 (defun byte-compile-subr-wrong-args (form n)
3016 (byte-compile-set-symbol-position (car form))
3017 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3018 (car form) (length (cdr form))
3019 (if (= 1 (length (cdr form))) "" "s") n)
3020 ;; get run-time wrong-number-of-args error.
3021 (byte-compile-normal-call form))
3023 (defun byte-compile-no-args (form)
3024 (if (not (= (length form) 1))
3025 (byte-compile-subr-wrong-args form "none")
3026 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3028 (defun byte-compile-one-arg (form)
3029 (if (not (= (length form) 2))
3030 (byte-compile-subr-wrong-args form 1)
3031 (byte-compile-form (car (cdr form))) ;; Push the argument
3032 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3034 (defun byte-compile-two-args (form)
3035 (if (not (= (length form) 3))
3036 (byte-compile-subr-wrong-args form 2)
3037 (byte-compile-form (car (cdr form))) ;; Push the arguments
3038 (byte-compile-form (nth 2 form))
3039 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3041 (defun byte-compile-three-args (form)
3042 (if (not (= (length form) 4))
3043 (byte-compile-subr-wrong-args form 3)
3044 (byte-compile-form (car (cdr form))) ;; Push the arguments
3045 (byte-compile-form (nth 2 form))
3046 (byte-compile-form (nth 3 form))
3047 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3049 (defun byte-compile-zero-or-one-arg (form)
3050 (let ((len (length form)))
3051 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3052 ((= len 2) (byte-compile-one-arg form))
3053 (t (byte-compile-subr-wrong-args form "0-1")))))
3055 (defun byte-compile-one-or-two-args (form)
3056 (let ((len (length form)))
3057 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3058 ((= len 3) (byte-compile-two-args form))
3059 (t (byte-compile-subr-wrong-args form "1-2")))))
3061 (defun byte-compile-two-or-three-args (form)
3062 (let ((len (length form)))
3063 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3064 ((= len 4) (byte-compile-three-args form))
3065 (t (byte-compile-subr-wrong-args form "2-3")))))
3067 (defun byte-compile-noop (form)
3068 (byte-compile-constant nil))
3070 (defun byte-compile-discard ()
3071 (byte-compile-out 'byte-discard 0))
3074 ;; Compile a function that accepts one or more args and is right-associative.
3075 ;; We do it by left-associativity so that the operations
3076 ;; are done in the same order as in interpreted code.
3077 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3078 ;; in order to convert markers to numbers, and trigger expected errors.
3079 (defun byte-compile-associative (form)
3081 (let ((opcode (get (car form) 'byte-opcode))
3082 (args (copy-sequence (cdr form))))
3083 (byte-compile-form (car args))
3084 (setq args (cdr args))
3085 (or args (setq args '(0)
3086 opcode (get '+ 'byte-opcode)))
3088 (byte-compile-form arg)
3089 (byte-compile-out opcode 0)))
3090 (byte-compile-constant (eval form))))
3093 ;; more complicated compiler macros
3095 (byte-defop-compiler list)
3096 (byte-defop-compiler concat)
3097 (byte-defop-compiler fset)
3098 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3099 (byte-defop-compiler indent-to)
3100 (byte-defop-compiler insert)
3101 (byte-defop-compiler-1 function byte-compile-function-form)
3102 (byte-defop-compiler-1 - byte-compile-minus)
3103 (byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
3104 (byte-defop-compiler19 nconc)
3106 (defun byte-compile-list (form)
3107 (let ((count (length (cdr form))))
3109 (byte-compile-constant nil))
3111 (mapc 'byte-compile-form (cdr form))
3113 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3114 ((and (< count 256) (not (byte-compile-version-cond
3115 byte-compile-compatibility)))
3116 (mapc 'byte-compile-form (cdr form))
3117 (byte-compile-out 'byte-listN count))
3118 (t (byte-compile-normal-call form)))))
3120 (defun byte-compile-concat (form)
3121 (let ((count (length (cdr form))))
3122 (cond ((and (< 1 count) (< count 5))
3123 (mapc 'byte-compile-form (cdr form))
3125 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3127 ;; Concat of one arg is not a no-op if arg is not a string.
3129 (byte-compile-form ""))
3130 ((and (< count 256) (not (byte-compile-version-cond
3131 byte-compile-compatibility)))
3132 (mapc 'byte-compile-form (cdr form))
3133 (byte-compile-out 'byte-concatN count))
3134 ((byte-compile-normal-call form)))))
3136 (defun byte-compile-minus (form)
3137 (if (null (setq form (cdr form)))
3138 (byte-compile-constant 0)
3139 (byte-compile-form (car form))
3141 (while (setq form (cdr form))
3142 (byte-compile-form (car form))
3143 (byte-compile-out 'byte-diff 0))
3144 (byte-compile-out 'byte-negate 0))))
3146 (defun byte-compile-quo (form)
3147 (let ((len (length form)))
3149 (byte-compile-subr-wrong-args form "2 or more"))
3151 (byte-compile-form (car (setq form (cdr form))))
3152 (while (setq form (cdr form))
3153 (byte-compile-form (car form))
3154 (byte-compile-out 'byte-quo 0))))))
3156 (defun byte-compile-nconc (form)
3157 (let ((len (length form)))
3159 (byte-compile-constant nil))
3161 ;; nconc of one arg is a noop, even if that arg isn't a list.
3162 (byte-compile-form (nth 1 form)))
3164 (byte-compile-form (car (setq form (cdr form))))
3165 (while (setq form (cdr form))
3166 (byte-compile-form (car form))
3167 (byte-compile-out 'byte-nconc 0))))))
3169 (defun byte-compile-fset (form)
3170 ;; warn about forms like (fset 'foo '(lambda () ...))
3171 ;; (where the lambda expression is non-trivial...)
3172 (let ((fn (nth 2 form))
3174 (if (and (eq (car-safe fn) 'quote)
3175 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3177 (setq body (cdr (cdr fn)))
3178 (if (stringp (car body)) (setq body (cdr body)))
3179 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3180 (if (and (consp (car body))
3181 (not (eq 'byte-code (car (car body)))))
3183 "A quoted lambda form is the second argument of `fset'. This is probably
3184 not what you want, as that lambda cannot be compiled. Consider using
3185 the syntax (function (lambda (...) ...)) instead.")))))
3186 (byte-compile-two-args form))
3188 (defun byte-compile-funarg (form)
3189 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3190 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3191 (byte-compile-normal-call
3192 (let ((fn (nth 1 form)))
3193 (if (and (eq (car-safe fn) 'quote)
3194 (eq (car-safe (nth 1 fn)) 'lambda))
3196 (cons (cons 'function (cdr fn))
3200 (defun byte-compile-funarg-2 (form)
3201 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3202 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3203 (byte-compile-normal-call
3204 (let ((fn (nth 2 form)))
3205 (if (and (eq (car-safe fn) 'quote)
3206 (eq (car-safe (nth 1 fn)) 'lambda))
3209 (cons (cons 'function (cdr fn))
3210 (cdr (cdr (cdr form))))))
3213 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3214 ;; Otherwise it will be incompatible with the interpreter,
3215 ;; and (funcall (function foo)) will lose with autoloads.
3217 (defun byte-compile-function-form (form)
3218 (byte-compile-constant
3219 (cond ((symbolp (nth 1 form))
3221 ;; If we're not allowed to use #[] syntax, then output a form like
3222 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3223 ;; In this situation, calling make-byte-code at run-time will usually
3224 ;; be less efficient than processing a call to byte-code.
3225 ((byte-compile-version-cond byte-compile-compatibility)
3226 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
3227 ((byte-compile-lambda (nth 1 form))))))
3229 (defun byte-compile-indent-to (form)
3230 (let ((len (length form)))
3232 (byte-compile-form (car (cdr form)))
3233 (byte-compile-out 'byte-indent-to 0))
3235 ;; no opcode for 2-arg case.
3236 (byte-compile-normal-call form))
3238 (byte-compile-subr-wrong-args form "1-2")))))
3240 (defun byte-compile-insert (form)
3241 (cond ((null (cdr form))
3242 (byte-compile-constant nil))
3243 ((and (not (byte-compile-version-cond
3244 byte-compile-compatibility))
3245 (<= (length form) 256))
3246 (mapc 'byte-compile-form (cdr form))
3247 (if (cdr (cdr form))
3248 (byte-compile-out 'byte-insertN (length (cdr form)))
3249 (byte-compile-out 'byte-insert 0)))
3250 ((memq t (mapcar 'consp (cdr (cdr form))))
3251 (byte-compile-normal-call form))
3252 ;; We can split it; there is no function call after inserting 1st arg.
3254 (while (setq form (cdr form))
3255 (byte-compile-form (car form))
3256 (byte-compile-out 'byte-insert 0)
3258 (byte-compile-discard))))))
3261 (byte-defop-compiler-1 setq)
3262 (byte-defop-compiler-1 setq-default)
3263 (byte-defop-compiler-1 quote)
3264 (byte-defop-compiler-1 quote-form)
3266 (defun byte-compile-setq (form)
3267 (let ((args (cdr form)))
3270 (byte-compile-form (car (cdr args)))
3271 (or for-effect (cdr (cdr args))
3272 (byte-compile-out 'byte-dup 0))
3273 (byte-compile-variable-ref 'byte-varset (car args))
3274 (setq args (cdr (cdr args))))
3275 ;; (setq), with no arguments.
3276 (byte-compile-form nil for-effect))
3277 (setq for-effect nil)))
3279 (defun byte-compile-setq-default (form)
3280 (let ((args (cdr form))
3284 (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
3286 (setq args (cdr (cdr args))))
3287 (byte-compile-form (cons 'progn (nreverse setters)))))
3289 (defun byte-compile-quote (form)
3290 (byte-compile-constant (car (cdr form))))
3292 (defun byte-compile-quote-form (form)
3293 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3296 ;;; control structures
3298 (defun byte-compile-body (body &optional for-effect)
3300 (byte-compile-form (car body) t)
3301 (setq body (cdr body)))
3302 (byte-compile-form (car body) for-effect))
3304 (defsubst byte-compile-body-do-effect (body)
3305 (byte-compile-body body for-effect)
3306 (setq for-effect nil))
3308 (defsubst byte-compile-form-do-effect (form)
3309 (byte-compile-form form for-effect)
3310 (setq for-effect nil))
3312 (byte-defop-compiler-1 inline byte-compile-progn)
3313 (byte-defop-compiler-1 progn)
3314 (byte-defop-compiler-1 prog1)
3315 (byte-defop-compiler-1 prog2)
3316 (byte-defop-compiler-1 if)
3317 (byte-defop-compiler-1 cond)
3318 (byte-defop-compiler-1 and)
3319 (byte-defop-compiler-1 or)
3320 (byte-defop-compiler-1 while)
3321 (byte-defop-compiler-1 funcall)
3322 (byte-defop-compiler-1 apply byte-compile-funarg)
3323 (byte-defop-compiler-1 mapcar byte-compile-funarg)
3324 (byte-defop-compiler-1 mapatoms byte-compile-funarg)
3325 (byte-defop-compiler-1 mapconcat byte-compile-funarg)
3326 (byte-defop-compiler-1 mapc byte-compile-funarg)
3327 (byte-defop-compiler-1 maphash byte-compile-funarg)
3328 (byte-defop-compiler-1 map-char-table byte-compile-funarg)
3329 (byte-defop-compiler-1 map-char-table byte-compile-funarg-2)
3330 ;; map-charset-chars should be funarg but has optional third arg
3331 (byte-defop-compiler-1 sort byte-compile-funarg-2)
3332 (byte-defop-compiler-1 let)
3333 (byte-defop-compiler-1 let*)
3335 (defun byte-compile-progn (form)
3336 (byte-compile-body-do-effect (cdr form)))
3338 (defun byte-compile-prog1 (form)
3339 (byte-compile-form-do-effect (car (cdr form)))
3340 (byte-compile-body (cdr (cdr form)) t))
3342 (defun byte-compile-prog2 (form)
3343 (byte-compile-form (nth 1 form) t)
3344 (byte-compile-form-do-effect (nth 2 form))
3345 (byte-compile-body (cdr (cdr (cdr form))) t))
3347 (defmacro byte-compile-goto-if (cond discard tag)
3350 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3351 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3354 (defmacro byte-compile-maybe-guarded (condition &rest body)
3355 "Execute forms in BODY, potentially guarded by CONDITION.
3356 CONDITION is a variable whose value is a test in an `if' or `cond'.
3357 BODY is the code to compile first arm of the if or the body of the
3358 cond clause. If CONDITION's value is of the form (fboundp 'foo)
3359 or (boundp 'foo), the relevant warnings from BODY about foo's
3360 being undefined will be suppressed.
3362 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3363 that suppresses all warnings during execution of BODY."
3364 (declare (indent 1) (debug t))
3366 (if (eq 'fboundp (car-safe ,condition))
3367 (and (eq 'quote (car-safe (nth 1 ,condition)))
3368 ;; Ignore if the symbol is already on the
3370 (not (assq (nth 1 (nth 1 ,condition)) ; the relevant symbol
3371 byte-compile-unresolved-functions))
3372 (nth 1 (nth 1 ,condition)))))
3373 (bound (if (or (eq 'boundp (car-safe ,condition))
3374 (eq 'default-boundp (car-safe ,condition)))
3375 (and (eq 'quote (car-safe (nth 1 ,condition)))
3376 (nth 1 (nth 1 ,condition)))))
3377 ;; Maybe add to the bound list.
3378 (byte-compile-bound-variables
3380 (cons bound byte-compile-bound-variables)
3381 byte-compile-bound-variables))
3382 ;; Suppress all warnings, for code not used in Emacs.
3383 (byte-compile-warnings
3384 (if (member ,condition '((featurep 'xemacs)
3385 (not (featurep 'emacs))))
3386 nil byte-compile-warnings)))
3389 ;; Maybe remove the function symbol from the unresolved list.
3391 (setq byte-compile-unresolved-functions
3392 (delq (assq fbound byte-compile-unresolved-functions)
3393 byte-compile-unresolved-functions))))))
3395 (defun byte-compile-if (form)
3396 (byte-compile-form (car (cdr form)))
3397 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3398 ;; and avoid warnings about the relevent symbols in the consequent.
3399 (let ((clause (nth 1 form))
3400 (donetag (byte-compile-make-tag)))
3401 (if (null (nthcdr 3 form))
3404 (byte-compile-goto-if nil for-effect donetag)
3405 (byte-compile-maybe-guarded clause
3406 (byte-compile-form (nth 2 form) for-effect))
3407 (byte-compile-out-tag donetag))
3408 (let ((elsetag (byte-compile-make-tag)))
3409 (byte-compile-goto 'byte-goto-if-nil elsetag)
3410 (byte-compile-maybe-guarded clause
3411 (byte-compile-form (nth 2 form) for-effect))
3412 (byte-compile-goto 'byte-goto donetag)
3413 (byte-compile-out-tag elsetag)
3414 (byte-compile-maybe-guarded (list 'not clause)
3415 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3416 (byte-compile-out-tag donetag))))
3417 (setq for-effect nil))
3419 (defun byte-compile-cond (clauses)
3420 (let ((donetag (byte-compile-make-tag))
3422 (while (setq clauses (cdr clauses))
3423 (setq clause (car clauses))
3424 (cond ((or (eq (car clause) t)
3425 (and (eq (car-safe (car clause)) 'quote)
3426 (car-safe (cdr-safe (car clause)))))
3427 ;; Unconditional clause
3428 (setq clause (cons t clause)
3431 (byte-compile-form (car clause))
3432 (if (null (cdr clause))
3433 ;; First clause is a singleton.
3434 (byte-compile-goto-if t for-effect donetag)
3435 (setq nexttag (byte-compile-make-tag))
3436 (byte-compile-goto 'byte-goto-if-nil nexttag)
3437 (byte-compile-maybe-guarded (car clause)
3438 (byte-compile-body (cdr clause) for-effect))
3439 (byte-compile-goto 'byte-goto donetag)
3440 (byte-compile-out-tag nexttag)))))
3442 (let ((guard (car clause)))
3443 (and (cdr clause) (not (eq guard t))
3444 (progn (byte-compile-form guard)
3445 (byte-compile-goto-if nil for-effect donetag)
3446 (setq clause (cdr clause))))
3447 (byte-compile-maybe-guarded guard
3448 (byte-compile-body-do-effect clause)))
3449 (byte-compile-out-tag donetag)))
3451 (defun byte-compile-and (form)
3452 (let ((failtag (byte-compile-make-tag))
3455 (byte-compile-form-do-effect t)
3456 (byte-compile-and-recursion args failtag))))
3458 ;; Handle compilation of a nontrivial `and' call.
3459 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3460 (defun byte-compile-and-recursion (rest failtag)
3463 (byte-compile-form (car rest))
3464 (byte-compile-goto-if nil for-effect failtag)
3465 (byte-compile-maybe-guarded (car rest)
3466 (byte-compile-and-recursion (cdr rest) failtag)))
3467 (byte-compile-form-do-effect (car rest))
3468 (byte-compile-out-tag failtag)))
3470 (defun byte-compile-or (form)
3471 (let ((wintag (byte-compile-make-tag))
3474 (byte-compile-form-do-effect nil)
3475 (byte-compile-or-recursion args wintag))))
3477 ;; Handle compilation of a nontrivial `or' call.
3478 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3479 (defun byte-compile-or-recursion (rest wintag)
3482 (byte-compile-form (car rest))
3483 (byte-compile-goto-if t for-effect wintag)
3484 (byte-compile-maybe-guarded (list 'not (car rest))
3485 (byte-compile-or-recursion (cdr rest) wintag)))
3486 (byte-compile-form-do-effect (car rest))
3487 (byte-compile-out-tag wintag)))
3489 (defun byte-compile-while (form)
3490 (let ((endtag (byte-compile-make-tag))
3491 (looptag (byte-compile-make-tag)))
3492 (byte-compile-out-tag looptag)
3493 (byte-compile-form (car (cdr form)))
3494 (byte-compile-goto-if nil for-effect endtag)
3495 (byte-compile-body (cdr (cdr form)) t)
3496 (byte-compile-goto 'byte-goto looptag)
3497 (byte-compile-out-tag endtag)
3498 (setq for-effect nil)))
3500 (defun byte-compile-funcall (form)
3501 (mapc 'byte-compile-form (cdr form))
3502 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3505 (defun byte-compile-let (form)
3506 ;; First compute the binding values in the old scope.
3507 (let ((varlist (car (cdr form))))
3508 (dolist (var varlist)
3510 (byte-compile-form (car (cdr var)))
3511 (byte-compile-push-constant nil))))
3512 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3513 (varlist (reverse (car (cdr form)))))
3514 (dolist (var varlist)
3515 (byte-compile-variable-ref 'byte-varbind (if (consp var) (car var) var)))
3516 (byte-compile-body-do-effect (cdr (cdr form)))
3517 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3519 (defun byte-compile-let* (form)
3520 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3521 (varlist (copy-sequence (car (cdr form)))))
3522 (dolist (var varlist)
3524 (byte-compile-push-constant nil)
3525 (byte-compile-form (car (cdr var)))
3526 (setq var (car var)))
3527 (byte-compile-variable-ref 'byte-varbind var))
3528 (byte-compile-body-do-effect (cdr (cdr form)))
3529 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3532 (byte-defop-compiler-1 /= byte-compile-negated)
3533 (byte-defop-compiler-1 atom byte-compile-negated)
3534 (byte-defop-compiler-1 nlistp byte-compile-negated)
3536 (put '/= 'byte-compile-negated-op '=)
3537 (put 'atom 'byte-compile-negated-op 'consp)
3538 (put 'nlistp 'byte-compile-negated-op 'listp)
3540 (defun byte-compile-negated (form)
3541 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3543 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3544 (defun byte-compile-negation-optimizer (form)
3545 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3546 (byte-compile-set-symbol-position (car form))
3548 (cons (or (get (car form) 'byte-compile-negated-op)
3550 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3554 ;;; other tricky macro-like special-forms
3556 (byte-defop-compiler-1 catch)
3557 (byte-defop-compiler-1 unwind-protect)
3558 (byte-defop-compiler-1 condition-case)
3559 (byte-defop-compiler-1 save-excursion)
3560 (byte-defop-compiler-1 save-current-buffer)
3561 (byte-defop-compiler-1 save-restriction)
3562 (byte-defop-compiler-1 save-window-excursion)
3563 (byte-defop-compiler-1 with-output-to-temp-buffer)
3564 (byte-defop-compiler-1 track-mouse)
3566 (defun byte-compile-catch (form)
3567 (byte-compile-form (car (cdr form)))
3568 (byte-compile-push-constant
3569 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3570 (byte-compile-out 'byte-catch 0))
3572 (defun byte-compile-unwind-protect (form)
3573 (byte-compile-push-constant
3574 (byte-compile-top-level-body (cdr (cdr form)) t))
3575 (byte-compile-out 'byte-unwind-protect 0)
3576 (byte-compile-form-do-effect (car (cdr form)))
3577 (byte-compile-out 'byte-unbind 1))
3579 (defun byte-compile-track-mouse (form)
3581 `(funcall '(lambda nil
3582 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
3584 (defun byte-compile-condition-case (form)
3585 (let* ((var (nth 1 form))
3586 (byte-compile-bound-variables
3587 (if var (cons var byte-compile-bound-variables)
3588 byte-compile-bound-variables)))
3589 (byte-compile-set-symbol-position 'condition-case)
3590 (unless (symbolp var)
3592 "`%s' is not a variable-name or nil (in condition-case)" var))
3593 (byte-compile-push-constant var)
3594 (byte-compile-push-constant (byte-compile-top-level
3595 (nth 2 form) for-effect))
3596 (let ((clauses (cdr (cdr (cdr form))))
3599 (let* ((clause (car clauses))
3600 (condition (car clause)))
3601 (cond ((not (or (symbolp condition)
3602 (and (listp condition)
3603 (let ((syms condition) (ok t))
3605 (if (not (symbolp (car syms)))
3607 (setq syms (cdr syms)))
3610 "`%s' is not a condition name or list of such (in condition-case)"
3611 (prin1-to-string condition)))
3612 ;; ((not (or (eq condition 't)
3613 ;; (and (stringp (get condition 'error-message))
3614 ;; (consp (get condition 'error-conditions)))))
3615 ;; (byte-compile-warn
3616 ;; "`%s' is not a known condition name (in condition-case)"
3619 (setq compiled-clauses
3620 (cons (cons condition
3621 (byte-compile-top-level-body
3622 (cdr clause) for-effect))
3624 (setq clauses (cdr clauses)))
3625 (byte-compile-push-constant (nreverse compiled-clauses)))
3626 (byte-compile-out 'byte-condition-case 0)))
3629 (defun byte-compile-save-excursion (form)
3630 (byte-compile-out 'byte-save-excursion 0)
3631 (byte-compile-body-do-effect (cdr form))
3632 (byte-compile-out 'byte-unbind 1))
3634 (defun byte-compile-save-restriction (form)
3635 (byte-compile-out 'byte-save-restriction 0)
3636 (byte-compile-body-do-effect (cdr form))
3637 (byte-compile-out 'byte-unbind 1))
3639 (defun byte-compile-save-current-buffer (form)
3640 (byte-compile-out 'byte-save-current-buffer 0)
3641 (byte-compile-body-do-effect (cdr form))
3642 (byte-compile-out 'byte-unbind 1))
3644 (defun byte-compile-save-window-excursion (form)
3645 (byte-compile-push-constant
3646 (byte-compile-top-level-body (cdr form) for-effect))
3647 (byte-compile-out 'byte-save-window-excursion 0))
3649 (defun byte-compile-with-output-to-temp-buffer (form)
3650 (byte-compile-form (car (cdr form)))
3651 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3652 (byte-compile-body (cdr (cdr form)))
3653 (byte-compile-out 'byte-temp-output-buffer-show 0))
3655 ;;; top-level forms elsewhere
3657 (byte-defop-compiler-1 defun)
3658 (byte-defop-compiler-1 defmacro)
3659 (byte-defop-compiler-1 defvar)
3660 (byte-defop-compiler-1 defconst byte-compile-defvar)
3661 (byte-defop-compiler-1 autoload)
3662 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
3664 (defun byte-compile-defun (form)
3665 ;; This is not used for file-level defuns with doc strings.
3666 (if (symbolp (car form))
3667 (byte-compile-set-symbol-position (car form))
3668 (byte-compile-set-symbol-position 'defun)
3669 (error "defun name must be a symbol, not %s" (car form)))
3670 (if (byte-compile-version-cond byte-compile-compatibility)
3672 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3674 (list 'quote (nth 1 form))
3675 (byte-compile-byte-code-maker
3676 (byte-compile-lambda (cons 'lambda (cdr (cdr form)))))))
3677 (byte-compile-discard))
3678 ;; We prefer to generate a defalias form so it will record the function
3679 ;; definition just like interpreting a defun.
3682 (list 'quote (nth 1 form))
3683 (byte-compile-byte-code-maker
3684 (byte-compile-lambda (cons 'lambda (cdr (cdr form))))))
3686 (byte-compile-constant (nth 1 form)))
3688 (defun byte-compile-defmacro (form)
3689 ;; This is not used for file-level defmacros with doc strings.
3690 (byte-compile-body-do-effect
3691 (list (list 'fset (list 'quote (nth 1 form))
3692 (let ((code (byte-compile-byte-code-maker
3693 (byte-compile-lambda
3694 (cons 'lambda (cdr (cdr form)))))))
3695 (if (eq (car-safe code) 'make-byte-code)
3696 (list 'cons ''macro code)
3697 (list 'quote (cons 'macro (eval code))))))
3698 (list 'quote (nth 1 form)))))
3700 (defun byte-compile-defvar (form)
3701 ;; This is not used for file-level defvar/consts with doc strings.
3702 (let ((fun (nth 0 form))
3704 (value (nth 2 form))
3705 (string (nth 3 form)))
3706 (byte-compile-set-symbol-position fun)
3707 (when (or (> (length form) 4)
3708 (and (eq fun 'defconst) (null (cddr form))))
3709 (let ((ncall (length (cdr form))))
3711 "`%s' called with %d argument%s, but %s %s"
3713 (if (= 1 ncall) "" "s")
3714 (if (< ncall 2) "requires" "accepts only")
3716 (when (memq 'free-vars byte-compile-warnings)
3717 (push var byte-compile-bound-variables)
3718 (if (eq fun 'defconst)
3719 (push var byte-compile-const-variables)))
3720 (byte-compile-body-do-effect
3722 ;; Put the defined variable in this library's load-history entry
3723 ;; just as a real defvar would, but only in top-level forms.
3724 (when (and (cddr form) (null byte-compile-current-form))
3725 `(push ',var current-load-list))
3726 (when (> (length form) 3)
3727 (when (and string (not (stringp string)))
3728 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3730 `(put ',var 'variable-documentation ,string))
3731 (if (cddr form) ; `value' provided
3732 (let ((byte-compile-not-obsolete-var var))
3733 (if (eq fun 'defconst)
3734 ;; `defconst' sets `var' unconditionally.
3735 (let ((tmp (make-symbol "defconst-tmp-var")))
3736 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3738 ;; `defvar' sets `var' only when unbound.
3739 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
3740 (when (eq fun 'defconst)
3741 ;; This will signal an appropriate error at runtime.
3745 (defun byte-compile-autoload (form)
3746 (byte-compile-set-symbol-position 'autoload)
3747 (and (byte-compile-constp (nth 1 form))
3748 (byte-compile-constp (nth 5 form))
3749 (eval (nth 5 form)) ; macro-p
3750 (not (fboundp (eval (nth 1 form))))
3752 "The compiler ignores `autoload' except at top level. You should
3753 probably put the autoload of the macro `%s' at top-level."
3754 (eval (nth 1 form))))
3755 (byte-compile-normal-call form))
3757 ;; Lambdas in valid places are handled as special cases by various code.
3758 ;; The ones that remain are errors.
3759 (defun byte-compile-lambda-form (form)
3760 (byte-compile-set-symbol-position 'lambda)
3761 (error "`lambda' used as function name is invalid"))
3763 ;; Compile normally, but deal with warnings for the function being defined.
3764 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3765 (defun byte-compile-file-form-defalias (form)
3766 (if (and (consp (cdr form)) (consp (nth 1 form))
3767 (eq (car (nth 1 form)) 'quote)
3768 (consp (cdr (nth 1 form)))
3769 (symbolp (nth 1 (nth 1 form))))
3771 (and (consp (nthcdr 2 form))
3772 (consp (nth 2 form))
3773 (eq (car (nth 2 form)) 'quote)
3774 (consp (cdr (nth 2 form)))
3775 (symbolp (nth 1 (nth 2 form))))))
3776 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
3777 (push (cons (nth 1 (nth 1 form))
3778 (if constant (nth 1 (nth 2 form)) t))
3779 byte-compile-function-environment)))
3780 (byte-compile-normal-call form))
3782 ;; Turn off warnings about prior calls to the function being defalias'd.
3783 ;; This could be smarter and compare those calls with
3784 ;; the function it is being aliased to.
3785 (defun byte-compile-defalias-warn (new)
3786 (let ((calls (assq new byte-compile-unresolved-functions)))
3788 (setq byte-compile-unresolved-functions
3789 (delq calls byte-compile-unresolved-functions)))))
3791 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3792 (defun byte-compile-no-warnings (form)
3793 (let (byte-compile-warnings)
3794 (byte-compile-form (cons 'progn (cdr form)))))
3796 ;; Warn about misuses of make-variable-buffer-local.
3797 (byte-defop-compiler-1 make-variable-buffer-local byte-compile-make-variable-buffer-local)
3798 (defun byte-compile-make-variable-buffer-local (form)
3799 (if (eq (car-safe (car-safe (cdr-safe form))) 'quote)
3801 "`make-variable-buffer-local' should be called at toplevel"))
3802 (byte-compile-normal-call form))
3803 (put 'make-variable-buffer-local
3804 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
3805 (defun byte-compile-form-make-variable-buffer-local (form)
3806 (byte-compile-keep-pending form 'byte-compile-normal-call))
3811 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3812 ;; optimization to have the 'TAG as a part of the tag.
3813 ;; Tags will be (TAG . (tag-number . stack-depth)).
3814 (defun byte-compile-make-tag ()
3815 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
3818 (defun byte-compile-out-tag (tag)
3819 (setq byte-compile-output (cons tag byte-compile-output))
3822 ;; ## remove this someday
3823 (and byte-compile-depth
3824 (not (= (cdr (cdr tag)) byte-compile-depth))
3825 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
3826 (setq byte-compile-depth (cdr (cdr tag))))
3827 (setcdr (cdr tag) byte-compile-depth)))
3829 (defun byte-compile-goto (opcode tag)
3830 (push (cons opcode tag) byte-compile-output)
3831 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
3832 (1- byte-compile-depth)
3833 byte-compile-depth))
3834 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
3835 (1- byte-compile-depth))))
3837 (defun byte-compile-out (opcode offset)
3838 (push (cons opcode offset) byte-compile-output)
3839 (cond ((eq opcode 'byte-call)
3840 (setq byte-compile-depth (- byte-compile-depth offset)))
3841 ((eq opcode 'byte-return)
3842 ;; This is actually an unnecessary case, because there should be
3843 ;; no more opcodes behind byte-return.
3844 (setq byte-compile-depth nil))
3846 (setq byte-compile-depth (+ byte-compile-depth
3847 (or (aref byte-stack+-info
3848 (symbol-value opcode))
3850 byte-compile-maxdepth (max byte-compile-depth
3851 byte-compile-maxdepth))))
3852 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3858 (defun byte-compile-annotate-call-tree (form)
3860 ;; annotate the current call
3861 (if (setq entry (assq (car form) byte-compile-call-tree))
3862 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
3864 (cons byte-compile-current-form (nth 1 entry))))
3865 (setq byte-compile-call-tree
3866 (cons (list (car form) (list byte-compile-current-form) nil)
3867 byte-compile-call-tree)))
3868 ;; annotate the current function
3869 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
3870 (or (memq (car form) (nth 2 entry)) ;called
3871 (setcar (cdr (cdr entry))
3872 (cons (car form) (nth 2 entry))))
3873 (setq byte-compile-call-tree
3874 (cons (list byte-compile-current-form nil (list (car form)))
3875 byte-compile-call-tree)))
3878 ;; Renamed from byte-compile-report-call-tree
3879 ;; to avoid interfering with completion of byte-compile-file.
3881 (defun display-call-tree (&optional filename)
3882 "Display a call graph of a specified file.
3883 This lists which functions have been called, what functions called
3884 them, and what functions they call. The list includes all functions
3885 whose definitions have been compiled in this Emacs session, as well as
3886 all functions called by those functions.
3888 The call graph does not include macros, inline functions, or
3889 primitives that the byte-code interpreter knows about directly \(eq,
3892 The call tree also lists those functions which are not known to be called
3893 \(that is, to which no calls have been compiled\), and which cannot be
3894 invoked interactively."
3896 (message "Generating call tree...")
3897 (with-output-to-temp-buffer "*Call-Tree*"
3898 (set-buffer "*Call-Tree*")
3900 (message "Generating call tree... (sorting on %s)"
3901 byte-compile-call-tree-sort)
3902 (insert "Call tree for "
3903 (cond ((null byte-compile-current-file) (or filename "???"))
3904 ((stringp byte-compile-current-file)
3905 byte-compile-current-file)
3906 (t (buffer-name byte-compile-current-file)))
3908 (prin1-to-string byte-compile-call-tree-sort)
3910 (if byte-compile-call-tree-sort
3911 (setq byte-compile-call-tree
3912 (sort byte-compile-call-tree
3913 (cond ((eq byte-compile-call-tree-sort 'callers)
3914 (function (lambda (x y) (< (length (nth 1 x))
3915 (length (nth 1 y))))))
3916 ((eq byte-compile-call-tree-sort 'calls)
3917 (function (lambda (x y) (< (length (nth 2 x))
3918 (length (nth 2 y))))))
3919 ((eq byte-compile-call-tree-sort 'calls+callers)
3920 (function (lambda (x y) (< (+ (length (nth 1 x))
3922 (+ (length (nth 1 y))
3923 (length (nth 2 y)))))))
3924 ((eq byte-compile-call-tree-sort 'name)
3925 (function (lambda (x y) (string< (car x)
3927 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3928 byte-compile-call-tree-sort))))))
3929 (message "Generating call tree...")
3930 (let ((rest byte-compile-call-tree)
3931 (b (current-buffer))
3935 (prin1 (car (car rest)) b)
3936 (setq callers (nth 1 (car rest))
3937 calls (nth 2 (car rest)))
3939 (cond ((not (fboundp (setq f (car (car rest)))))
3941 " <top level>";; shouldn't insert nil then, actually -sk
3943 ((subrp (setq f (symbol-function f)))
3946 (format " ==> %s" f))
3947 ((byte-code-function-p f)
3948 "<compiled function>")
3950 "<malformed function>")
3951 ((eq 'macro (car f))
3952 (if (or (byte-code-function-p (cdr f))
3953 (assq 'byte-code (cdr (cdr (cdr f)))))
3956 ((assq 'byte-code (cdr (cdr f)))
3957 "<compiled lambda>")
3958 ((eq 'lambda (car f))
3961 (format " (%d callers + %d calls = %d)"
3962 ;; Does the optimizer eliminate common subexpressions?-sk
3965 (+ (length callers) (length calls)))
3969 (insert " called by:\n")
3971 (insert " " (if (car callers)
3972 (mapconcat 'symbol-name callers ", ")
3974 (let ((fill-prefix " "))
3975 (fill-region-as-paragraph p (point)))
3976 (unless (= 0 (current-column))
3980 (insert " calls:\n")
3982 (insert " " (mapconcat 'symbol-name calls ", "))
3983 (let ((fill-prefix " "))
3984 (fill-region-as-paragraph p (point)))
3985 (unless (= 0 (current-column))
3987 (setq rest (cdr rest)))
3989 (message "Generating call tree...(finding uncalled functions...)")
3990 (setq rest byte-compile-call-tree)
3991 (let ((uncalled nil))
3993 (or (nth 1 (car rest))
3994 (null (setq f (car (car rest))))
3995 (functionp (byte-compile-fdefinition f t))
3996 (commandp (byte-compile-fdefinition f nil))
3997 (setq uncalled (cons f uncalled)))
3998 (setq rest (cdr rest)))
4000 (let ((fill-prefix " "))
4001 (insert "Noninteractive functions not known to be called:\n ")
4003 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4004 (fill-region-as-paragraph p (point)))))
4006 (message "Generating call tree...done.")
4011 (defun batch-byte-compile-if-not-done ()
4012 "Like `byte-compile-file' but doesn't recompile if already up to date.
4013 Use this from the command line, with `-batch';
4014 it won't work in an interactive Emacs."
4015 (batch-byte-compile t))
4017 ;;; by crl@newton.purdue.edu
4018 ;;; Only works noninteractively.
4020 (defun batch-byte-compile (&optional noforce)
4021 "Run `byte-compile-file' on the files remaining on the command line.
4022 Use this from the command line, with `-batch';
4023 it won't work in an interactive Emacs.
4024 Each file is processed even if an error occurred previously.
4025 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4026 If NOFORCE is non-nil, don't recompile a file that seems to be
4027 already up-to-date."
4028 ;; command-line-args-left is what is left of the command line (from startup.el)
4029 (defvar command-line-args-left) ;Avoid 'free variable' warning
4030 (if (not noninteractive)
4031 (error "`batch-byte-compile' is to be used only with -batch"))
4033 (while command-line-args-left
4034 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4035 ;; Directory as argument.
4036 (let ((files (directory-files (car command-line-args-left)))
4038 (dolist (file files)
4039 (if (and (string-match emacs-lisp-file-regexp file)
4040 (not (auto-save-file-name-p file))
4041 (setq source (expand-file-name file
4042 (car command-line-args-left)))
4043 (setq dest (byte-compile-dest-file source))
4044 (file-exists-p dest)
4045 (file-newer-than-file-p source dest))
4046 (if (null (batch-byte-compile-file source))
4048 ;; Specific file argument
4049 (if (or (not noforce)
4050 (let* ((source (car command-line-args-left))
4051 (dest (byte-compile-dest-file source)))
4052 (or (not (file-exists-p dest))
4053 (file-newer-than-file-p source dest))))
4054 (if (null (batch-byte-compile-file (car command-line-args-left)))
4056 (setq command-line-args-left (cdr command-line-args-left)))
4057 (kill-emacs (if error 1 0))))
4059 (defun batch-byte-compile-file (file)
4061 (byte-compile-file file)
4063 (byte-compile-file file)
4065 (message (if (cdr err)
4066 ">>Error occurred processing %s: %s (%s)"
4067 ">>Error occurred processing %s: %s")
4069 (get (car err) 'error-message)
4070 (prin1-to-string (cdr err)))
4071 (let ((destfile (byte-compile-dest-file file)))
4072 (if (file-exists-p destfile)
4073 (delete-file destfile)))
4076 (message (if (cdr err)
4077 ">>Error occurred processing %s: %s (%s)"
4078 ">>Error occurred processing %s: %s")
4080 (get (car err) 'error-message)
4081 (prin1-to-string (cdr err)))
4085 (defun batch-byte-recompile-directory (&optional arg)
4086 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4087 Must be used only with `-batch', and kills Emacs on completion.
4088 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'."
4089 ;; command-line-args-left is what is left of the command line (startup.el)
4090 (defvar command-line-args-left) ;Avoid 'free variable' warning
4091 (if (not noninteractive)
4092 (error "batch-byte-recompile-directory is to be used only with -batch"))
4093 (or command-line-args-left
4094 (setq command-line-args-left '(".")))
4095 (while command-line-args-left
4096 (byte-recompile-directory (car command-line-args-left) arg)
4097 (setq command-line-args-left (cdr command-line-args-left)))
4100 (provide 'byte-compile)
4104 ;;; report metering (see the hacks in bytecode.c)
4106 (defvar byte-code-meter)
4107 (defun byte-compile-report-ops ()
4108 (with-output-to-temp-buffer "*Meter*"
4109 (set-buffer "*Meter*")
4110 (let ((i 0) n op off)
4112 (setq n (aref (aref byte-code-meter 0) i)
4114 (if t ;(not (zerop n))
4118 (cond ((< op byte-nth)
4119 (setq off (logand op 7))
4120 (setq op (logand op 248)))
4121 ((>= op byte-constant)
4122 (setq off (- op byte-constant)
4124 (setq op (aref byte-code-vector op))
4125 (insert (format "%-4d" i))
4126 (insert (symbol-name op))
4127 (if off (insert " [" (int-to-string off) "]"))
4129 (insert (int-to-string n) "\n")))
4132 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4133 ;; itself, compile some of its most used recursive functions (at load time).
4136 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4137 (assq 'byte-code (symbol-function 'byte-compile-form))
4138 (let ((byte-optimize nil) ; do it fast
4139 (byte-compile-warnings nil))
4141 (or noninteractive (message "compiling %s..." x))
4143 (or noninteractive (message "compiling %s...done" x)))
4144 '(byte-compile-normal-call
4147 ;; Inserted some more than necessary, to speed it up.
4148 byte-compile-top-level
4149 byte-compile-out-toplevel
4150 byte-compile-constant
4151 byte-compile-variable-ref))))
4154 (run-hooks 'bytecomp-load-hook)
4156 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4157 ;;; bytecomp.el ends here