(byte-compile-form): Only call cl-byte-compile-compiler-macro if it exists.
[emacs.git] / lisp / emacs-lisp / bytecomp.el
blob83620f3344f7b0c3a5a2e1ab7bb178f8833543a6
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, 2006 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
8 ;; Maintainer: FSF
9 ;; Keywords: lisp
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)
16 ;; any later version.
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.
28 ;;; Commentary:
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.
35 ;;; Code:
37 ;; ========================================================================
38 ;; Entry points:
39 ;; byte-recompile-directory, byte-compile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
42 ;; display-call-tree
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
50 ;; is unused;
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
52 ;; and (ash 1 6);
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables:
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
81 ;; produced;
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
106 ;; generic emacs 18.
107 ;; emacs-lisp-file-regexp Regexp for the extension of source-files;
108 ;; see also the function byte-compile-dest-file.
110 ;; New Features:
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
116 ;; big win.
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
120 ;; mapcar, etc.
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
126 ;; or...
127 ;; (inline ;; `foo' and `baz' will be
128 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
129 ;; (baz 0))
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
135 ;; definitions.
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.
157 (require 'backquote)
159 (or (fboundp 'defsubst)
160 ;; This really ought to be loaded already!
161 (load "byte-run"))
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")))
177 ;; (progn
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)))
192 ;; list))))
195 (defgroup bytecomp nil
196 "Emacs Lisp byte-compiler."
197 :group 'lisp)
199 (defcustom emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
200 "\\.EL\\(;[0-9]+\\)?$"
201 "\\.el$")
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."
205 :group 'bytecomp
206 :type 'regexp)
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)))
214 (if handler
215 (funcall handler 'byte-compiler-base-file-name filename)
216 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
243 ;; thing to do.
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."
249 :group 'bytecomp
250 :type 'boolean)
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."
256 :group 'bytecomp
257 :type 'boolean)
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."
272 :group 'bytecomp
273 :type '(choice (const :tag "none" nil)
274 (const :tag "all" t)
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'."
281 :group 'bytecomp
282 :type 'boolean)
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
288 function is called.
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
301 are actually needed.
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."
312 :group 'bytecomp
313 :type 'boolean)
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."
319 :group 'bytecomp
320 :type '(choice (const :tag "none" nil)
321 (const :tag "all" t)
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'."
327 :group 'bytecomp
328 :type 'boolean)
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).
349 interactive-only
350 commands that normally shouldn't be called from Lisp code."
351 :group 'bytecomp
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
372 the graph.
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
376 not reported.
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."
381 :group 'bytecomp
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
392 FUNCTION.")
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."
398 :group 'bytecomp
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)
431 (list 'quote
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))
496 (if docstring
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)
503 'byte-stack+-info
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)))
509 ;; unused: 0-7
511 ;; These opcodes are special in that they pack their argument into the
512 ;; opcode word.
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
521 ;; unused: 48-55
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)
598 ;; unused: 128
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,
608 otherwise pop it")
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,
611 otherwise pop it")
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)
674 ;; unused: 169-174
675 (byte-defop 175 nil byte-listN)
676 (byte-defop 176 nil byte-concatN)
677 (byte-defop 177 nil byte-insertN)
679 ;; unused: 178-191
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
733 (while lap
734 (setq op (car (car lap))
735 off (cdr (car lap)))
736 (cond ((not (symbolp op))
737 (error "Non-symbolic opcode `%s'" op))
738 ((eq op 'TAG)
739 (setcar off pc)
740 (setq patchlist (cons off patchlist)))
741 ((memq op byte-goto-ops)
742 (setq pc (+ pc 3))
743 (setq bytes (cons (cons pc (cdr off))
744 (cons nil
745 (cons (symbol-value op) bytes))))
746 (setq patchlist (cons bytes patchlist)))
748 (setq bytes
749 (cond ((cond ((consp off)
750 ;; Variable or constant reference
751 (setq off (cdr off))
752 (eq op 'byte-constant)))
753 (cond ((< off byte-constant-limit)
754 (setq pc (1+ pc))
755 (cons (+ byte-constant off) bytes))
757 (setq pc (+ 3 pc))
758 (cons (lsh off -8)
759 (cons (logand off 255)
760 (cons byte-constant2 bytes))))))
761 ((<= byte-listN (symbol-value op))
762 (setq pc (+ 2 pc))
763 (cons off (cons (symbol-value op) bytes)))
764 ((< off 6)
765 (setq pc (1+ pc))
766 (cons (+ (symbol-value op) off) bytes))
767 ((< off 256)
768 (setq pc (+ 2 pc))
769 (cons off (cons (+ (symbol-value op) 6) bytes)))
771 (setq pc (+ 3 pc))
772 (cons (lsh off -8)
773 (cons (logand off 255)
774 (cons (+ (symbol-value op) 7)
775 bytes))))))))
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
780 (let (bytes)
781 (while patchlist
782 (setq bytes (car patchlist))
783 (cond ((atom (car bytes))) ; Tag
784 (t ; Absolute jump
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 (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))
799 (prog1 (eval form)
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))
807 old-autoloads)
808 ;; Make sure the file was not already loaded before.
809 (unless (or (assoc (car xs) hist-orig)
810 (equal (car xs) "cl"))
811 (dolist (s xs)
812 (cond
813 ((symbolp s)
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.
821 (let (old-autoloads)
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))
835 old-autoloads)
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))
843 (prog1 (eval form)
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)
861 `(and
862 byte-optimize
863 (memq byte-optimize-log '(t source))
864 (let ((print-escape-newlines t)
865 (print-level 4)
866 (print-length 4))
867 (byte-compile-log-1
868 (format
869 ,format-string
870 ,@(mapcar
871 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
872 args))))))
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)
893 (cdr list)
894 (let ((total list))
895 (while (and (cdr list)
896 (not (eq (cadr list) elt)))
897 (setq list (cdr list)))
898 (when (cdr list)
899 (setcdr list (cddr list)))
900 total)))
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.
912 ;; This function should not be called twice for the same occurrence of
913 ;; a symbol, and it should not be called for symbols generated by the
914 ;; byte compiler itself; because rather than just fail looking up the
915 ;; symbol, we may find an occurrence of the symbol further ahead, and
916 ;; then `byte-compile-last-position' as advanced too far.
918 ;; So your're probably asking yourself: Isn't this function a
919 ;; gross hack? And the answer, of course, would be yes.
920 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
921 (when byte-compile-read-position
922 (let (last entry)
923 (while (progn
924 (setq last byte-compile-last-position
925 entry (assq sym read-symbol-positions-list))
926 (when entry
927 (setq byte-compile-last-position
928 (+ byte-compile-read-position (cdr entry))
929 read-symbol-positions-list
930 (byte-compile-delete-first
931 entry read-symbol-positions-list)))
932 (or (and allow-previous (not (= last byte-compile-last-position)))
933 (> last byte-compile-last-position)))))))
935 (defvar byte-compile-last-warned-form nil)
936 (defvar byte-compile-last-logged-file nil)
938 ;; This is used as warning-prefix for the compiler.
939 ;; It is always called with the warnings buffer current.
940 (defun byte-compile-warning-prefix (level entry)
941 (let* ((inhibit-read-only t)
942 (dir default-directory)
943 (file (cond ((stringp byte-compile-current-file)
944 (format "%s:" (file-relative-name byte-compile-current-file dir)))
945 ((bufferp byte-compile-current-file)
946 (format "Buffer %s:"
947 (buffer-name byte-compile-current-file)))
948 (t "")))
949 (pos (if (and byte-compile-current-file
950 (integerp byte-compile-read-position))
951 (with-current-buffer byte-compile-current-buffer
952 (format "%d:%d:" (count-lines (point-min)
953 byte-compile-last-position)
954 (save-excursion
955 (goto-char byte-compile-last-position)
956 (1+ (current-column)))))
957 ""))
958 (form (if (eq byte-compile-current-form :end) "end of data"
959 (or byte-compile-current-form "toplevel form"))))
960 (when (or (and byte-compile-current-file
961 (not (equal byte-compile-current-file
962 byte-compile-last-logged-file)))
963 (and byte-compile-current-form
964 (not (eq byte-compile-current-form
965 byte-compile-last-warned-form))))
966 (insert (format "\nIn %s:\n" form)))
967 (when level
968 (insert (format "%s%s" file pos))))
969 (setq byte-compile-last-logged-file byte-compile-current-file
970 byte-compile-last-warned-form byte-compile-current-form)
971 entry)
973 ;; This no-op function is used as the value of warning-series
974 ;; to tell inner calls to displaying-byte-compile-warnings
975 ;; not to bind warning-series.
976 (defun byte-compile-warning-series (&rest ignore)
977 nil)
979 ;; Log the start of a file in *Compile-Log*, and mark it as done.
980 ;; Return the position of the start of the page in the log buffer.
981 ;; But do nothing in batch mode.
982 (defun byte-compile-log-file ()
983 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
984 (not noninteractive)
985 (save-excursion
986 (set-buffer (get-buffer-create "*Compile-Log*"))
987 (goto-char (point-max))
988 (let* ((inhibit-read-only t)
989 (dir (and byte-compile-current-file
990 (file-name-directory byte-compile-current-file)))
991 (was-same (equal default-directory dir))
993 (when dir
994 (unless was-same
995 (insert (format "Leaving directory `%s'\n" default-directory))))
996 (unless (bolp)
997 (insert "\n"))
998 (setq pt (point-marker))
999 (if byte-compile-current-file
1000 (insert "\f\nCompiling "
1001 (if (stringp byte-compile-current-file)
1002 (concat "file " byte-compile-current-file)
1003 (concat "buffer " (buffer-name byte-compile-current-file)))
1004 " at " (current-time-string) "\n")
1005 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1006 (when dir
1007 (setq default-directory dir)
1008 (unless was-same
1009 (insert (format "Entering directory `%s'\n" default-directory))))
1010 (setq byte-compile-last-logged-file byte-compile-current-file
1011 byte-compile-last-warned-form nil)
1012 ;; Do this after setting default-directory.
1013 (unless (eq major-mode 'compilation-mode)
1014 (compilation-mode))
1015 (compilation-forget-errors)
1016 pt))))
1018 ;; Log a message STRING in *Compile-Log*.
1019 ;; Also log the current function and file if not already done.
1020 (defun byte-compile-log-warning (string &optional fill level)
1021 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1022 (warning-type-format "")
1023 (warning-fill-prefix (if fill " "))
1024 (inhibit-read-only t))
1025 (display-warning 'bytecomp string level "*Compile-Log*")))
1027 (defun byte-compile-warn (format &rest args)
1028 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1029 (setq format (apply 'format format args))
1030 (if byte-compile-error-on-warn
1031 (error "%s" format) ; byte-compile-file catches and logs it
1032 (byte-compile-log-warning format t :warning)))
1034 (defun byte-compile-report-error (error-info)
1035 "Report Lisp error in compilation. ERROR-INFO is the error data."
1036 (setq byte-compiler-error-flag t)
1037 (byte-compile-log-warning
1038 (error-message-string error-info)
1039 nil :error))
1041 ;;; Used by make-obsolete.
1042 (defun byte-compile-obsolete (form)
1043 (let* ((new (get (car form) 'byte-obsolete-info))
1044 (handler (nth 1 new))
1045 (when (nth 2 new)))
1046 (byte-compile-set-symbol-position (car form))
1047 (if (memq 'obsolete byte-compile-warnings)
1048 (byte-compile-warn "`%s' is an obsolete function%s; %s" (car form)
1049 (if when (concat " (as of Emacs " when ")") "")
1050 (if (stringp (car new))
1051 (car new)
1052 (format "use `%s' instead." (car new)))))
1053 (funcall (or handler 'byte-compile-normal-call) form)))
1055 ;; Compiler options
1057 ;; (defvar byte-compiler-valid-options
1058 ;; '((optimize byte-optimize (t nil source byte) val)
1059 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1060 ;; (eq val 'emacs18))
1061 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1062 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1063 ;; (verbose byte-compile-verbose (t nil) val)
1064 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1065 ;; val)))
1067 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1068 ;; #### This should print a warning if the user tries to change something
1069 ;; than can't be changed because the running compiler doesn't support it.
1070 ;; (cond
1071 ;; ((byte-compile-single-version)
1072 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1073 ;; (list (byte-compile-version-cond
1074 ;; byte-compile-generate-emacs19-bytecodes)))
1075 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1076 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1077 ;; '(emacs18) '(emacs19)))))
1079 ;; (defun byte-compiler-options-handler (&rest args)
1080 ;; (let (key val desc choices)
1081 ;; (while args
1082 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1083 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1084 ;; (setq key (car (car args))
1085 ;; val (car (cdr (car args)))
1086 ;; desc (assq key byte-compiler-valid-options))
1087 ;; (or desc
1088 ;; (error "Unknown byte-compiler option `%s'" key))
1089 ;; (setq choices (nth 2 desc))
1090 ;; (if (consp (car choices))
1091 ;; (let (this
1092 ;; (handler 'cons)
1093 ;; (ret (and (memq (car val) '(+ -))
1094 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1095 ;; choices
1096 ;; (symbol-value (nth 1 desc)))))))
1097 ;; (setq choices (car choices))
1098 ;; (while val
1099 ;; (setq this (car val))
1100 ;; (cond ((memq this choices)
1101 ;; (setq ret (funcall handler this ret)))
1102 ;; ((eq this '+) (setq handler 'cons))
1103 ;; ((eq this '-) (setq handler 'delq))
1104 ;; ((error "`%s' only accepts %s" key choices)))
1105 ;; (setq val (cdr val)))
1106 ;; (set (nth 1 desc) ret))
1107 ;; (or (memq val choices)
1108 ;; (error "`%s' must be one of `%s'" key choices))
1109 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1110 ;; (setq args (cdr args)))
1111 ;; nil))
1113 ;;; sanity-checking arglists
1115 ;; If a function has an entry saying (FUNCTION . t).
1116 ;; that means we know it is defined but we don't know how.
1117 ;; If a function has an entry saying (FUNCTION . nil),
1118 ;; that means treat it as not defined.
1119 (defun byte-compile-fdefinition (name macro-p)
1120 (let* ((list (if macro-p
1121 byte-compile-macro-environment
1122 byte-compile-function-environment))
1123 (env (cdr (assq name list))))
1124 (or env
1125 (let ((fn name))
1126 (while (and (symbolp fn)
1127 (fboundp fn)
1128 (or (symbolp (symbol-function fn))
1129 (consp (symbol-function fn))
1130 (and (not macro-p)
1131 (byte-code-function-p (symbol-function fn)))))
1132 (setq fn (symbol-function fn)))
1133 (if (and (not macro-p) (byte-code-function-p fn))
1135 (and (consp fn)
1136 (if (eq 'macro (car fn))
1137 (cdr fn)
1138 (if macro-p
1140 (if (eq 'autoload (car fn))
1142 fn)))))))))
1144 (defun byte-compile-arglist-signature (arglist)
1145 (let ((args 0)
1146 opts
1147 restp)
1148 (while arglist
1149 (cond ((eq (car arglist) '&optional)
1150 (or opts (setq opts 0)))
1151 ((eq (car arglist) '&rest)
1152 (if (cdr arglist)
1153 (setq restp t
1154 arglist nil)))
1156 (if opts
1157 (setq opts (1+ opts))
1158 (setq args (1+ args)))))
1159 (setq arglist (cdr arglist)))
1160 (cons args (if restp nil (if opts (+ args opts) args)))))
1163 (defun byte-compile-arglist-signatures-congruent-p (old new)
1164 (not (or
1165 (> (car new) (car old)) ; requires more args now
1166 (and (null (cdr old)) ; took rest-args, doesn't any more
1167 (cdr new))
1168 (and (cdr new) (cdr old) ; can't take as many args now
1169 (< (cdr new) (cdr old)))
1172 (defun byte-compile-arglist-signature-string (signature)
1173 (cond ((null (cdr signature))
1174 (format "%d+" (car signature)))
1175 ((= (car signature) (cdr signature))
1176 (format "%d" (car signature)))
1177 (t (format "%d-%d" (car signature) (cdr signature)))))
1180 ;; Warn if the form is calling a function with the wrong number of arguments.
1181 (defun byte-compile-callargs-warn (form)
1182 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1183 (byte-compile-fdefinition (car form) t)))
1184 (sig (if (and def (not (eq def t)))
1185 (byte-compile-arglist-signature
1186 (if (eq 'lambda (car-safe def))
1187 (nth 1 def)
1188 (if (byte-code-function-p def)
1189 (aref def 0)
1190 '(&rest def))))
1191 (if (and (fboundp (car form))
1192 (subrp (symbol-function (car form))))
1193 (subr-arity (symbol-function (car form))))))
1194 (ncall (length (cdr form))))
1195 ;; Check many or unevalled from subr-arity.
1196 (if (and (cdr-safe sig)
1197 (not (numberp (cdr sig))))
1198 (setcdr sig nil))
1199 (if sig
1200 (when (or (< ncall (car sig))
1201 (and (cdr sig) (> ncall (cdr sig))))
1202 (byte-compile-set-symbol-position (car form))
1203 (byte-compile-warn
1204 "%s called with %d argument%s, but %s %s"
1205 (car form) ncall
1206 (if (= 1 ncall) "" "s")
1207 (if (< ncall (car sig))
1208 "requires"
1209 "accepts only")
1210 (byte-compile-arglist-signature-string sig))))
1211 (byte-compile-format-warn form)
1212 ;; Check to see if the function will be available at runtime
1213 ;; and/or remember its arity if it's unknown.
1214 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1215 (not (memq (car form) byte-compile-noruntime-functions)))
1216 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1217 ; with recursion.
1218 ;; It's a currently-undefined function.
1219 ;; Remember number of args in call.
1220 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1221 (n (length (cdr form))))
1222 (if cons
1223 (or (memq n (cdr cons))
1224 (setcdr cons (cons n (cdr cons))))
1225 (push (list (car form) n)
1226 byte-compile-unresolved-functions))))))
1228 (defun byte-compile-format-warn (form)
1229 "Warn if FORM is `format'-like with inconsistent args.
1230 Applies if head of FORM is a symbol with non-nil property
1231 `byte-compile-format-like' and first arg is a constant string.
1232 Then check the number of format fields matches the number of
1233 extra args."
1234 (when (and (symbolp (car form))
1235 (stringp (nth 1 form))
1236 (get (car form) 'byte-compile-format-like))
1237 (let ((nfields (with-temp-buffer
1238 (insert (nth 1 form))
1239 (goto-char 1)
1240 (let ((n 0))
1241 (while (re-search-forward "%." nil t)
1242 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1243 (setq n (1+ n))))
1244 n)))
1245 (nargs (- (length form) 2)))
1246 (unless (= nargs nfields)
1247 (byte-compile-warn
1248 "`%s' called with %d args to fill %d format field(s)" (car form)
1249 nargs nfields)))))
1251 (dolist (elt '(format message error))
1252 (put elt 'byte-compile-format-like t))
1254 ;; Warn if a custom definition fails to specify :group.
1255 (defun byte-compile-nogroup-warn (form)
1256 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1257 (name (cadr form)))
1258 (or (not (eq (car-safe name) 'quote))
1259 (and (eq (car form) 'custom-declare-group)
1260 (equal name ''emacs))
1261 (plist-get keyword-args :group)
1262 (not (and (consp name) (eq (car name) 'quote)))
1263 (byte-compile-warn
1264 "%s for `%s' fails to specify containing group"
1265 (cdr (assq (car form)
1266 '((custom-declare-group . defgroup)
1267 (custom-declare-face . defface)
1268 (custom-declare-variable . defcustom))))
1269 (cadr name)))))
1271 ;; Warn if the function or macro is being redefined with a different
1272 ;; number of arguments.
1273 (defun byte-compile-arglist-warn (form macrop)
1274 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
1275 (if (and old (not (eq old t)))
1276 (let ((sig1 (byte-compile-arglist-signature
1277 (if (eq 'lambda (car-safe old))
1278 (nth 1 old)
1279 (if (byte-code-function-p old)
1280 (aref old 0)
1281 '(&rest def)))))
1282 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1283 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1284 (byte-compile-set-symbol-position (nth 1 form))
1285 (byte-compile-warn
1286 "%s %s used to take %s %s, now takes %s"
1287 (if (eq (car form) 'defun) "function" "macro")
1288 (nth 1 form)
1289 (byte-compile-arglist-signature-string sig1)
1290 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1291 (byte-compile-arglist-signature-string sig2))))
1292 ;; This is the first definition. See if previous calls are compatible.
1293 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1294 nums sig min max)
1295 (if calls
1296 (progn
1297 (setq sig (byte-compile-arglist-signature (nth 2 form))
1298 nums (sort (copy-sequence (cdr calls)) (function <))
1299 min (car nums)
1300 max (car (nreverse nums)))
1301 (when (or (< min (car sig))
1302 (and (cdr sig) (> max (cdr sig))))
1303 (byte-compile-set-symbol-position (nth 1 form))
1304 (byte-compile-warn
1305 "%s being defined to take %s%s, but was previously called with %s"
1306 (nth 1 form)
1307 (byte-compile-arglist-signature-string sig)
1308 (if (equal sig '(1 . 1)) " arg" " args")
1309 (byte-compile-arglist-signature-string (cons min max))))
1311 (setq byte-compile-unresolved-functions
1312 (delq calls byte-compile-unresolved-functions)))))
1315 (defvar byte-compile-cl-functions nil
1316 "List of functions defined in CL.")
1318 (defun byte-compile-find-cl-functions ()
1319 (unless byte-compile-cl-functions
1320 (dolist (elt load-history)
1321 (when (and (stringp (car elt))
1322 (string-match "^cl\\>" (car elt)))
1323 (setq byte-compile-cl-functions
1324 (append byte-compile-cl-functions
1325 (cdr elt)))))
1326 (let ((tail byte-compile-cl-functions))
1327 (while tail
1328 (if (and (consp (car tail))
1329 (eq (car (car tail)) 'autoload))
1330 (setcar tail (cdr (car tail))))
1331 (setq tail (cdr tail))))))
1333 (defun byte-compile-cl-warn (form)
1334 "Warn if FORM is a call of a function from the CL package."
1335 (let ((func (car-safe form)))
1336 (if (and byte-compile-cl-functions
1337 (memq func byte-compile-cl-functions)
1338 ;; Aliases which won't have been expanded at this point.
1339 ;; These aren't all aliases of subrs, so not trivial to
1340 ;; avoid hardwiring the list.
1341 (not (memq func
1342 '(cl-block-wrapper cl-block-throw
1343 multiple-value-call nth-value
1344 copy-seq first second rest endp cl-member
1345 ;; These are included in generated code
1346 ;; that can't be called except at compile time
1347 ;; or unless cl is loaded anyway.
1348 cl-defsubst-expand cl-struct-setf-expander
1349 ;; These would sometimes be warned about
1350 ;; but such warnings are never useful,
1351 ;; so don't warn about them.
1352 macroexpand cl-macroexpand-all
1353 cl-compiling-file)))
1354 ;; Avoid warnings for things which are safe because they
1355 ;; have suitable compiler macros, but those aren't
1356 ;; expanded at this stage. There should probably be more
1357 ;; here than caaar and friends.
1358 (not (and (eq (get func 'byte-compile)
1359 'cl-byte-compile-compiler-macro)
1360 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
1361 (byte-compile-warn "Function `%s' from cl package called at runtime"
1362 func)))
1363 form)
1365 (defun byte-compile-print-syms (str1 strn syms)
1366 (when syms
1367 (byte-compile-set-symbol-position (car syms) t))
1368 (cond ((and (cdr syms) (not noninteractive))
1369 (let* ((str strn)
1370 (L (length str))
1372 (while syms
1373 (setq s (symbol-name (pop syms))
1374 L (+ L (length s) 2))
1375 (if (< L (1- fill-column))
1376 (setq str (concat str " " s (and syms ",")))
1377 (setq str (concat str "\n " s (and syms ","))
1378 L (+ (length s) 4))))
1379 (byte-compile-warn "%s" str)))
1380 ((cdr syms)
1381 (byte-compile-warn "%s %s"
1382 strn
1383 (mapconcat #'symbol-name syms ", ")))
1385 (syms
1386 (byte-compile-warn str1 (car syms)))))
1388 ;; If we have compiled any calls to functions which are not known to be
1389 ;; defined, issue a warning enumerating them.
1390 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1391 (defun byte-compile-warn-about-unresolved-functions ()
1392 (when (memq 'unresolved byte-compile-warnings)
1393 (let ((byte-compile-current-form :end)
1394 (noruntime nil)
1395 (unresolved nil))
1396 ;; Separate the functions that will not be available at runtime
1397 ;; from the truly unresolved ones.
1398 (dolist (f byte-compile-unresolved-functions)
1399 (setq f (car f))
1400 (if (fboundp f) (push f noruntime) (push f unresolved)))
1401 ;; Complain about the no-run-time functions
1402 (byte-compile-print-syms
1403 "the function `%s' might not be defined at runtime."
1404 "the following functions might not be defined at runtime:"
1405 noruntime)
1406 ;; Complain about the unresolved functions
1407 (byte-compile-print-syms
1408 "the function `%s' is not known to be defined."
1409 "the following functions are not known to be defined:"
1410 unresolved)))
1411 nil)
1414 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1415 "Non-nil if SYMBOL is constant.
1416 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1417 symbol itself."
1418 (or (memq symbol '(nil t))
1419 (keywordp symbol)
1420 (if any-value (memq symbol byte-compile-const-variables))))
1422 (defmacro byte-compile-constp (form)
1423 "Return non-nil if FORM is a constant."
1424 `(cond ((consp ,form) (eq (car ,form) 'quote))
1425 ((not (symbolp ,form)))
1426 ((byte-compile-const-symbol-p ,form))))
1428 (defmacro byte-compile-close-variables (&rest body)
1429 (cons 'let
1430 (cons '(;;
1431 ;; Close over these variables to encapsulate the
1432 ;; compilation state
1434 (byte-compile-macro-environment
1435 ;; Copy it because the compiler may patch into the
1436 ;; macroenvironment.
1437 (copy-alist byte-compile-initial-macro-environment))
1438 (byte-compile-function-environment nil)
1439 (byte-compile-bound-variables nil)
1440 (byte-compile-const-variables nil)
1441 (byte-compile-free-references nil)
1442 (byte-compile-free-assignments nil)
1444 ;; Close over these variables so that `byte-compiler-options'
1445 ;; can change them on a per-file basis.
1447 (byte-compile-verbose byte-compile-verbose)
1448 (byte-optimize byte-optimize)
1449 (byte-compile-compatibility byte-compile-compatibility)
1450 (byte-compile-dynamic byte-compile-dynamic)
1451 (byte-compile-dynamic-docstrings
1452 byte-compile-dynamic-docstrings)
1453 ;; (byte-compile-generate-emacs19-bytecodes
1454 ;; byte-compile-generate-emacs19-bytecodes)
1455 (byte-compile-warnings (if (eq byte-compile-warnings t)
1456 byte-compile-warning-types
1457 byte-compile-warnings))
1459 body)))
1461 (defmacro displaying-byte-compile-warnings (&rest body)
1462 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1463 (warning-series-started
1464 (and (markerp warning-series)
1465 (eq (marker-buffer warning-series)
1466 (get-buffer "*Compile-Log*")))))
1467 (byte-compile-find-cl-functions)
1468 (if (or (eq warning-series 'byte-compile-warning-series)
1469 warning-series-started)
1470 ;; warning-series does come from compilation,
1471 ;; so don't bind it, but maybe do set it.
1472 (let (tem)
1473 ;; Log the file name. Record position of that text.
1474 (setq tem (byte-compile-log-file))
1475 (unless warning-series-started
1476 (setq warning-series (or tem 'byte-compile-warning-series)))
1477 (if byte-compile-debug
1478 (funcall --displaying-byte-compile-warnings-fn)
1479 (condition-case error-info
1480 (funcall --displaying-byte-compile-warnings-fn)
1481 (error (byte-compile-report-error error-info)))))
1482 ;; warning-series does not come from compilation, so bind it.
1483 (let ((warning-series
1484 ;; Log the file name. Record position of that text.
1485 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1486 (if byte-compile-debug
1487 (funcall --displaying-byte-compile-warnings-fn)
1488 (condition-case error-info
1489 (funcall --displaying-byte-compile-warnings-fn)
1490 (error (byte-compile-report-error error-info))))))))
1492 ;;;###autoload
1493 (defun byte-force-recompile (directory)
1494 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1495 Files in subdirectories of DIRECTORY are processed also."
1496 (interactive "DByte force recompile (directory): ")
1497 (byte-recompile-directory directory nil t))
1499 ;;;###autoload
1500 (defun byte-recompile-directory (directory &optional arg force)
1501 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1502 This is if a `.elc' file exists but is older than the `.el' file.
1503 Files in subdirectories of DIRECTORY are processed also.
1505 If the `.elc' file does not exist, normally this function *does not*
1506 compile the corresponding `.el' file. However,
1507 if ARG (the prefix argument) is 0, that means do compile all those files.
1508 A nonzero ARG means ask the user, for each such `.el' file,
1509 whether to compile it.
1511 A nonzero ARG also means ask about each subdirectory before scanning it.
1513 If the third argument FORCE is non-nil,
1514 recompile every `.el' file that already has a `.elc' file."
1515 (interactive "DByte recompile directory: \nP")
1516 (if arg
1517 (setq arg (prefix-numeric-value arg)))
1518 (if noninteractive
1520 (save-some-buffers)
1521 (force-mode-line-update))
1522 (save-current-buffer
1523 (set-buffer (get-buffer-create "*Compile-Log*"))
1524 (setq default-directory (expand-file-name directory))
1525 ;; compilation-mode copies value of default-directory.
1526 (unless (eq major-mode 'compilation-mode)
1527 (compilation-mode))
1528 (let ((directories (list (expand-file-name directory)))
1529 (default-directory default-directory)
1530 (skip-count 0)
1531 (fail-count 0)
1532 (file-count 0)
1533 (dir-count 0)
1534 last-dir)
1535 (displaying-byte-compile-warnings
1536 (while directories
1537 (setq directory (car directories))
1538 (message "Checking %s..." directory)
1539 (let ((files (directory-files directory))
1540 source dest)
1541 (dolist (file files)
1542 (setq source (expand-file-name file directory))
1543 (if (and (not (member file '("RCS" "CVS")))
1544 (not (eq ?\. (aref file 0)))
1545 (file-directory-p source)
1546 (not (file-symlink-p source)))
1547 ;; This file is a subdirectory. Handle them differently.
1548 (when (or (null arg)
1549 (eq 0 arg)
1550 (y-or-n-p (concat "Check " source "? ")))
1551 (setq directories
1552 (nconc directories (list source))))
1553 ;; It is an ordinary file. Decide whether to compile it.
1554 (if (and (string-match emacs-lisp-file-regexp source)
1555 (file-readable-p source)
1556 (not (auto-save-file-name-p source))
1557 (setq dest (byte-compile-dest-file source))
1558 (if (file-exists-p dest)
1559 ;; File was already compiled.
1560 (or force (file-newer-than-file-p source dest))
1561 ;; No compiled file exists yet.
1562 (and arg
1563 (or (eq 0 arg)
1564 (y-or-n-p (concat "Compile " source "? "))))))
1565 (progn (if (and noninteractive (not byte-compile-verbose))
1566 (message "Compiling %s..." source))
1567 (let ((res (byte-compile-file source)))
1568 (cond ((eq res 'no-byte-compile)
1569 (setq skip-count (1+ skip-count)))
1570 ((eq res t)
1571 (setq file-count (1+ file-count)))
1572 ((eq res nil)
1573 (setq fail-count (1+ fail-count)))))
1574 (or noninteractive
1575 (message "Checking %s..." directory))
1576 (if (not (eq last-dir directory))
1577 (setq last-dir directory
1578 dir-count (1+ dir-count)))
1579 )))))
1580 (setq directories (cdr directories))))
1581 (message "Done (Total of %d file%s compiled%s%s%s)"
1582 file-count (if (= file-count 1) "" "s")
1583 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1584 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1585 (if (> dir-count 1) (format " in %d directories" dir-count) "")))))
1587 (defvar no-byte-compile nil
1588 "Non-nil to prevent byte-compiling of emacs-lisp code.
1589 This is normally set in local file variables at the end of the elisp file:
1591 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1593 ;;;###autoload
1594 (defun byte-compile-file (filename &optional load)
1595 "Compile a file of Lisp code named FILENAME into a file of byte code.
1596 The output file's name is made by appending `c' to the end of FILENAME.
1597 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1598 The value is non-nil if there were no errors, nil if errors."
1599 ;; (interactive "fByte compile file: \nP")
1600 (interactive
1601 (let ((file buffer-file-name)
1602 (file-name nil)
1603 (file-dir nil))
1604 (and file
1605 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1606 'emacs-lisp-mode)
1607 (setq file-name (file-name-nondirectory file)
1608 file-dir (file-name-directory file)))
1609 (list (read-file-name (if current-prefix-arg
1610 "Byte compile and load file: "
1611 "Byte compile file: ")
1612 file-dir file-name nil)
1613 current-prefix-arg)))
1614 ;; Expand now so we get the current buffer's defaults
1615 (setq filename (expand-file-name filename))
1617 ;; If we're compiling a file that's in a buffer and is modified, offer
1618 ;; to save it first.
1619 (or noninteractive
1620 (let ((b (get-file-buffer (expand-file-name filename))))
1621 (if (and b (buffer-modified-p b)
1622 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1623 (save-excursion (set-buffer b) (save-buffer)))))
1625 ;; Force logging of the file name for each file compiled.
1626 (setq byte-compile-last-logged-file nil)
1627 (let ((byte-compile-current-file filename)
1628 (set-auto-coding-for-load t)
1629 target-file input-buffer output-buffer
1630 byte-compile-dest-file)
1631 (setq target-file (byte-compile-dest-file filename))
1632 (setq byte-compile-dest-file target-file)
1633 (save-excursion
1634 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1635 (set-buffer input-buffer)
1636 (erase-buffer)
1637 (setq buffer-file-coding-system nil)
1638 ;; Always compile an Emacs Lisp file as multibyte
1639 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1640 (set-buffer-multibyte t)
1641 (insert-file-contents filename)
1642 ;; Mimic the way after-insert-file-set-coding can make the
1643 ;; buffer unibyte when visiting this file.
1644 (when (or (eq last-coding-system-used 'no-conversion)
1645 (eq (coding-system-type last-coding-system-used) 5))
1646 ;; For coding systems no-conversion and raw-text...,
1647 ;; edit the buffer as unibyte.
1648 (set-buffer-multibyte nil))
1649 ;; Run hooks including the uncompression hook.
1650 ;; If they change the file name, then change it for the output also.
1651 (let ((buffer-file-name filename)
1652 (default-major-mode 'emacs-lisp-mode)
1653 (enable-local-eval nil))
1654 (normal-mode)
1655 (setq filename buffer-file-name))
1656 ;; Set the default directory, in case an eval-when-compile uses it.
1657 (setq default-directory (file-name-directory filename)))
1658 ;; Check if the file's local variables explicitly specify not to
1659 ;; compile this file.
1660 (if (with-current-buffer input-buffer no-byte-compile)
1661 (progn
1662 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1663 ;; (file-relative-name filename)
1664 ;; (with-current-buffer input-buffer no-byte-compile))
1665 (when (file-exists-p target-file)
1666 (message "%s deleted because of `no-byte-compile: %s'"
1667 (file-relative-name target-file)
1668 (buffer-local-value 'no-byte-compile input-buffer))
1669 (condition-case nil (delete-file target-file) (error nil)))
1670 ;; We successfully didn't compile this file.
1671 'no-byte-compile)
1672 (when byte-compile-verbose
1673 (message "Compiling %s..." filename))
1674 (setq byte-compiler-error-flag nil)
1675 ;; It is important that input-buffer not be current at this call,
1676 ;; so that the value of point set in input-buffer
1677 ;; within byte-compile-from-buffer lingers in that buffer.
1678 (setq output-buffer
1679 (save-current-buffer
1680 (byte-compile-from-buffer input-buffer filename)))
1681 (if byte-compiler-error-flag
1683 (when byte-compile-verbose
1684 (message "Compiling %s...done" filename))
1685 (kill-buffer input-buffer)
1686 (with-current-buffer output-buffer
1687 (goto-char (point-max))
1688 (insert "\n") ; aaah, unix.
1689 (let ((vms-stmlf-recfm t))
1690 (if (file-writable-p target-file)
1691 ;; We must disable any code conversion here.
1692 (let ((coding-system-for-write 'no-conversion))
1693 (if (memq system-type '(ms-dos 'windows-nt))
1694 (setq buffer-file-type t))
1695 (when (file-exists-p target-file)
1696 ;; Remove the target before writing it, so that any
1697 ;; hard-links continue to point to the old file (this makes
1698 ;; it possible for installed files to share disk space with
1699 ;; the build tree, without causing problems when emacs-lisp
1700 ;; files in the build tree are recompiled).
1701 (delete-file target-file))
1702 (write-region (point-min) (point-max) target-file))
1703 ;; This is just to give a better error message than write-region
1704 (signal 'file-error
1705 (list "Opening output file"
1706 (if (file-exists-p target-file)
1707 "cannot overwrite file"
1708 "directory not writable or nonexistent")
1709 target-file))))
1710 (kill-buffer (current-buffer)))
1711 (if (and byte-compile-generate-call-tree
1712 (or (eq t byte-compile-generate-call-tree)
1713 (y-or-n-p (format "Report call tree for %s? " filename))))
1714 (save-excursion
1715 (display-call-tree filename)))
1716 (if load
1717 (load target-file))
1718 t))))
1720 ;;(defun byte-compile-and-load-file (&optional filename)
1721 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1722 ;;and then load it. The output file's name is made by appending \"c\" to
1723 ;;the end of FILENAME."
1724 ;; (interactive)
1725 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1726 ;; (byte-compile-file filename t)
1727 ;; (let ((current-prefix-arg '(4)))
1728 ;; (call-interactively 'byte-compile-file))))
1730 ;;(defun byte-compile-buffer (&optional buffer)
1731 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1732 ;; (interactive "bByte compile buffer: ")
1733 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1734 ;; (message "Compiling %s..." (buffer-name buffer))
1735 ;; (let* ((filename (or (buffer-file-name buffer)
1736 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1737 ;; (byte-compile-current-file buffer))
1738 ;; (byte-compile-from-buffer buffer nil))
1739 ;; (message "Compiling %s...done" (buffer-name buffer))
1740 ;; t)
1742 ;;; compiling a single function
1743 ;;;###autoload
1744 (defun compile-defun (&optional arg)
1745 "Compile and evaluate the current top-level form.
1746 Print the result in the echo area.
1747 With argument, insert value in current buffer after the form."
1748 (interactive "P")
1749 (save-excursion
1750 (end-of-defun)
1751 (beginning-of-defun)
1752 (let* ((byte-compile-current-file nil)
1753 (byte-compile-current-buffer (current-buffer))
1754 (byte-compile-read-position (point))
1755 (byte-compile-last-position byte-compile-read-position)
1756 (byte-compile-last-warned-form 'nothing)
1757 (value (eval
1758 (let ((read-with-symbol-positions (current-buffer))
1759 (read-symbol-positions-list nil))
1760 (displaying-byte-compile-warnings
1761 (byte-compile-sexp (read (current-buffer))))))))
1762 (cond (arg
1763 (message "Compiling from buffer... done.")
1764 (prin1 value (current-buffer))
1765 (insert "\n"))
1766 ((message "%s" (prin1-to-string value)))))))
1769 (defun byte-compile-from-buffer (inbuffer &optional filename)
1770 ;; Filename is used for the loading-into-Emacs-18 error message.
1771 (let (outbuffer
1772 (byte-compile-current-buffer inbuffer)
1773 (byte-compile-read-position nil)
1774 (byte-compile-last-position nil)
1775 ;; Prevent truncation of flonums and lists as we read and print them
1776 (float-output-format nil)
1777 (case-fold-search nil)
1778 (print-length nil)
1779 (print-level nil)
1780 ;; Prevent edebug from interfering when we compile
1781 ;; and put the output into a file.
1782 ;; (edebug-all-defs nil)
1783 ;; (edebug-all-forms nil)
1784 ;; Simulate entry to byte-compile-top-level
1785 (byte-compile-constants nil)
1786 (byte-compile-variables nil)
1787 (byte-compile-tag-number 0)
1788 (byte-compile-depth 0)
1789 (byte-compile-maxdepth 0)
1790 (byte-compile-output nil)
1791 ;; This allows us to get the positions of symbols read; it's
1792 ;; new in Emacs 22.1.
1793 (read-with-symbol-positions inbuffer)
1794 (read-symbol-positions-list nil)
1795 ;; #### This is bound in b-c-close-variables.
1796 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1797 ;; byte-compile-warning-types
1798 ;; byte-compile-warnings))
1800 (byte-compile-close-variables
1801 (save-excursion
1802 (setq outbuffer
1803 (set-buffer (get-buffer-create " *Compiler Output*")))
1804 (set-buffer-multibyte t)
1805 (erase-buffer)
1806 ;; (emacs-lisp-mode)
1807 (setq case-fold-search nil)
1808 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1809 ;; write files containing binary information specially.
1810 ;; Under most circumstances, such files will be in binary
1811 ;; overwrite mode, so those OS's use that flag to guess how
1812 ;; they should write their data. Advise them that .elc files
1813 ;; need to be written carefully.
1814 (setq overwrite-mode 'overwrite-mode-binary))
1815 (displaying-byte-compile-warnings
1816 (and filename (byte-compile-insert-header filename inbuffer outbuffer))
1817 (save-excursion
1818 (set-buffer inbuffer)
1819 (goto-char 1)
1821 ;; Compile the forms from the input buffer.
1822 (while (progn
1823 (while (progn (skip-chars-forward " \t\n\^l")
1824 (looking-at ";"))
1825 (forward-line 1))
1826 (not (eobp)))
1827 (setq byte-compile-read-position (point)
1828 byte-compile-last-position byte-compile-read-position)
1829 (let ((form (read inbuffer)))
1830 (byte-compile-file-form form)))
1831 ;; Compile pending forms at end of file.
1832 (byte-compile-flush-pending)
1833 ;; Make warnings about unresolved functions
1834 ;; give the end of the file as their position.
1835 (setq byte-compile-last-position (point-max))
1836 (byte-compile-warn-about-unresolved-functions)
1837 ;; Should we always do this? When calling multiple files, it
1838 ;; would be useful to delay this warning until all have
1839 ;; been compiled.
1840 (setq byte-compile-unresolved-functions nil))
1841 ;; Fix up the header at the front of the output
1842 ;; if the buffer contains multibyte characters.
1843 (and filename (byte-compile-fix-header filename inbuffer outbuffer))))
1844 outbuffer))
1846 (defun byte-compile-fix-header (filename inbuffer outbuffer)
1847 (with-current-buffer outbuffer
1848 ;; See if the buffer has any multibyte characters.
1849 (when (< (point-max) (position-bytes (point-max)))
1850 (when (byte-compile-version-cond byte-compile-compatibility)
1851 (error "Version-18 compatibility not valid with multibyte characters"))
1852 (goto-char (point-min))
1853 ;; Find the comment that describes the version test.
1854 (search-forward "\n;;; This file")
1855 (beginning-of-line)
1856 (narrow-to-region (point) (point-max))
1857 ;; Find the line of ballast semicolons.
1858 (search-forward ";;;;;;;;;;")
1859 (beginning-of-line)
1861 (narrow-to-region (point-min) (point))
1862 (let ((old-header-end (point))
1863 delta)
1864 (goto-char (point-min))
1865 (delete-region (point) (progn (re-search-forward "^(")
1866 (beginning-of-line)
1867 (point)))
1868 (insert ";;; This file contains multibyte non-ASCII characters\n"
1869 ";;; and therefore cannot be loaded into Emacs 19.\n")
1870 ;; Replace "19" or "19.29" with "20", twice.
1871 (re-search-forward "19\\(\\.[0-9]+\\)")
1872 (replace-match "20")
1873 (re-search-forward "19\\(\\.[0-9]+\\)")
1874 (replace-match "20")
1875 ;; Now compensate for the change in size,
1876 ;; to make sure all positions in the file remain valid.
1877 (setq delta (- (point-max) old-header-end))
1878 (goto-char (point-max))
1879 (widen)
1880 (delete-char delta)))))
1882 (defun byte-compile-insert-header (filename inbuffer outbuffer)
1883 (set-buffer inbuffer)
1884 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1885 (dynamic byte-compile-dynamic))
1886 (set-buffer outbuffer)
1887 (goto-char 1)
1888 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1889 ;; that is the file-format version number (18, 19 or 20) as a
1890 ;; byte, followed by some nulls. The primary motivation for doing
1891 ;; this is to get some binary characters up in the first line of
1892 ;; the file so that `diff' will simply say "Binary files differ"
1893 ;; instead of actually doing a diff of two .elc files. An extra
1894 ;; benefit is that you can add this to /etc/magic:
1896 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1897 ;; >4 byte x version %d
1899 (insert
1900 ";ELC"
1901 (if (byte-compile-version-cond byte-compile-compatibility) 18 20)
1902 "\000\000\000\n"
1904 (insert ";;; Compiled by "
1905 (or (and (boundp 'user-mail-address) user-mail-address)
1906 (concat (user-login-name) "@" (system-name)))
1907 " on "
1908 (current-time-string) "\n;;; from file " filename "\n")
1909 (insert ";;; in Emacs version " emacs-version "\n")
1910 (insert ";;; "
1911 (cond
1912 ((eq byte-optimize 'source) "with source-level optimization only")
1913 ((eq byte-optimize 'byte) "with byte-level optimization only")
1914 (byte-optimize "with all optimizations")
1915 (t "without optimization"))
1916 (if (byte-compile-version-cond byte-compile-compatibility)
1917 "; compiled with Emacs 18 compatibility.\n"
1918 ".\n"))
1919 (if dynamic
1920 (insert ";;; Function definitions are lazy-loaded.\n"))
1921 (if (not (byte-compile-version-cond byte-compile-compatibility))
1922 (let (intro-string minimum-version)
1923 ;; Figure out which Emacs version to require,
1924 ;; and what comment to use to explain why.
1925 ;; Note that this fails to take account of whether
1926 ;; the buffer contains multibyte characters. We may have to
1927 ;; compensate at the end in byte-compile-fix-header.
1928 (if dynamic-docstrings
1929 (setq intro-string
1930 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1931 minimum-version "19.29")
1932 (setq intro-string
1933 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1934 minimum-version "19"))
1935 ;; Now insert the comment and the error check.
1936 (insert
1937 "\n"
1938 intro-string
1939 ;; Have to check if emacs-version is bound so that this works
1940 ;; in files loaded early in loadup.el.
1941 "(if (and (boundp 'emacs-version)\n"
1942 ;; If there is a name at the end of emacs-version,
1943 ;; don't try to check the version number.
1944 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1945 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1946 (format "\t (string-lessp emacs-version \"%s\")))\n"
1947 minimum-version)
1948 " (error \"`"
1949 ;; prin1-to-string is used to quote backslashes.
1950 (substring (prin1-to-string (file-name-nondirectory filename))
1951 1 -1)
1952 (format "' was compiled for Emacs %s or later\"))\n\n"
1953 minimum-version)
1954 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1955 ;; can delete them so as to keep the buffer positions
1956 ;; constant for the actual compiled code.
1957 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1958 ;; Here if we want Emacs 18 compatibility.
1959 (when dynamic-docstrings
1960 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1961 (when byte-compile-dynamic
1962 (error "Version-18 compatibility doesn't support dynamic byte code"))
1963 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1964 "\n"))))
1966 (defun byte-compile-output-file-form (form)
1967 ;; writes the given form to the output buffer, being careful of docstrings
1968 ;; in defun, defmacro, defvar, defconst, autoload and
1969 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1970 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1971 ;; it does not pay to first build the defalias in defmumble and then parse
1972 ;; it here.
1973 (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload
1974 custom-declare-variable))
1975 (stringp (nth 3 form)))
1976 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
1977 (memq (car form)
1978 '(autoload custom-declare-variable)))
1979 (let ((print-escape-newlines t)
1980 (print-length nil)
1981 (print-level nil)
1982 (print-quoted t)
1983 (print-gensym t))
1984 (princ "\n" outbuffer)
1985 (prin1 form outbuffer)
1986 nil)))
1988 (defvar print-gensym-alist) ;Used before print-circle existed.
1990 (defun byte-compile-output-docform (preface name info form specindex quoted)
1991 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1992 If PREFACE and NAME are non-nil, print them too,
1993 before INFO and the FORM but after the doc string itself.
1994 If SPECINDEX is non-nil, it is the index in FORM
1995 of the function bytecode string. In that case,
1996 we output that argument and the following argument (the constants vector)
1997 together, for lazy loading.
1998 QUOTED says that we have to put a quote before the
1999 list that represents a doc string reference.
2000 `autoload' and `custom-declare-variable' need that."
2001 ;; We need to examine byte-compile-dynamic-docstrings
2002 ;; in the input buffer (now current), not in the output buffer.
2003 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2004 (set-buffer
2005 (prog1 (current-buffer)
2006 (set-buffer outbuffer)
2007 (let (position)
2009 ;; Insert the doc string, and make it a comment with #@LENGTH.
2010 (and (>= (nth 1 info) 0)
2011 dynamic-docstrings
2012 (not byte-compile-compatibility)
2013 (progn
2014 ;; Make the doc string start at beginning of line
2015 ;; for make-docfile's sake.
2016 (insert "\n")
2017 (setq position
2018 (byte-compile-output-as-comment
2019 (nth (nth 1 info) form) nil))
2020 (setq position (- (position-bytes position) (point-min) -1))
2021 ;; If the doc string starts with * (a user variable),
2022 ;; negate POSITION.
2023 (if (and (stringp (nth (nth 1 info) form))
2024 (> (length (nth (nth 1 info) form)) 0)
2025 (eq (aref (nth (nth 1 info) form) 0) ?*))
2026 (setq position (- position)))))
2028 (if preface
2029 (progn
2030 (insert preface)
2031 (prin1 name outbuffer)))
2032 (insert (car info))
2033 (let ((print-escape-newlines t)
2034 (print-quoted t)
2035 ;; For compatibility with code before print-circle,
2036 ;; use a cons cell to say that we want
2037 ;; print-gensym-alist not to be cleared
2038 ;; between calls to print functions.
2039 (print-gensym '(t))
2040 print-gensym-alist ; was used before print-circle existed.
2041 (print-continuous-numbering t)
2042 print-number-table
2043 (index 0))
2044 (prin1 (car form) outbuffer)
2045 (while (setq form (cdr form))
2046 (setq index (1+ index))
2047 (insert " ")
2048 (cond ((and (numberp specindex) (= index specindex)
2049 ;; Don't handle the definition dynamically
2050 ;; if it refers (or might refer)
2051 ;; to objects already output
2052 ;; (for instance, gensyms in the arg list).
2053 (let (non-nil)
2054 (dotimes (i (length print-number-table))
2055 (if (aref print-number-table i)
2056 (setq non-nil t)))
2057 (not non-nil)))
2058 ;; Output the byte code and constants specially
2059 ;; for lazy dynamic loading.
2060 (let ((position
2061 (byte-compile-output-as-comment
2062 (cons (car form) (nth 1 form))
2063 t)))
2064 (setq position (- (position-bytes position) (point-min) -1))
2065 (princ (format "(#$ . %d) nil" position) outbuffer)
2066 (setq form (cdr form))
2067 (setq index (1+ index))))
2068 ((= index (nth 1 info))
2069 (if position
2070 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2071 position)
2072 outbuffer)
2073 (let ((print-escape-newlines nil))
2074 (goto-char (prog1 (1+ (point))
2075 (prin1 (car form) outbuffer)))
2076 (insert "\\\n")
2077 (goto-char (point-max)))))
2079 (prin1 (car form) outbuffer)))))
2080 (insert (nth 2 info))))))
2081 nil)
2083 (defun byte-compile-keep-pending (form &optional handler)
2084 (if (memq byte-optimize '(t source))
2085 (setq form (byte-optimize-form form t)))
2086 (if handler
2087 (let ((for-effect t))
2088 ;; To avoid consing up monstrously large forms at load time, we split
2089 ;; the output regularly.
2090 (and (memq (car-safe form) '(fset defalias))
2091 (nthcdr 300 byte-compile-output)
2092 (byte-compile-flush-pending))
2093 (funcall handler form)
2094 (if for-effect
2095 (byte-compile-discard)))
2096 (byte-compile-form form t))
2097 nil)
2099 (defun byte-compile-flush-pending ()
2100 (if byte-compile-output
2101 (let ((form (byte-compile-out-toplevel t 'file)))
2102 (cond ((eq (car-safe form) 'progn)
2103 (mapc 'byte-compile-output-file-form (cdr form)))
2104 (form
2105 (byte-compile-output-file-form form)))
2106 (setq byte-compile-constants nil
2107 byte-compile-variables nil
2108 byte-compile-depth 0
2109 byte-compile-maxdepth 0
2110 byte-compile-output nil))))
2112 (defun byte-compile-file-form (form)
2113 (let ((byte-compile-current-form nil) ; close over this for warnings.
2114 handler)
2115 (cond
2116 ((not (consp form))
2117 (byte-compile-keep-pending form))
2118 ((and (symbolp (car form))
2119 (setq handler (get (car form) 'byte-hunk-handler)))
2120 (cond ((setq form (funcall handler form))
2121 (byte-compile-flush-pending)
2122 (byte-compile-output-file-form form))))
2123 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2124 (byte-compile-keep-pending form))
2126 (byte-compile-file-form form)))))
2128 ;; Functions and variables with doc strings must be output separately,
2129 ;; so make-docfile can recognise them. Most other things can be output
2130 ;; as byte-code.
2132 (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2133 (defun byte-compile-file-form-defsubst (form)
2134 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2135 (setq byte-compile-current-form (nth 1 form))
2136 (byte-compile-warn "defsubst `%s' was used before it was defined"
2137 (nth 1 form)))
2138 (byte-compile-file-form
2139 (macroexpand form byte-compile-macro-environment))
2140 ;; Return nil so the form is not output twice.
2141 nil)
2143 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2144 (defun byte-compile-file-form-autoload (form)
2145 (and (let ((form form))
2146 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2147 (null form)) ;Constants only
2148 (eval (nth 5 form)) ;Macro
2149 (eval form)) ;Define the autoload.
2150 ;; Avoid undefined function warnings for the autoload.
2151 (if (and (consp (nth 1 form))
2152 (eq (car (nth 1 form)) 'quote)
2153 (consp (cdr (nth 1 form)))
2154 (symbolp (nth 1 (nth 1 form))))
2155 (push (cons (nth 1 (nth 1 form))
2156 (cons 'autoload (cdr (cdr form))))
2157 byte-compile-function-environment))
2158 (if (stringp (nth 3 form))
2159 form
2160 ;; No doc string, so we can compile this as a normal form.
2161 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2163 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2164 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2165 (defun byte-compile-file-form-defvar (form)
2166 (if (null (nth 3 form))
2167 ;; Since there is no doc string, we can compile this as a normal form,
2168 ;; and not do a file-boundary.
2169 (byte-compile-keep-pending form)
2170 (when (memq 'free-vars byte-compile-warnings)
2171 (push (nth 1 form) byte-compile-bound-variables)
2172 (if (eq (car form) 'defconst)
2173 (push (nth 1 form) byte-compile-const-variables)))
2174 (cond ((consp (nth 2 form))
2175 (setq form (copy-sequence form))
2176 (setcar (cdr (cdr form))
2177 (byte-compile-top-level (nth 2 form) nil 'file))))
2178 form))
2180 (put 'custom-declare-variable 'byte-hunk-handler
2181 'byte-compile-file-form-custom-declare-variable)
2182 (defun byte-compile-file-form-custom-declare-variable (form)
2183 (when (memq 'callargs byte-compile-warnings)
2184 (byte-compile-nogroup-warn form))
2185 (when (memq 'free-vars byte-compile-warnings)
2186 (push (nth 1 (nth 1 form)) byte-compile-bound-variables))
2187 (let ((tail (nthcdr 4 form)))
2188 (while tail
2189 ;; If there are any (function (lambda ...)) expressions, compile
2190 ;; those functions.
2191 (if (and (consp (car tail))
2192 (eq (car (car tail)) 'function)
2193 (consp (nth 1 (car tail))))
2194 (setcar tail (byte-compile-lambda (nth 1 (car tail))))
2195 ;; Likewise for a bare lambda.
2196 (if (and (consp (car tail))
2197 (eq (car (car tail)) 'lambda))
2198 (setcar tail (byte-compile-lambda (car tail)))))
2199 (setq tail (cdr tail))))
2200 form)
2202 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2203 (defun byte-compile-file-form-require (form)
2204 (let ((old-load-list current-load-list)
2205 (args (mapcar 'eval (cdr form))))
2206 (apply 'require args)
2207 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2208 (if (member (car args) '("cl" cl))
2209 (setq byte-compile-warnings
2210 (remq 'cl-functions byte-compile-warnings))))
2211 (byte-compile-keep-pending form 'byte-compile-normal-call))
2213 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2214 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2215 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2216 (defun byte-compile-file-form-progn (form)
2217 (mapc 'byte-compile-file-form (cdr form))
2218 ;; Return nil so the forms are not output twice.
2219 nil)
2221 ;; This handler is not necessary, but it makes the output from dont-compile
2222 ;; and similar macros cleaner.
2223 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2224 (defun byte-compile-file-form-eval (form)
2225 (if (eq (car-safe (nth 1 form)) 'quote)
2226 (nth 1 (nth 1 form))
2227 (byte-compile-keep-pending form)))
2229 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2230 (defun byte-compile-file-form-defun (form)
2231 (byte-compile-file-form-defmumble form nil))
2233 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2234 (defun byte-compile-file-form-defmacro (form)
2235 (byte-compile-file-form-defmumble form t))
2237 (defun byte-compile-file-form-defmumble (form macrop)
2238 (let* ((name (car (cdr form)))
2239 (this-kind (if macrop 'byte-compile-macro-environment
2240 'byte-compile-function-environment))
2241 (that-kind (if macrop 'byte-compile-function-environment
2242 'byte-compile-macro-environment))
2243 (this-one (assq name (symbol-value this-kind)))
2244 (that-one (assq name (symbol-value that-kind)))
2245 (byte-compile-free-references nil)
2246 (byte-compile-free-assignments nil))
2247 (byte-compile-set-symbol-position name)
2248 ;; When a function or macro is defined, add it to the call tree so that
2249 ;; we can tell when functions are not used.
2250 (if byte-compile-generate-call-tree
2251 (or (assq name byte-compile-call-tree)
2252 (setq byte-compile-call-tree
2253 (cons (list name nil nil) byte-compile-call-tree))))
2255 (setq byte-compile-current-form name) ; for warnings
2256 (if (memq 'redefine byte-compile-warnings)
2257 (byte-compile-arglist-warn form macrop))
2258 (if byte-compile-verbose
2259 (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
2260 (cond (that-one
2261 (if (and (memq 'redefine byte-compile-warnings)
2262 ;; don't warn when compiling the stubs in byte-run...
2263 (not (assq (nth 1 form)
2264 byte-compile-initial-macro-environment)))
2265 (byte-compile-warn
2266 "`%s' defined multiple times, as both function and macro"
2267 (nth 1 form)))
2268 (setcdr that-one nil))
2269 (this-one
2270 (when (and (memq 'redefine byte-compile-warnings)
2271 ;; hack: don't warn when compiling the magic internal
2272 ;; byte-compiler macros in byte-run.el...
2273 (not (assq (nth 1 form)
2274 byte-compile-initial-macro-environment)))
2275 (byte-compile-warn "%s `%s' defined multiple times in this file"
2276 (if macrop "macro" "function")
2277 (nth 1 form))))
2278 ((and (fboundp name)
2279 (eq (car-safe (symbol-function name))
2280 (if macrop 'lambda 'macro)))
2281 (when (memq 'redefine byte-compile-warnings)
2282 (byte-compile-warn "%s `%s' being redefined as a %s"
2283 (if macrop "function" "macro")
2284 (nth 1 form)
2285 (if macrop "macro" "function")))
2286 ;; shadow existing definition
2287 (set this-kind
2288 (cons (cons name nil) (symbol-value this-kind))))
2290 (let ((body (nthcdr 3 form)))
2291 (when (and (stringp (car body))
2292 (symbolp (car-safe (cdr-safe body)))
2293 (car-safe (cdr-safe body))
2294 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2295 (byte-compile-set-symbol-position (nth 1 form))
2296 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2297 (nth 1 form))))
2299 ;; Generate code for declarations in macro definitions.
2300 ;; Remove declarations from the body of the macro definition.
2301 (when macrop
2302 (let ((tail (nthcdr 2 form)))
2303 (when (stringp (car (cdr tail)))
2304 (setq tail (cdr tail)))
2305 (while (and (consp (car (cdr tail)))
2306 (eq (car (car (cdr tail))) 'declare))
2307 (let ((declaration (car (cdr tail))))
2308 (setcdr tail (cdr (cdr tail)))
2309 (princ `(if macro-declaration-function
2310 (funcall macro-declaration-function
2311 ',name ',declaration))
2312 outbuffer)))))
2314 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
2315 (code (byte-compile-byte-code-maker new-one)))
2316 (if this-one
2317 (setcdr this-one new-one)
2318 (set this-kind
2319 (cons (cons name new-one) (symbol-value this-kind))))
2320 (if (and (stringp (nth 3 form))
2321 (eq 'quote (car-safe code))
2322 (eq 'lambda (car-safe (nth 1 code))))
2323 (cons (car form)
2324 (cons name (cdr (nth 1 code))))
2325 (byte-compile-flush-pending)
2326 (if (not (stringp (nth 3 form)))
2327 ;; No doc string. Provide -1 as the "doc string index"
2328 ;; so that no element will be treated as a doc string.
2329 (byte-compile-output-docform
2330 (if (byte-compile-version-cond byte-compile-compatibility)
2331 "\n(fset '" "\n(defalias '")
2332 name
2333 (cond ((atom code)
2334 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2335 ((eq (car code) 'quote)
2336 (setq code new-one)
2337 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2338 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2339 (append code nil)
2340 (and (atom code) byte-compile-dynamic
2342 nil)
2343 ;; Output the form by hand, that's much simpler than having
2344 ;; b-c-output-file-form analyze the defalias.
2345 (byte-compile-output-docform
2346 (if (byte-compile-version-cond byte-compile-compatibility)
2347 "\n(fset '" "\n(defalias '")
2348 name
2349 (cond ((atom code)
2350 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2351 ((eq (car code) 'quote)
2352 (setq code new-one)
2353 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2354 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2355 (append code nil)
2356 (and (atom code) byte-compile-dynamic
2358 nil))
2359 (princ ")" outbuffer)
2360 nil))))
2362 ;; Print Lisp object EXP in the output file, inside a comment,
2363 ;; and return the file position it will have.
2364 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2365 (defun byte-compile-output-as-comment (exp quoted)
2366 (let ((position (point)))
2367 (set-buffer
2368 (prog1 (current-buffer)
2369 (set-buffer outbuffer)
2371 ;; Insert EXP, and make it a comment with #@LENGTH.
2372 (insert " ")
2373 (if quoted
2374 (prin1 exp outbuffer)
2375 (princ exp outbuffer))
2376 (goto-char position)
2377 ;; Quote certain special characters as needed.
2378 ;; get_doc_string in doc.c does the unquoting.
2379 (while (search-forward "\^A" nil t)
2380 (replace-match "\^A\^A" t t))
2381 (goto-char position)
2382 (while (search-forward "\000" nil t)
2383 (replace-match "\^A0" t t))
2384 (goto-char position)
2385 (while (search-forward "\037" nil t)
2386 (replace-match "\^A_" t t))
2387 (goto-char (point-max))
2388 (insert "\037")
2389 (goto-char position)
2390 (insert "#@" (format "%d" (- (position-bytes (point-max))
2391 (position-bytes position))))
2393 ;; Save the file position of the object.
2394 ;; Note we should add 1 to skip the space
2395 ;; that we inserted before the actual doc string,
2396 ;; and subtract 1 to convert from an 1-origin Emacs position
2397 ;; to a file position; they cancel.
2398 (setq position (point))
2399 (goto-char (point-max))))
2400 position))
2404 ;;;###autoload
2405 (defun byte-compile (form)
2406 "If FORM is a symbol, byte-compile its function definition.
2407 If FORM is a lambda or a macro, byte-compile it as a function."
2408 (displaying-byte-compile-warnings
2409 (byte-compile-close-variables
2410 (let* ((fun (if (symbolp form)
2411 (and (fboundp form) (symbol-function form))
2412 form))
2413 (macro (eq (car-safe fun) 'macro)))
2414 (if macro
2415 (setq fun (cdr fun)))
2416 (cond ((eq (car-safe fun) 'lambda)
2417 (setq fun (if macro
2418 (cons 'macro (byte-compile-lambda fun))
2419 (byte-compile-lambda fun)))
2420 (if (symbolp form)
2421 (defalias form fun)
2422 fun)))))))
2424 (defun byte-compile-sexp (sexp)
2425 "Compile and return SEXP."
2426 (displaying-byte-compile-warnings
2427 (byte-compile-close-variables
2428 (byte-compile-top-level sexp))))
2430 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2431 (defun byte-compile-byte-code-maker (fun)
2432 (cond
2433 ((byte-compile-version-cond byte-compile-compatibility)
2434 ;; Return (quote (lambda ...)).
2435 (list 'quote (byte-compile-byte-code-unmake fun)))
2436 ;; ## atom is faster than compiled-func-p.
2437 ((atom fun) ; compiled function.
2438 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2439 ;; would have produced a lambda.
2440 fun)
2441 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2442 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2443 ((let (tmp)
2444 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2445 (null (cdr (memq tmp fun))))
2446 ;; Generate a make-byte-code call.
2447 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2448 (nconc (list 'make-byte-code
2449 (list 'quote (nth 1 fun)) ;arglist
2450 (nth 1 tmp) ;bytes
2451 (nth 2 tmp) ;consts
2452 (nth 3 tmp)) ;depth
2453 (cond ((stringp (nth 2 fun))
2454 (list (nth 2 fun))) ;doc
2455 (interactive
2456 (list nil)))
2457 (cond (interactive
2458 (list (if (or (null (nth 1 interactive))
2459 (stringp (nth 1 interactive)))
2460 (nth 1 interactive)
2461 ;; Interactive spec is a list or a variable
2462 ;; (if it is correct).
2463 (list 'quote (nth 1 interactive))))))))
2464 ;; a non-compiled function (probably trivial)
2465 (list 'quote fun))))))
2467 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2468 (defun byte-compile-byte-code-unmake (function)
2469 (if (consp function)
2470 function;;It already is a lambda.
2471 (setq function (append function nil)) ; turn it into a list
2472 (nconc (list 'lambda (nth 0 function))
2473 (and (nth 4 function) (list (nth 4 function)))
2474 (if (nthcdr 5 function)
2475 (list (cons 'interactive (if (nth 5 function)
2476 (nthcdr 5 function)))))
2477 (list (list 'byte-code
2478 (nth 1 function) (nth 2 function)
2479 (nth 3 function))))))
2482 (defun byte-compile-check-lambda-list (list)
2483 "Check lambda-list LIST for errors."
2484 (let (vars)
2485 (while list
2486 (let ((arg (car list)))
2487 (when (symbolp arg)
2488 (byte-compile-set-symbol-position arg))
2489 (cond ((or (not (symbolp arg))
2490 (byte-compile-const-symbol-p arg t))
2491 (error "Invalid lambda variable %s" arg))
2492 ((eq arg '&rest)
2493 (unless (cdr list)
2494 (error "&rest without variable name"))
2495 (when (cddr list)
2496 (error "Garbage following &rest VAR in lambda-list")))
2497 ((eq arg '&optional)
2498 (unless (cdr list)
2499 (error "Variable name missing after &optional")))
2500 ((memq arg vars)
2501 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2503 (push arg vars))))
2504 (setq list (cdr list)))))
2507 ;; Byte-compile a lambda-expression and return a valid function.
2508 ;; The value is usually a compiled function but may be the original
2509 ;; lambda-expression.
2510 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2511 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2512 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2513 ;; for symbols generated by the byte compiler itself.
2514 (defun byte-compile-lambda (fun &optional add-lambda)
2515 (if add-lambda
2516 (setq fun (cons 'lambda fun))
2517 (unless (eq 'lambda (car-safe fun))
2518 (error "Not a lambda list: %S" fun))
2519 (byte-compile-set-symbol-position 'lambda))
2520 (byte-compile-check-lambda-list (nth 1 fun))
2521 (let* ((arglist (nth 1 fun))
2522 (byte-compile-bound-variables
2523 (nconc (and (memq 'free-vars byte-compile-warnings)
2524 (delq '&rest (delq '&optional (copy-sequence arglist))))
2525 byte-compile-bound-variables))
2526 (body (cdr (cdr fun)))
2527 (doc (if (stringp (car body))
2528 (prog1 (car body)
2529 ;; Discard the doc string
2530 ;; unless it is the last element of the body.
2531 (if (cdr body)
2532 (setq body (cdr body))))))
2533 (int (assq 'interactive body)))
2534 ;; Process the interactive spec.
2535 (when int
2536 (byte-compile-set-symbol-position 'interactive)
2537 ;; Skip (interactive) if it is in front (the most usual location).
2538 (if (eq int (car body))
2539 (setq body (cdr body)))
2540 (cond ((consp (cdr int))
2541 (if (cdr (cdr int))
2542 (byte-compile-warn "malformed interactive spec: %s"
2543 (prin1-to-string int)))
2544 ;; If the interactive spec is a call to `list', don't
2545 ;; compile it, because `call-interactively' looks at the
2546 ;; args of `list'. Actually, compile it to get warnings,
2547 ;; but don't use the result.
2548 (let ((form (nth 1 int)))
2549 (while (memq (car-safe form) '(let let* progn save-excursion))
2550 (while (consp (cdr form))
2551 (setq form (cdr form)))
2552 (setq form (car form)))
2553 (if (eq (car-safe form) 'list)
2554 (byte-compile-top-level (nth 1 int))
2555 (setq int (list 'interactive
2556 (byte-compile-top-level (nth 1 int)))))))
2557 ((cdr int)
2558 (byte-compile-warn "malformed interactive spec: %s"
2559 (prin1-to-string int)))))
2560 ;; Process the body.
2561 (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
2562 ;; Build the actual byte-coded function.
2563 (if (and (eq 'byte-code (car-safe compiled))
2564 (not (byte-compile-version-cond
2565 byte-compile-compatibility)))
2566 (apply 'make-byte-code
2567 (append (list arglist)
2568 ;; byte-string, constants-vector, stack depth
2569 (cdr compiled)
2570 ;; optionally, the doc string.
2571 (if (or doc int)
2572 (list doc))
2573 ;; optionally, the interactive spec.
2574 (if int
2575 (list (nth 1 int)))))
2576 (setq compiled
2577 (nconc (if int (list int))
2578 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2579 (compiled (list compiled)))))
2580 (nconc (list 'lambda arglist)
2581 (if (or doc (stringp (car compiled)))
2582 (cons doc (cond (compiled)
2583 (body (list nil))))
2584 compiled))))))
2586 (defun byte-compile-constants-vector ()
2587 ;; Builds the constants-vector from the current variables and constants.
2588 ;; This modifies the constants from (const . nil) to (const . offset).
2589 ;; To keep the byte-codes to look up the vector as short as possible:
2590 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2591 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2592 ;; Next variables again, to get 2-byte codes for variable lookup.
2593 ;; The rest of the constants and variables need 3-byte byte-codes.
2594 (let* ((i -1)
2595 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2596 (other (nreverse byte-compile-constants)) ; vars often are used most.
2597 ret tmp
2598 (limits '(5 ; Use the 1-byte varref codes,
2599 63 ; 1-constlim ; 1-byte byte-constant codes,
2600 255 ; 2-byte varref codes,
2601 65535)) ; 3-byte codes for the rest.
2602 limit)
2603 (while (or rest other)
2604 (setq limit (car limits))
2605 (while (and rest (not (eq i limit)))
2606 (if (setq tmp (assq (car (car rest)) ret))
2607 (setcdr (car rest) (cdr tmp))
2608 (setcdr (car rest) (setq i (1+ i)))
2609 (setq ret (cons (car rest) ret)))
2610 (setq rest (cdr rest)))
2611 (setq limits (cdr limits)
2612 rest (prog1 other
2613 (setq other rest))))
2614 (apply 'vector (nreverse (mapcar 'car ret)))))
2616 ;; Given an expression FORM, compile it and return an equivalent byte-code
2617 ;; expression (a call to the function byte-code).
2618 (defun byte-compile-top-level (form &optional for-effect output-type)
2619 ;; OUTPUT-TYPE advises about how form is expected to be used:
2620 ;; 'eval or nil -> a single form,
2621 ;; 'progn or t -> a list of forms,
2622 ;; 'lambda -> body of a lambda,
2623 ;; 'file -> used at file-level.
2624 (let ((byte-compile-constants nil)
2625 (byte-compile-variables nil)
2626 (byte-compile-tag-number 0)
2627 (byte-compile-depth 0)
2628 (byte-compile-maxdepth 0)
2629 (byte-compile-output nil))
2630 (if (memq byte-optimize '(t source))
2631 (setq form (byte-optimize-form form for-effect)))
2632 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2633 (setq form (nth 1 form)))
2634 (if (and (eq 'byte-code (car-safe form))
2635 (not (memq byte-optimize '(t byte)))
2636 (stringp (nth 1 form)) (vectorp (nth 2 form))
2637 (natnump (nth 3 form)))
2638 form
2639 (byte-compile-form form for-effect)
2640 (byte-compile-out-toplevel for-effect output-type))))
2642 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2643 (if for-effect
2644 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2645 (if (eq (car (car byte-compile-output)) 'byte-discard)
2646 (setq byte-compile-output (cdr byte-compile-output))
2647 (byte-compile-push-constant
2648 ;; Push any constant - preferably one which already is used, and
2649 ;; a number or symbol - ie not some big sequence. The return value
2650 ;; isn't returned, but it would be a shame if some textually large
2651 ;; constant was not optimized away because we chose to return it.
2652 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2653 (let ((tmp (reverse byte-compile-constants)))
2654 (while (and tmp (not (or (symbolp (caar tmp))
2655 (numberp (caar tmp)))))
2656 (setq tmp (cdr tmp)))
2657 (caar tmp))))))
2658 (byte-compile-out 'byte-return 0)
2659 (setq byte-compile-output (nreverse byte-compile-output))
2660 (if (memq byte-optimize '(t byte))
2661 (setq byte-compile-output
2662 (byte-optimize-lapcode byte-compile-output for-effect)))
2664 ;; Decompile trivial functions:
2665 ;; only constants and variables, or a single funcall except in lambdas.
2666 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2667 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2668 ;; Note that even (quote foo) must be parsed just as any subr by the
2669 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2670 ;; What to leave uncompiled:
2671 ;; lambda -> never. we used to leave it uncompiled if the body was
2672 ;; a single atom, but that causes confusion if the docstring
2673 ;; uses the (file . pos) syntax. Besides, now that we have
2674 ;; the Lisp_Compiled type, the compiled form is faster.
2675 ;; eval -> atom, quote or (function atom atom atom)
2676 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2677 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2678 (let (rest
2679 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2680 tmp body)
2681 (cond
2682 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2683 ((or (eq output-type 'lambda)
2684 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2685 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2686 (not (setq tmp (assq 'byte-return byte-compile-output)))
2687 (progn
2688 (setq rest (nreverse
2689 (cdr (memq tmp (reverse byte-compile-output)))))
2690 (while (cond
2691 ((memq (car (car rest)) '(byte-varref byte-constant))
2692 (setq tmp (car (cdr (car rest))))
2693 (if (if (eq (car (car rest)) 'byte-constant)
2694 (or (consp tmp)
2695 (and (symbolp tmp)
2696 (not (byte-compile-const-symbol-p tmp)))))
2697 (if maycall
2698 (setq body (cons (list 'quote tmp) body)))
2699 (setq body (cons tmp body))))
2700 ((and maycall
2701 ;; Allow a funcall if at most one atom follows it.
2702 (null (nthcdr 3 rest))
2703 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2704 (or (null (cdr rest))
2705 (and (memq output-type '(file progn t))
2706 (cdr (cdr rest))
2707 (eq (car (nth 1 rest)) 'byte-discard)
2708 (progn (setq rest (cdr rest)) t))))
2709 (setq maycall nil) ; Only allow one real function call.
2710 (setq body (nreverse body))
2711 (setq body (list
2712 (if (and (eq tmp 'funcall)
2713 (eq (car-safe (car body)) 'quote))
2714 (cons (nth 1 (car body)) (cdr body))
2715 (cons tmp body))))
2716 (or (eq output-type 'file)
2717 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2718 (setq rest (cdr rest)))
2719 rest))
2720 (let ((byte-compile-vector (byte-compile-constants-vector)))
2721 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2722 byte-compile-vector byte-compile-maxdepth)))
2723 ;; it's a trivial function
2724 ((cdr body) (cons 'progn (nreverse body)))
2725 ((car body)))))
2727 ;; Given BODY, compile it and return a new body.
2728 (defun byte-compile-top-level-body (body &optional for-effect)
2729 (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
2730 (cond ((eq (car-safe body) 'progn)
2731 (cdr body))
2732 (body
2733 (list body))))
2735 ;; This is the recursive entry point for compiling each subform of an
2736 ;; expression.
2737 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2738 ;; before terminating (ie no value will be left on the stack).
2739 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2740 ;; which does not leave a value on the stack, and then set for-effect to nil
2741 ;; (to prevent byte-compile-form from outputting the byte-discard).
2742 ;; If a handler wants to call another handler, it should do so via
2743 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2744 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2746 (defun byte-compile-form (form &optional for-effect)
2747 (setq form (macroexpand form byte-compile-macro-environment))
2748 (cond ((not (consp form))
2749 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2750 (when (symbolp form)
2751 (byte-compile-set-symbol-position form))
2752 (byte-compile-constant form))
2753 ((and for-effect byte-compile-delete-errors)
2754 (when (symbolp form)
2755 (byte-compile-set-symbol-position form))
2756 (setq for-effect nil))
2757 (t (byte-compile-variable-ref 'byte-varref form))))
2758 ((symbolp (car form))
2759 (let* ((fn (car form))
2760 (handler (get fn 'byte-compile)))
2761 (when (byte-compile-const-symbol-p fn)
2762 (byte-compile-warn "`%s' called as a function" fn))
2763 (and (memq 'interactive-only byte-compile-warnings)
2764 (memq fn byte-compile-interactive-only-functions)
2765 (byte-compile-warn "`%s' used from Lisp code\n\
2766 That command is designed for interactive use only" fn))
2767 (if (and handler
2768 ;; Make sure that function exists. This is important
2769 ;; for CL compiler macros since the symbol may be
2770 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2771 ;; loaded, this function doesn't exist.
2772 (or (not (memq handler '(cl-byte-compile-compiler-macro)))
2773 (fboundp handler))
2774 (not (and (byte-compile-version-cond
2775 byte-compile-compatibility)
2776 (get (get fn 'byte-opcode) 'emacs19-opcode))))
2777 (funcall handler form)
2778 (when (memq 'callargs byte-compile-warnings)
2779 (if (memq fn '(custom-declare-group custom-declare-variable custom-declare-face))
2780 (byte-compile-nogroup-warn form))
2781 (byte-compile-callargs-warn form))
2782 (byte-compile-normal-call form))
2783 (if (memq 'cl-functions byte-compile-warnings)
2784 (byte-compile-cl-warn form))))
2785 ((and (or (byte-code-function-p (car form))
2786 (eq (car-safe (car form)) 'lambda))
2787 ;; if the form comes out the same way it went in, that's
2788 ;; because it was malformed, and we couldn't unfold it.
2789 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2790 (byte-compile-form form for-effect)
2791 (setq for-effect nil))
2792 ((byte-compile-normal-call form)))
2793 (if for-effect
2794 (byte-compile-discard)))
2796 (defun byte-compile-normal-call (form)
2797 (if byte-compile-generate-call-tree
2798 (byte-compile-annotate-call-tree form))
2799 (byte-compile-push-constant (car form))
2800 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2801 (byte-compile-out 'byte-call (length (cdr form))))
2803 (defun byte-compile-variable-ref (base-op var)
2804 (when (symbolp var)
2805 (byte-compile-set-symbol-position var))
2806 (if (or (not (symbolp var))
2807 (byte-compile-const-symbol-p var (not (eq base-op 'byte-varref))))
2808 (byte-compile-warn
2809 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2810 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2811 (t "variable reference to %s `%s'"))
2812 (if (symbolp var) "constant" "nonvariable")
2813 (prin1-to-string var))
2814 (if (and (get var 'byte-obsolete-variable)
2815 (memq 'obsolete byte-compile-warnings)
2816 (not (eq var byte-compile-not-obsolete-var)))
2817 (let* ((ob (get var 'byte-obsolete-variable))
2818 (when (cdr ob)))
2819 (byte-compile-warn "`%s' is an obsolete variable%s; %s" var
2820 (if when (concat " (as of Emacs " when ")") "")
2821 (if (stringp (car ob))
2822 (car ob)
2823 (format "use `%s' instead." (car ob))))))
2824 (if (memq 'free-vars byte-compile-warnings)
2825 (if (eq base-op 'byte-varbind)
2826 (push var byte-compile-bound-variables)
2827 (or (boundp var)
2828 (memq var byte-compile-bound-variables)
2829 (if (eq base-op 'byte-varset)
2830 (or (memq var byte-compile-free-assignments)
2831 (progn
2832 (byte-compile-warn "assignment to free variable `%s'" var)
2833 (push var byte-compile-free-assignments)))
2834 (or (memq var byte-compile-free-references)
2835 (progn
2836 (byte-compile-warn "reference to free variable `%s'" var)
2837 (push var byte-compile-free-references))))))))
2838 (let ((tmp (assq var byte-compile-variables)))
2839 (unless tmp
2840 (setq tmp (list var))
2841 (push tmp byte-compile-variables))
2842 (byte-compile-out base-op tmp)))
2844 (defmacro byte-compile-get-constant (const)
2845 `(or (if (stringp ,const)
2846 (assoc-default ,const byte-compile-constants
2847 'equal-including-properties nil)
2848 (assq ,const byte-compile-constants))
2849 (car (setq byte-compile-constants
2850 (cons (list ,const) byte-compile-constants)))))
2852 ;; Use this when the value of a form is a constant. This obeys for-effect.
2853 (defun byte-compile-constant (const)
2854 (if for-effect
2855 (setq for-effect nil)
2856 (when (symbolp const)
2857 (byte-compile-set-symbol-position const))
2858 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2860 ;; Use this for a constant that is not the value of its containing form.
2861 ;; This ignores for-effect.
2862 (defun byte-compile-push-constant (const)
2863 (let ((for-effect nil))
2864 (inline (byte-compile-constant const))))
2867 ;; Compile those primitive ordinary functions
2868 ;; which have special byte codes just for speed.
2870 (defmacro byte-defop-compiler (function &optional compile-handler)
2871 ;; add a compiler-form for FUNCTION.
2872 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2873 ;; the opcode to be used. If function is a list, the first element
2874 ;; is the function and the second element is the bytecode-symbol.
2875 ;; The second element may be nil, meaning there is no opcode.
2876 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2877 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2878 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2879 (let (opcode)
2880 (if (symbolp function)
2881 (setq opcode (intern (concat "byte-" (symbol-name function))))
2882 (setq opcode (car (cdr function))
2883 function (car function)))
2884 (let ((fnform
2885 (list 'put (list 'quote function) ''byte-compile
2886 (list 'quote
2887 (or (cdr (assq compile-handler
2888 '((0 . byte-compile-no-args)
2889 (1 . byte-compile-one-arg)
2890 (2 . byte-compile-two-args)
2891 (3 . byte-compile-three-args)
2892 (0-1 . byte-compile-zero-or-one-arg)
2893 (1-2 . byte-compile-one-or-two-args)
2894 (2-3 . byte-compile-two-or-three-args)
2896 compile-handler
2897 (intern (concat "byte-compile-"
2898 (symbol-name function))))))))
2899 (if opcode
2900 (list 'progn fnform
2901 (list 'put (list 'quote function)
2902 ''byte-opcode (list 'quote opcode))
2903 (list 'put (list 'quote opcode)
2904 ''byte-opcode-invert (list 'quote function)))
2905 fnform))))
2907 (defmacro byte-defop-compiler19 (function &optional compile-handler)
2908 ;; Just like byte-defop-compiler, but defines an opcode that will only
2909 ;; be used when byte-compile-compatibility is false.
2910 (if (and (byte-compile-single-version)
2911 byte-compile-compatibility)
2912 ;; #### instead of doing nothing, this should do some remprops,
2913 ;; #### to protect against the case where a single-version compiler
2914 ;; #### is loaded into a world that has contained a multi-version one.
2916 (list 'progn
2917 (list 'put
2918 (list 'quote
2919 (or (car (cdr-safe function))
2920 (intern (concat "byte-"
2921 (symbol-name (or (car-safe function) function))))))
2922 ''emacs19-opcode t)
2923 (list 'byte-defop-compiler function compile-handler))))
2925 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
2926 (list 'byte-defop-compiler (list function nil) compile-handler))
2929 (put 'byte-call 'byte-opcode-invert 'funcall)
2930 (put 'byte-list1 'byte-opcode-invert 'list)
2931 (put 'byte-list2 'byte-opcode-invert 'list)
2932 (put 'byte-list3 'byte-opcode-invert 'list)
2933 (put 'byte-list4 'byte-opcode-invert 'list)
2934 (put 'byte-listN 'byte-opcode-invert 'list)
2935 (put 'byte-concat2 'byte-opcode-invert 'concat)
2936 (put 'byte-concat3 'byte-opcode-invert 'concat)
2937 (put 'byte-concat4 'byte-opcode-invert 'concat)
2938 (put 'byte-concatN 'byte-opcode-invert 'concat)
2939 (put 'byte-insertN 'byte-opcode-invert 'insert)
2941 (byte-defop-compiler point 0)
2942 ;;(byte-defop-compiler mark 0) ;; obsolete
2943 (byte-defop-compiler point-max 0)
2944 (byte-defop-compiler point-min 0)
2945 (byte-defop-compiler following-char 0)
2946 (byte-defop-compiler preceding-char 0)
2947 (byte-defop-compiler current-column 0)
2948 (byte-defop-compiler eolp 0)
2949 (byte-defop-compiler eobp 0)
2950 (byte-defop-compiler bolp 0)
2951 (byte-defop-compiler bobp 0)
2952 (byte-defop-compiler current-buffer 0)
2953 ;;(byte-defop-compiler read-char 0) ;; obsolete
2954 (byte-defop-compiler interactive-p 0)
2955 (byte-defop-compiler19 widen 0)
2956 (byte-defop-compiler19 end-of-line 0-1)
2957 (byte-defop-compiler19 forward-char 0-1)
2958 (byte-defop-compiler19 forward-line 0-1)
2959 (byte-defop-compiler symbolp 1)
2960 (byte-defop-compiler consp 1)
2961 (byte-defop-compiler stringp 1)
2962 (byte-defop-compiler listp 1)
2963 (byte-defop-compiler not 1)
2964 (byte-defop-compiler (null byte-not) 1)
2965 (byte-defop-compiler car 1)
2966 (byte-defop-compiler cdr 1)
2967 (byte-defop-compiler length 1)
2968 (byte-defop-compiler symbol-value 1)
2969 (byte-defop-compiler symbol-function 1)
2970 (byte-defop-compiler (1+ byte-add1) 1)
2971 (byte-defop-compiler (1- byte-sub1) 1)
2972 (byte-defop-compiler goto-char 1)
2973 (byte-defop-compiler char-after 0-1)
2974 (byte-defop-compiler set-buffer 1)
2975 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2976 (byte-defop-compiler19 forward-word 0-1)
2977 (byte-defop-compiler19 char-syntax 1)
2978 (byte-defop-compiler19 nreverse 1)
2979 (byte-defop-compiler19 car-safe 1)
2980 (byte-defop-compiler19 cdr-safe 1)
2981 (byte-defop-compiler19 numberp 1)
2982 (byte-defop-compiler19 integerp 1)
2983 (byte-defop-compiler19 skip-chars-forward 1-2)
2984 (byte-defop-compiler19 skip-chars-backward 1-2)
2985 (byte-defop-compiler eq 2)
2986 (byte-defop-compiler memq 2)
2987 (byte-defop-compiler cons 2)
2988 (byte-defop-compiler aref 2)
2989 (byte-defop-compiler set 2)
2990 (byte-defop-compiler (= byte-eqlsign) 2)
2991 (byte-defop-compiler (< byte-lss) 2)
2992 (byte-defop-compiler (> byte-gtr) 2)
2993 (byte-defop-compiler (<= byte-leq) 2)
2994 (byte-defop-compiler (>= byte-geq) 2)
2995 (byte-defop-compiler get 2)
2996 (byte-defop-compiler nth 2)
2997 (byte-defop-compiler substring 2-3)
2998 (byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
2999 (byte-defop-compiler19 set-marker 2-3)
3000 (byte-defop-compiler19 match-beginning 1)
3001 (byte-defop-compiler19 match-end 1)
3002 (byte-defop-compiler19 upcase 1)
3003 (byte-defop-compiler19 downcase 1)
3004 (byte-defop-compiler19 string= 2)
3005 (byte-defop-compiler19 string< 2)
3006 (byte-defop-compiler19 (string-equal byte-string=) 2)
3007 (byte-defop-compiler19 (string-lessp byte-string<) 2)
3008 (byte-defop-compiler19 equal 2)
3009 (byte-defop-compiler19 nthcdr 2)
3010 (byte-defop-compiler19 elt 2)
3011 (byte-defop-compiler19 member 2)
3012 (byte-defop-compiler19 assq 2)
3013 (byte-defop-compiler19 (rplaca byte-setcar) 2)
3014 (byte-defop-compiler19 (rplacd byte-setcdr) 2)
3015 (byte-defop-compiler19 setcar 2)
3016 (byte-defop-compiler19 setcdr 2)
3017 (byte-defop-compiler19 buffer-substring 2)
3018 (byte-defop-compiler19 delete-region 2)
3019 (byte-defop-compiler19 narrow-to-region 2)
3020 (byte-defop-compiler19 (% byte-rem) 2)
3021 (byte-defop-compiler aset 3)
3023 (byte-defop-compiler max byte-compile-associative)
3024 (byte-defop-compiler min byte-compile-associative)
3025 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3026 (byte-defop-compiler19 (* byte-mult) byte-compile-associative)
3028 ;;####(byte-defop-compiler19 move-to-column 1)
3029 (byte-defop-compiler-1 interactive byte-compile-noop)
3032 (defun byte-compile-subr-wrong-args (form n)
3033 (byte-compile-set-symbol-position (car form))
3034 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3035 (car form) (length (cdr form))
3036 (if (= 1 (length (cdr form))) "" "s") n)
3037 ;; get run-time wrong-number-of-args error.
3038 (byte-compile-normal-call form))
3040 (defun byte-compile-no-args (form)
3041 (if (not (= (length form) 1))
3042 (byte-compile-subr-wrong-args form "none")
3043 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3045 (defun byte-compile-one-arg (form)
3046 (if (not (= (length form) 2))
3047 (byte-compile-subr-wrong-args form 1)
3048 (byte-compile-form (car (cdr form))) ;; Push the argument
3049 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3051 (defun byte-compile-two-args (form)
3052 (if (not (= (length form) 3))
3053 (byte-compile-subr-wrong-args form 2)
3054 (byte-compile-form (car (cdr form))) ;; Push the arguments
3055 (byte-compile-form (nth 2 form))
3056 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3058 (defun byte-compile-three-args (form)
3059 (if (not (= (length form) 4))
3060 (byte-compile-subr-wrong-args form 3)
3061 (byte-compile-form (car (cdr form))) ;; Push the arguments
3062 (byte-compile-form (nth 2 form))
3063 (byte-compile-form (nth 3 form))
3064 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3066 (defun byte-compile-zero-or-one-arg (form)
3067 (let ((len (length form)))
3068 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3069 ((= len 2) (byte-compile-one-arg form))
3070 (t (byte-compile-subr-wrong-args form "0-1")))))
3072 (defun byte-compile-one-or-two-args (form)
3073 (let ((len (length form)))
3074 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3075 ((= len 3) (byte-compile-two-args form))
3076 (t (byte-compile-subr-wrong-args form "1-2")))))
3078 (defun byte-compile-two-or-three-args (form)
3079 (let ((len (length form)))
3080 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3081 ((= len 4) (byte-compile-three-args form))
3082 (t (byte-compile-subr-wrong-args form "2-3")))))
3084 (defun byte-compile-noop (form)
3085 (byte-compile-constant nil))
3087 (defun byte-compile-discard ()
3088 (byte-compile-out 'byte-discard 0))
3091 ;; Compile a function that accepts one or more args and is right-associative.
3092 ;; We do it by left-associativity so that the operations
3093 ;; are done in the same order as in interpreted code.
3094 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3095 ;; in order to convert markers to numbers, and trigger expected errors.
3096 (defun byte-compile-associative (form)
3097 (if (cdr form)
3098 (let ((opcode (get (car form) 'byte-opcode))
3099 (args (copy-sequence (cdr form))))
3100 (byte-compile-form (car args))
3101 (setq args (cdr args))
3102 (or args (setq args '(0)
3103 opcode (get '+ 'byte-opcode)))
3104 (dolist (arg args)
3105 (byte-compile-form arg)
3106 (byte-compile-out opcode 0)))
3107 (byte-compile-constant (eval form))))
3110 ;; more complicated compiler macros
3112 (byte-defop-compiler list)
3113 (byte-defop-compiler concat)
3114 (byte-defop-compiler fset)
3115 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3116 (byte-defop-compiler indent-to)
3117 (byte-defop-compiler insert)
3118 (byte-defop-compiler-1 function byte-compile-function-form)
3119 (byte-defop-compiler-1 - byte-compile-minus)
3120 (byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
3121 (byte-defop-compiler19 nconc)
3123 (defun byte-compile-list (form)
3124 (let ((count (length (cdr form))))
3125 (cond ((= count 0)
3126 (byte-compile-constant nil))
3127 ((< count 5)
3128 (mapc 'byte-compile-form (cdr form))
3129 (byte-compile-out
3130 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3131 ((and (< count 256) (not (byte-compile-version-cond
3132 byte-compile-compatibility)))
3133 (mapc 'byte-compile-form (cdr form))
3134 (byte-compile-out 'byte-listN count))
3135 (t (byte-compile-normal-call form)))))
3137 (defun byte-compile-concat (form)
3138 (let ((count (length (cdr form))))
3139 (cond ((and (< 1 count) (< count 5))
3140 (mapc 'byte-compile-form (cdr form))
3141 (byte-compile-out
3142 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3144 ;; Concat of one arg is not a no-op if arg is not a string.
3145 ((= count 0)
3146 (byte-compile-form ""))
3147 ((and (< count 256) (not (byte-compile-version-cond
3148 byte-compile-compatibility)))
3149 (mapc 'byte-compile-form (cdr form))
3150 (byte-compile-out 'byte-concatN count))
3151 ((byte-compile-normal-call form)))))
3153 (defun byte-compile-minus (form)
3154 (if (null (setq form (cdr form)))
3155 (byte-compile-constant 0)
3156 (byte-compile-form (car form))
3157 (if (cdr form)
3158 (while (setq form (cdr form))
3159 (byte-compile-form (car form))
3160 (byte-compile-out 'byte-diff 0))
3161 (byte-compile-out 'byte-negate 0))))
3163 (defun byte-compile-quo (form)
3164 (let ((len (length form)))
3165 (cond ((<= len 2)
3166 (byte-compile-subr-wrong-args form "2 or more"))
3168 (byte-compile-form (car (setq form (cdr form))))
3169 (while (setq form (cdr form))
3170 (byte-compile-form (car form))
3171 (byte-compile-out 'byte-quo 0))))))
3173 (defun byte-compile-nconc (form)
3174 (let ((len (length form)))
3175 (cond ((= len 1)
3176 (byte-compile-constant nil))
3177 ((= len 2)
3178 ;; nconc of one arg is a noop, even if that arg isn't a list.
3179 (byte-compile-form (nth 1 form)))
3181 (byte-compile-form (car (setq form (cdr form))))
3182 (while (setq form (cdr form))
3183 (byte-compile-form (car form))
3184 (byte-compile-out 'byte-nconc 0))))))
3186 (defun byte-compile-fset (form)
3187 ;; warn about forms like (fset 'foo '(lambda () ...))
3188 ;; (where the lambda expression is non-trivial...)
3189 (let ((fn (nth 2 form))
3190 body)
3191 (if (and (eq (car-safe fn) 'quote)
3192 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3193 (progn
3194 (setq body (cdr (cdr fn)))
3195 (if (stringp (car body)) (setq body (cdr body)))
3196 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3197 (if (and (consp (car body))
3198 (not (eq 'byte-code (car (car body)))))
3199 (byte-compile-warn
3200 "A quoted lambda form is the second argument of `fset'. This is probably
3201 not what you want, as that lambda cannot be compiled. Consider using
3202 the syntax (function (lambda (...) ...)) instead.")))))
3203 (byte-compile-two-args form))
3205 (defun byte-compile-funarg (form)
3206 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3207 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3208 (byte-compile-normal-call
3209 (let ((fn (nth 1 form)))
3210 (if (and (eq (car-safe fn) 'quote)
3211 (eq (car-safe (nth 1 fn)) 'lambda))
3212 (cons (car form)
3213 (cons (cons 'function (cdr fn))
3214 (cdr (cdr form))))
3215 form))))
3217 (defun byte-compile-funarg-2 (form)
3218 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3219 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3220 (byte-compile-normal-call
3221 (let ((fn (nth 2 form)))
3222 (if (and (eq (car-safe fn) 'quote)
3223 (eq (car-safe (nth 1 fn)) 'lambda))
3224 (cons (car form)
3225 (cons (nth 1 form)
3226 (cons (cons 'function (cdr fn))
3227 (cdr (cdr (cdr form))))))
3228 form))))
3230 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3231 ;; Otherwise it will be incompatible with the interpreter,
3232 ;; and (funcall (function foo)) will lose with autoloads.
3234 (defun byte-compile-function-form (form)
3235 (byte-compile-constant
3236 (cond ((symbolp (nth 1 form))
3237 (nth 1 form))
3238 ;; If we're not allowed to use #[] syntax, then output a form like
3239 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3240 ;; In this situation, calling make-byte-code at run-time will usually
3241 ;; be less efficient than processing a call to byte-code.
3242 ((byte-compile-version-cond byte-compile-compatibility)
3243 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
3244 ((byte-compile-lambda (nth 1 form))))))
3246 (defun byte-compile-indent-to (form)
3247 (let ((len (length form)))
3248 (cond ((= len 2)
3249 (byte-compile-form (car (cdr form)))
3250 (byte-compile-out 'byte-indent-to 0))
3251 ((= len 3)
3252 ;; no opcode for 2-arg case.
3253 (byte-compile-normal-call form))
3255 (byte-compile-subr-wrong-args form "1-2")))))
3257 (defun byte-compile-insert (form)
3258 (cond ((null (cdr form))
3259 (byte-compile-constant nil))
3260 ((and (not (byte-compile-version-cond
3261 byte-compile-compatibility))
3262 (<= (length form) 256))
3263 (mapc 'byte-compile-form (cdr form))
3264 (if (cdr (cdr form))
3265 (byte-compile-out 'byte-insertN (length (cdr form)))
3266 (byte-compile-out 'byte-insert 0)))
3267 ((memq t (mapcar 'consp (cdr (cdr form))))
3268 (byte-compile-normal-call form))
3269 ;; We can split it; there is no function call after inserting 1st arg.
3271 (while (setq form (cdr form))
3272 (byte-compile-form (car form))
3273 (byte-compile-out 'byte-insert 0)
3274 (if (cdr form)
3275 (byte-compile-discard))))))
3278 (byte-defop-compiler-1 setq)
3279 (byte-defop-compiler-1 setq-default)
3280 (byte-defop-compiler-1 quote)
3281 (byte-defop-compiler-1 quote-form)
3283 (defun byte-compile-setq (form)
3284 (let ((args (cdr form)))
3285 (if args
3286 (while args
3287 (byte-compile-form (car (cdr args)))
3288 (or for-effect (cdr (cdr args))
3289 (byte-compile-out 'byte-dup 0))
3290 (byte-compile-variable-ref 'byte-varset (car args))
3291 (setq args (cdr (cdr args))))
3292 ;; (setq), with no arguments.
3293 (byte-compile-form nil for-effect))
3294 (setq for-effect nil)))
3296 (defun byte-compile-setq-default (form)
3297 (let ((args (cdr form))
3298 setters)
3299 (while args
3300 (setq setters
3301 (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
3302 setters))
3303 (setq args (cdr (cdr args))))
3304 (byte-compile-form (cons 'progn (nreverse setters)))))
3306 (defun byte-compile-quote (form)
3307 (byte-compile-constant (car (cdr form))))
3309 (defun byte-compile-quote-form (form)
3310 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3313 ;;; control structures
3315 (defun byte-compile-body (body &optional for-effect)
3316 (while (cdr body)
3317 (byte-compile-form (car body) t)
3318 (setq body (cdr body)))
3319 (byte-compile-form (car body) for-effect))
3321 (defsubst byte-compile-body-do-effect (body)
3322 (byte-compile-body body for-effect)
3323 (setq for-effect nil))
3325 (defsubst byte-compile-form-do-effect (form)
3326 (byte-compile-form form for-effect)
3327 (setq for-effect nil))
3329 (byte-defop-compiler-1 inline byte-compile-progn)
3330 (byte-defop-compiler-1 progn)
3331 (byte-defop-compiler-1 prog1)
3332 (byte-defop-compiler-1 prog2)
3333 (byte-defop-compiler-1 if)
3334 (byte-defop-compiler-1 cond)
3335 (byte-defop-compiler-1 and)
3336 (byte-defop-compiler-1 or)
3337 (byte-defop-compiler-1 while)
3338 (byte-defop-compiler-1 funcall)
3339 (byte-defop-compiler-1 apply byte-compile-funarg)
3340 (byte-defop-compiler-1 mapcar byte-compile-funarg)
3341 (byte-defop-compiler-1 mapatoms byte-compile-funarg)
3342 (byte-defop-compiler-1 mapconcat byte-compile-funarg)
3343 (byte-defop-compiler-1 mapc byte-compile-funarg)
3344 (byte-defop-compiler-1 maphash byte-compile-funarg)
3345 (byte-defop-compiler-1 map-char-table byte-compile-funarg)
3346 (byte-defop-compiler-1 sort byte-compile-funarg-2)
3347 (byte-defop-compiler-1 let)
3348 (byte-defop-compiler-1 let*)
3350 (defun byte-compile-progn (form)
3351 (byte-compile-body-do-effect (cdr form)))
3353 (defun byte-compile-prog1 (form)
3354 (byte-compile-form-do-effect (car (cdr form)))
3355 (byte-compile-body (cdr (cdr form)) t))
3357 (defun byte-compile-prog2 (form)
3358 (byte-compile-form (nth 1 form) t)
3359 (byte-compile-form-do-effect (nth 2 form))
3360 (byte-compile-body (cdr (cdr (cdr form))) t))
3362 (defmacro byte-compile-goto-if (cond discard tag)
3363 `(byte-compile-goto
3364 (if ,cond
3365 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3366 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3367 ,tag))
3369 (defmacro byte-compile-maybe-guarded (condition &rest body)
3370 "Execute forms in BODY, potentially guarded by CONDITION.
3371 CONDITION is a variable whose value is a test in an `if' or `cond'.
3372 BODY is the code to compile first arm of the if or the body of the
3373 cond clause. If CONDITION's value is of the form (fboundp 'foo)
3374 or (boundp 'foo), the relevant warnings from BODY about foo's
3375 being undefined will be suppressed.
3377 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3378 that suppresses all warnings during execution of BODY."
3379 (declare (indent 1) (debug t))
3380 `(let* ((fbound
3381 (if (eq 'fboundp (car-safe ,condition))
3382 (and (eq 'quote (car-safe (nth 1 ,condition)))
3383 ;; Ignore if the symbol is already on the
3384 ;; unresolved list.
3385 (not (assq (nth 1 (nth 1 ,condition)) ; the relevant symbol
3386 byte-compile-unresolved-functions))
3387 (nth 1 (nth 1 ,condition)))))
3388 (bound (if (or (eq 'boundp (car-safe ,condition))
3389 (eq 'default-boundp (car-safe ,condition)))
3390 (and (eq 'quote (car-safe (nth 1 ,condition)))
3391 (nth 1 (nth 1 ,condition)))))
3392 ;; Maybe add to the bound list.
3393 (byte-compile-bound-variables
3394 (if bound
3395 (cons bound byte-compile-bound-variables)
3396 byte-compile-bound-variables))
3397 ;; Suppress all warnings, for code not used in Emacs.
3398 (byte-compile-warnings
3399 (if (member ,condition '((featurep 'xemacs)
3400 (not (featurep 'emacs))))
3401 nil byte-compile-warnings)))
3402 (unwind-protect
3403 (progn ,@body)
3404 ;; Maybe remove the function symbol from the unresolved list.
3405 (if fbound
3406 (setq byte-compile-unresolved-functions
3407 (delq (assq fbound byte-compile-unresolved-functions)
3408 byte-compile-unresolved-functions))))))
3410 (defun byte-compile-if (form)
3411 (byte-compile-form (car (cdr form)))
3412 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3413 ;; and avoid warnings about the relevent symbols in the consequent.
3414 (let ((clause (nth 1 form))
3415 (donetag (byte-compile-make-tag)))
3416 (if (null (nthcdr 3 form))
3417 ;; No else-forms
3418 (progn
3419 (byte-compile-goto-if nil for-effect donetag)
3420 (byte-compile-maybe-guarded clause
3421 (byte-compile-form (nth 2 form) for-effect))
3422 (byte-compile-out-tag donetag))
3423 (let ((elsetag (byte-compile-make-tag)))
3424 (byte-compile-goto 'byte-goto-if-nil elsetag)
3425 (byte-compile-maybe-guarded clause
3426 (byte-compile-form (nth 2 form) for-effect))
3427 (byte-compile-goto 'byte-goto donetag)
3428 (byte-compile-out-tag elsetag)
3429 (byte-compile-maybe-guarded (list 'not clause)
3430 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3431 (byte-compile-out-tag donetag))))
3432 (setq for-effect nil))
3434 (defun byte-compile-cond (clauses)
3435 (let ((donetag (byte-compile-make-tag))
3436 nexttag clause)
3437 (while (setq clauses (cdr clauses))
3438 (setq clause (car clauses))
3439 (cond ((or (eq (car clause) t)
3440 (and (eq (car-safe (car clause)) 'quote)
3441 (car-safe (cdr-safe (car clause)))))
3442 ;; Unconditional clause
3443 (setq clause (cons t clause)
3444 clauses nil))
3445 ((cdr clauses)
3446 (byte-compile-form (car clause))
3447 (if (null (cdr clause))
3448 ;; First clause is a singleton.
3449 (byte-compile-goto-if t for-effect donetag)
3450 (setq nexttag (byte-compile-make-tag))
3451 (byte-compile-goto 'byte-goto-if-nil nexttag)
3452 (byte-compile-maybe-guarded (car clause)
3453 (byte-compile-body (cdr clause) for-effect))
3454 (byte-compile-goto 'byte-goto donetag)
3455 (byte-compile-out-tag nexttag)))))
3456 ;; Last clause
3457 (let ((guard (car clause)))
3458 (and (cdr clause) (not (eq guard t))
3459 (progn (byte-compile-form guard)
3460 (byte-compile-goto-if nil for-effect donetag)
3461 (setq clause (cdr clause))))
3462 (byte-compile-maybe-guarded guard
3463 (byte-compile-body-do-effect clause)))
3464 (byte-compile-out-tag donetag)))
3466 (defun byte-compile-and (form)
3467 (let ((failtag (byte-compile-make-tag))
3468 (args (cdr form)))
3469 (if (null args)
3470 (byte-compile-form-do-effect t)
3471 (byte-compile-and-recursion args failtag))))
3473 ;; Handle compilation of a nontrivial `and' call.
3474 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3475 (defun byte-compile-and-recursion (rest failtag)
3476 (if (cdr rest)
3477 (progn
3478 (byte-compile-form (car rest))
3479 (byte-compile-goto-if nil for-effect failtag)
3480 (byte-compile-maybe-guarded (car rest)
3481 (byte-compile-and-recursion (cdr rest) failtag)))
3482 (byte-compile-form-do-effect (car rest))
3483 (byte-compile-out-tag failtag)))
3485 (defun byte-compile-or (form)
3486 (let ((wintag (byte-compile-make-tag))
3487 (args (cdr form)))
3488 (if (null args)
3489 (byte-compile-form-do-effect nil)
3490 (byte-compile-or-recursion args wintag))))
3492 ;; Handle compilation of a nontrivial `or' call.
3493 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3494 (defun byte-compile-or-recursion (rest wintag)
3495 (if (cdr rest)
3496 (progn
3497 (byte-compile-form (car rest))
3498 (byte-compile-goto-if t for-effect wintag)
3499 (byte-compile-maybe-guarded (list 'not (car rest))
3500 (byte-compile-or-recursion (cdr rest) wintag)))
3501 (byte-compile-form-do-effect (car rest))
3502 (byte-compile-out-tag wintag)))
3504 (defun byte-compile-while (form)
3505 (let ((endtag (byte-compile-make-tag))
3506 (looptag (byte-compile-make-tag)))
3507 (byte-compile-out-tag looptag)
3508 (byte-compile-form (car (cdr form)))
3509 (byte-compile-goto-if nil for-effect endtag)
3510 (byte-compile-body (cdr (cdr form)) t)
3511 (byte-compile-goto 'byte-goto looptag)
3512 (byte-compile-out-tag endtag)
3513 (setq for-effect nil)))
3515 (defun byte-compile-funcall (form)
3516 (mapc 'byte-compile-form (cdr form))
3517 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3520 (defun byte-compile-let (form)
3521 ;; First compute the binding values in the old scope.
3522 (let ((varlist (car (cdr form))))
3523 (dolist (var varlist)
3524 (if (consp var)
3525 (byte-compile-form (car (cdr var)))
3526 (byte-compile-push-constant nil))))
3527 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3528 (varlist (reverse (car (cdr form)))))
3529 (dolist (var varlist)
3530 (byte-compile-variable-ref 'byte-varbind (if (consp var) (car var) var)))
3531 (byte-compile-body-do-effect (cdr (cdr form)))
3532 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3534 (defun byte-compile-let* (form)
3535 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3536 (varlist (copy-sequence (car (cdr form)))))
3537 (dolist (var varlist)
3538 (if (atom var)
3539 (byte-compile-push-constant nil)
3540 (byte-compile-form (car (cdr var)))
3541 (setq var (car var)))
3542 (byte-compile-variable-ref 'byte-varbind var))
3543 (byte-compile-body-do-effect (cdr (cdr form)))
3544 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3547 (byte-defop-compiler-1 /= byte-compile-negated)
3548 (byte-defop-compiler-1 atom byte-compile-negated)
3549 (byte-defop-compiler-1 nlistp byte-compile-negated)
3551 (put '/= 'byte-compile-negated-op '=)
3552 (put 'atom 'byte-compile-negated-op 'consp)
3553 (put 'nlistp 'byte-compile-negated-op 'listp)
3555 (defun byte-compile-negated (form)
3556 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3558 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3559 (defun byte-compile-negation-optimizer (form)
3560 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3561 (byte-compile-set-symbol-position (car form))
3562 (list 'not
3563 (cons (or (get (car form) 'byte-compile-negated-op)
3564 (error
3565 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3566 (car form)))
3567 (cdr form))))
3569 ;;; other tricky macro-like special-forms
3571 (byte-defop-compiler-1 catch)
3572 (byte-defop-compiler-1 unwind-protect)
3573 (byte-defop-compiler-1 condition-case)
3574 (byte-defop-compiler-1 save-excursion)
3575 (byte-defop-compiler-1 save-current-buffer)
3576 (byte-defop-compiler-1 save-restriction)
3577 (byte-defop-compiler-1 save-window-excursion)
3578 (byte-defop-compiler-1 with-output-to-temp-buffer)
3579 (byte-defop-compiler-1 track-mouse)
3581 (defun byte-compile-catch (form)
3582 (byte-compile-form (car (cdr form)))
3583 (byte-compile-push-constant
3584 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3585 (byte-compile-out 'byte-catch 0))
3587 (defun byte-compile-unwind-protect (form)
3588 (byte-compile-push-constant
3589 (byte-compile-top-level-body (cdr (cdr form)) t))
3590 (byte-compile-out 'byte-unwind-protect 0)
3591 (byte-compile-form-do-effect (car (cdr form)))
3592 (byte-compile-out 'byte-unbind 1))
3594 (defun byte-compile-track-mouse (form)
3595 (byte-compile-form
3596 `(funcall '(lambda nil
3597 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
3599 (defun byte-compile-condition-case (form)
3600 (let* ((var (nth 1 form))
3601 (byte-compile-bound-variables
3602 (if var (cons var byte-compile-bound-variables)
3603 byte-compile-bound-variables)))
3604 (byte-compile-set-symbol-position 'condition-case)
3605 (unless (symbolp var)
3606 (byte-compile-warn
3607 "`%s' is not a variable-name or nil (in condition-case)" var))
3608 (byte-compile-push-constant var)
3609 (byte-compile-push-constant (byte-compile-top-level
3610 (nth 2 form) for-effect))
3611 (let ((clauses (cdr (cdr (cdr form))))
3612 compiled-clauses)
3613 (while clauses
3614 (let* ((clause (car clauses))
3615 (condition (car clause)))
3616 (cond ((not (or (symbolp condition)
3617 (and (listp condition)
3618 (let ((syms condition) (ok t))
3619 (while syms
3620 (if (not (symbolp (car syms)))
3621 (setq ok nil))
3622 (setq syms (cdr syms)))
3623 ok))))
3624 (byte-compile-warn
3625 "`%s' is not a condition name or list of such (in condition-case)"
3626 (prin1-to-string condition)))
3627 ;; ((not (or (eq condition 't)
3628 ;; (and (stringp (get condition 'error-message))
3629 ;; (consp (get condition 'error-conditions)))))
3630 ;; (byte-compile-warn
3631 ;; "`%s' is not a known condition name (in condition-case)"
3632 ;; condition))
3634 (setq compiled-clauses
3635 (cons (cons condition
3636 (byte-compile-top-level-body
3637 (cdr clause) for-effect))
3638 compiled-clauses)))
3639 (setq clauses (cdr clauses)))
3640 (byte-compile-push-constant (nreverse compiled-clauses)))
3641 (byte-compile-out 'byte-condition-case 0)))
3644 (defun byte-compile-save-excursion (form)
3645 (byte-compile-out 'byte-save-excursion 0)
3646 (byte-compile-body-do-effect (cdr form))
3647 (byte-compile-out 'byte-unbind 1))
3649 (defun byte-compile-save-restriction (form)
3650 (byte-compile-out 'byte-save-restriction 0)
3651 (byte-compile-body-do-effect (cdr form))
3652 (byte-compile-out 'byte-unbind 1))
3654 (defun byte-compile-save-current-buffer (form)
3655 (byte-compile-out 'byte-save-current-buffer 0)
3656 (byte-compile-body-do-effect (cdr form))
3657 (byte-compile-out 'byte-unbind 1))
3659 (defun byte-compile-save-window-excursion (form)
3660 (byte-compile-push-constant
3661 (byte-compile-top-level-body (cdr form) for-effect))
3662 (byte-compile-out 'byte-save-window-excursion 0))
3664 (defun byte-compile-with-output-to-temp-buffer (form)
3665 (byte-compile-form (car (cdr form)))
3666 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3667 (byte-compile-body (cdr (cdr form)))
3668 (byte-compile-out 'byte-temp-output-buffer-show 0))
3670 ;;; top-level forms elsewhere
3672 (byte-defop-compiler-1 defun)
3673 (byte-defop-compiler-1 defmacro)
3674 (byte-defop-compiler-1 defvar)
3675 (byte-defop-compiler-1 defconst byte-compile-defvar)
3676 (byte-defop-compiler-1 autoload)
3677 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
3679 (defun byte-compile-defun (form)
3680 ;; This is not used for file-level defuns with doc strings.
3681 (if (symbolp (car form))
3682 (byte-compile-set-symbol-position (car form))
3683 (byte-compile-set-symbol-position 'defun)
3684 (error "defun name must be a symbol, not %s" (car form)))
3685 (if (byte-compile-version-cond byte-compile-compatibility)
3686 (progn
3687 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3688 (list 'fset
3689 (list 'quote (nth 1 form))
3690 (byte-compile-byte-code-maker
3691 (byte-compile-lambda (cdr (cdr form)) t))))
3692 (byte-compile-discard))
3693 ;; We prefer to generate a defalias form so it will record the function
3694 ;; definition just like interpreting a defun.
3695 (byte-compile-form
3696 (list 'defalias
3697 (list 'quote (nth 1 form))
3698 (byte-compile-byte-code-maker
3699 (byte-compile-lambda (cdr (cdr form)) t)))
3701 (byte-compile-constant (nth 1 form)))
3703 (defun byte-compile-defmacro (form)
3704 ;; This is not used for file-level defmacros with doc strings.
3705 (byte-compile-body-do-effect
3706 (list (list 'fset (list 'quote (nth 1 form))
3707 (let ((code (byte-compile-byte-code-maker
3708 (byte-compile-lambda (cdr (cdr form)) t))))
3709 (if (eq (car-safe code) 'make-byte-code)
3710 (list 'cons ''macro code)
3711 (list 'quote (cons 'macro (eval code))))))
3712 (list 'quote (nth 1 form)))))
3714 (defun byte-compile-defvar (form)
3715 ;; This is not used for file-level defvar/consts with doc strings.
3716 (let ((fun (nth 0 form))
3717 (var (nth 1 form))
3718 (value (nth 2 form))
3719 (string (nth 3 form)))
3720 (byte-compile-set-symbol-position fun)
3721 (when (or (> (length form) 4)
3722 (and (eq fun 'defconst) (null (cddr form))))
3723 (let ((ncall (length (cdr form))))
3724 (byte-compile-warn
3725 "`%s' called with %d argument%s, but %s %s"
3726 fun ncall
3727 (if (= 1 ncall) "" "s")
3728 (if (< ncall 2) "requires" "accepts only")
3729 "2-3")))
3730 (when (memq 'free-vars byte-compile-warnings)
3731 (push var byte-compile-bound-variables)
3732 (if (eq fun 'defconst)
3733 (push var byte-compile-const-variables)))
3734 (byte-compile-body-do-effect
3735 (list
3736 ;; Put the defined variable in this library's load-history entry
3737 ;; just as a real defvar would, but only in top-level forms.
3738 (when (and (cddr form) (null byte-compile-current-form))
3739 `(push ',var current-load-list))
3740 (when (> (length form) 3)
3741 (when (and string (not (stringp string)))
3742 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3743 fun var string))
3744 `(put ',var 'variable-documentation ,string))
3745 (if (cddr form) ; `value' provided
3746 (let ((byte-compile-not-obsolete-var var))
3747 (if (eq fun 'defconst)
3748 ;; `defconst' sets `var' unconditionally.
3749 (let ((tmp (make-symbol "defconst-tmp-var")))
3750 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3751 ,value))
3752 ;; `defvar' sets `var' only when unbound.
3753 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
3754 (when (eq fun 'defconst)
3755 ;; This will signal an appropriate error at runtime.
3756 `(eval ',form)))
3757 `',var))))
3759 (defun byte-compile-autoload (form)
3760 (byte-compile-set-symbol-position 'autoload)
3761 (and (byte-compile-constp (nth 1 form))
3762 (byte-compile-constp (nth 5 form))
3763 (eval (nth 5 form)) ; macro-p
3764 (not (fboundp (eval (nth 1 form))))
3765 (byte-compile-warn
3766 "The compiler ignores `autoload' except at top level. You should
3767 probably put the autoload of the macro `%s' at top-level."
3768 (eval (nth 1 form))))
3769 (byte-compile-normal-call form))
3771 ;; Lambdas in valid places are handled as special cases by various code.
3772 ;; The ones that remain are errors.
3773 (defun byte-compile-lambda-form (form)
3774 (byte-compile-set-symbol-position 'lambda)
3775 (error "`lambda' used as function name is invalid"))
3777 ;; Compile normally, but deal with warnings for the function being defined.
3778 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3779 (defun byte-compile-file-form-defalias (form)
3780 (if (and (consp (cdr form)) (consp (nth 1 form))
3781 (eq (car (nth 1 form)) 'quote)
3782 (consp (cdr (nth 1 form)))
3783 (symbolp (nth 1 (nth 1 form))))
3784 (let ((constant
3785 (and (consp (nthcdr 2 form))
3786 (consp (nth 2 form))
3787 (eq (car (nth 2 form)) 'quote)
3788 (consp (cdr (nth 2 form)))
3789 (symbolp (nth 1 (nth 2 form))))))
3790 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
3791 (push (cons (nth 1 (nth 1 form))
3792 (if constant (nth 1 (nth 2 form)) t))
3793 byte-compile-function-environment)))
3794 ;; We used to jus do: (byte-compile-normal-call form)
3795 ;; But it turns out that this fails to optimize the code.
3796 ;; So instead we now do the same as what other byte-hunk-handlers do,
3797 ;; which is to call back byte-compile-file-form and then return nil.
3798 ;; Except that we can't just call byte-compile-file-form since it would
3799 ;; call us right back.
3800 (byte-compile-keep-pending form)
3801 ;; Return nil so the form is not output twice.
3802 nil)
3804 ;; Turn off warnings about prior calls to the function being defalias'd.
3805 ;; This could be smarter and compare those calls with
3806 ;; the function it is being aliased to.
3807 (defun byte-compile-defalias-warn (new)
3808 (let ((calls (assq new byte-compile-unresolved-functions)))
3809 (if calls
3810 (setq byte-compile-unresolved-functions
3811 (delq calls byte-compile-unresolved-functions)))))
3813 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3814 (defun byte-compile-no-warnings (form)
3815 (let (byte-compile-warnings)
3816 (byte-compile-form (cons 'progn (cdr form)))))
3818 ;; Warn about misuses of make-variable-buffer-local.
3819 (byte-defop-compiler-1 make-variable-buffer-local byte-compile-make-variable-buffer-local)
3820 (defun byte-compile-make-variable-buffer-local (form)
3821 (if (eq (car-safe (car-safe (cdr-safe form))) 'quote)
3822 (byte-compile-warn
3823 "`make-variable-buffer-local' should be called at toplevel"))
3824 (byte-compile-normal-call form))
3825 (put 'make-variable-buffer-local
3826 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
3827 (defun byte-compile-form-make-variable-buffer-local (form)
3828 (byte-compile-keep-pending form 'byte-compile-normal-call))
3831 ;;; tags
3833 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3834 ;; optimization to have the 'TAG as a part of the tag.
3835 ;; Tags will be (TAG . (tag-number . stack-depth)).
3836 (defun byte-compile-make-tag ()
3837 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
3840 (defun byte-compile-out-tag (tag)
3841 (setq byte-compile-output (cons tag byte-compile-output))
3842 (if (cdr (cdr tag))
3843 (progn
3844 ;; ## remove this someday
3845 (and byte-compile-depth
3846 (not (= (cdr (cdr tag)) byte-compile-depth))
3847 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
3848 (setq byte-compile-depth (cdr (cdr tag))))
3849 (setcdr (cdr tag) byte-compile-depth)))
3851 (defun byte-compile-goto (opcode tag)
3852 (push (cons opcode tag) byte-compile-output)
3853 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
3854 (1- byte-compile-depth)
3855 byte-compile-depth))
3856 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
3857 (1- byte-compile-depth))))
3859 (defun byte-compile-out (opcode offset)
3860 (push (cons opcode offset) byte-compile-output)
3861 (cond ((eq opcode 'byte-call)
3862 (setq byte-compile-depth (- byte-compile-depth offset)))
3863 ((eq opcode 'byte-return)
3864 ;; This is actually an unnecessary case, because there should be
3865 ;; no more opcodes behind byte-return.
3866 (setq byte-compile-depth nil))
3868 (setq byte-compile-depth (+ byte-compile-depth
3869 (or (aref byte-stack+-info
3870 (symbol-value opcode))
3871 (- (1- offset))))
3872 byte-compile-maxdepth (max byte-compile-depth
3873 byte-compile-maxdepth))))
3874 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3878 ;;; call tree stuff
3880 (defun byte-compile-annotate-call-tree (form)
3881 (let (entry)
3882 ;; annotate the current call
3883 (if (setq entry (assq (car form) byte-compile-call-tree))
3884 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
3885 (setcar (cdr entry)
3886 (cons byte-compile-current-form (nth 1 entry))))
3887 (setq byte-compile-call-tree
3888 (cons (list (car form) (list byte-compile-current-form) nil)
3889 byte-compile-call-tree)))
3890 ;; annotate the current function
3891 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
3892 (or (memq (car form) (nth 2 entry)) ;called
3893 (setcar (cdr (cdr entry))
3894 (cons (car form) (nth 2 entry))))
3895 (setq byte-compile-call-tree
3896 (cons (list byte-compile-current-form nil (list (car form)))
3897 byte-compile-call-tree)))
3900 ;; Renamed from byte-compile-report-call-tree
3901 ;; to avoid interfering with completion of byte-compile-file.
3902 ;;;###autoload
3903 (defun display-call-tree (&optional filename)
3904 "Display a call graph of a specified file.
3905 This lists which functions have been called, what functions called
3906 them, and what functions they call. The list includes all functions
3907 whose definitions have been compiled in this Emacs session, as well as
3908 all functions called by those functions.
3910 The call graph does not include macros, inline functions, or
3911 primitives that the byte-code interpreter knows about directly \(eq,
3912 cons, etc.\).
3914 The call tree also lists those functions which are not known to be called
3915 \(that is, to which no calls have been compiled\), and which cannot be
3916 invoked interactively."
3917 (interactive)
3918 (message "Generating call tree...")
3919 (with-output-to-temp-buffer "*Call-Tree*"
3920 (set-buffer "*Call-Tree*")
3921 (erase-buffer)
3922 (message "Generating call tree... (sorting on %s)"
3923 byte-compile-call-tree-sort)
3924 (insert "Call tree for "
3925 (cond ((null byte-compile-current-file) (or filename "???"))
3926 ((stringp byte-compile-current-file)
3927 byte-compile-current-file)
3928 (t (buffer-name byte-compile-current-file)))
3929 " sorted on "
3930 (prin1-to-string byte-compile-call-tree-sort)
3931 ":\n\n")
3932 (if byte-compile-call-tree-sort
3933 (setq byte-compile-call-tree
3934 (sort byte-compile-call-tree
3935 (cond ((eq byte-compile-call-tree-sort 'callers)
3936 (function (lambda (x y) (< (length (nth 1 x))
3937 (length (nth 1 y))))))
3938 ((eq byte-compile-call-tree-sort 'calls)
3939 (function (lambda (x y) (< (length (nth 2 x))
3940 (length (nth 2 y))))))
3941 ((eq byte-compile-call-tree-sort 'calls+callers)
3942 (function (lambda (x y) (< (+ (length (nth 1 x))
3943 (length (nth 2 x)))
3944 (+ (length (nth 1 y))
3945 (length (nth 2 y)))))))
3946 ((eq byte-compile-call-tree-sort 'name)
3947 (function (lambda (x y) (string< (car x)
3948 (car y)))))
3949 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3950 byte-compile-call-tree-sort))))))
3951 (message "Generating call tree...")
3952 (let ((rest byte-compile-call-tree)
3953 (b (current-buffer))
3955 callers calls)
3956 (while rest
3957 (prin1 (car (car rest)) b)
3958 (setq callers (nth 1 (car rest))
3959 calls (nth 2 (car rest)))
3960 (insert "\t"
3961 (cond ((not (fboundp (setq f (car (car rest)))))
3962 (if (null f)
3963 " <top level>";; shouldn't insert nil then, actually -sk
3964 " <not defined>"))
3965 ((subrp (setq f (symbol-function f)))
3966 " <subr>")
3967 ((symbolp f)
3968 (format " ==> %s" f))
3969 ((byte-code-function-p f)
3970 "<compiled function>")
3971 ((not (consp f))
3972 "<malformed function>")
3973 ((eq 'macro (car f))
3974 (if (or (byte-code-function-p (cdr f))
3975 (assq 'byte-code (cdr (cdr (cdr f)))))
3976 " <compiled macro>"
3977 " <macro>"))
3978 ((assq 'byte-code (cdr (cdr f)))
3979 "<compiled lambda>")
3980 ((eq 'lambda (car f))
3981 "<function>")
3982 (t "???"))
3983 (format " (%d callers + %d calls = %d)"
3984 ;; Does the optimizer eliminate common subexpressions?-sk
3985 (length callers)
3986 (length calls)
3987 (+ (length callers) (length calls)))
3988 "\n")
3989 (if callers
3990 (progn
3991 (insert " called by:\n")
3992 (setq p (point))
3993 (insert " " (if (car callers)
3994 (mapconcat 'symbol-name callers ", ")
3995 "<top level>"))
3996 (let ((fill-prefix " "))
3997 (fill-region-as-paragraph p (point)))
3998 (unless (= 0 (current-column))
3999 (insert "\n"))))
4000 (if calls
4001 (progn
4002 (insert " calls:\n")
4003 (setq p (point))
4004 (insert " " (mapconcat 'symbol-name calls ", "))
4005 (let ((fill-prefix " "))
4006 (fill-region-as-paragraph p (point)))
4007 (unless (= 0 (current-column))
4008 (insert "\n"))))
4009 (setq rest (cdr rest)))
4011 (message "Generating call tree...(finding uncalled functions...)")
4012 (setq rest byte-compile-call-tree)
4013 (let ((uncalled nil))
4014 (while rest
4015 (or (nth 1 (car rest))
4016 (null (setq f (car (car rest))))
4017 (functionp (byte-compile-fdefinition f t))
4018 (commandp (byte-compile-fdefinition f nil))
4019 (setq uncalled (cons f uncalled)))
4020 (setq rest (cdr rest)))
4021 (if uncalled
4022 (let ((fill-prefix " "))
4023 (insert "Noninteractive functions not known to be called:\n ")
4024 (setq p (point))
4025 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4026 (fill-region-as-paragraph p (point)))))
4028 (message "Generating call tree...done.")
4032 ;;;###autoload
4033 (defun batch-byte-compile-if-not-done ()
4034 "Like `byte-compile-file' but doesn't recompile if already up to date.
4035 Use this from the command line, with `-batch';
4036 it won't work in an interactive Emacs."
4037 (batch-byte-compile t))
4039 ;;; by crl@newton.purdue.edu
4040 ;;; Only works noninteractively.
4041 ;;;###autoload
4042 (defun batch-byte-compile (&optional noforce)
4043 "Run `byte-compile-file' on the files remaining on the command line.
4044 Use this from the command line, with `-batch';
4045 it won't work in an interactive Emacs.
4046 Each file is processed even if an error occurred previously.
4047 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4048 If NOFORCE is non-nil, don't recompile a file that seems to be
4049 already up-to-date."
4050 ;; command-line-args-left is what is left of the command line (from startup.el)
4051 (defvar command-line-args-left) ;Avoid 'free variable' warning
4052 (if (not noninteractive)
4053 (error "`batch-byte-compile' is to be used only with -batch"))
4054 (let ((error nil))
4055 (while command-line-args-left
4056 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4057 ;; Directory as argument.
4058 (let ((files (directory-files (car command-line-args-left)))
4059 source dest)
4060 (dolist (file files)
4061 (if (and (string-match emacs-lisp-file-regexp file)
4062 (not (auto-save-file-name-p file))
4063 (setq source (expand-file-name file
4064 (car command-line-args-left)))
4065 (setq dest (byte-compile-dest-file source))
4066 (file-exists-p dest)
4067 (file-newer-than-file-p source dest))
4068 (if (null (batch-byte-compile-file source))
4069 (setq error t)))))
4070 ;; Specific file argument
4071 (if (or (not noforce)
4072 (let* ((source (car command-line-args-left))
4073 (dest (byte-compile-dest-file source)))
4074 (or (not (file-exists-p dest))
4075 (file-newer-than-file-p source dest))))
4076 (if (null (batch-byte-compile-file (car command-line-args-left)))
4077 (setq error t))))
4078 (setq command-line-args-left (cdr command-line-args-left)))
4079 (kill-emacs (if error 1 0))))
4081 (defun batch-byte-compile-file (file)
4082 (if debug-on-error
4083 (byte-compile-file file)
4084 (condition-case err
4085 (byte-compile-file file)
4086 (file-error
4087 (message (if (cdr err)
4088 ">>Error occurred processing %s: %s (%s)"
4089 ">>Error occurred processing %s: %s")
4090 file
4091 (get (car err) 'error-message)
4092 (prin1-to-string (cdr err)))
4093 (let ((destfile (byte-compile-dest-file file)))
4094 (if (file-exists-p destfile)
4095 (delete-file destfile)))
4096 nil)
4097 (error
4098 (message (if (cdr err)
4099 ">>Error occurred processing %s: %s (%s)"
4100 ">>Error occurred processing %s: %s")
4101 file
4102 (get (car err) 'error-message)
4103 (prin1-to-string (cdr err)))
4104 nil))))
4106 ;;;###autoload
4107 (defun batch-byte-recompile-directory (&optional arg)
4108 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4109 Must be used only with `-batch', and kills Emacs on completion.
4110 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4112 Optional argument ARG is passed as second argument ARG to
4113 `batch-recompile-directory'; see there for its possible values
4114 and corresponding effects."
4115 ;; command-line-args-left is what is left of the command line (startup.el)
4116 (defvar command-line-args-left) ;Avoid 'free variable' warning
4117 (if (not noninteractive)
4118 (error "batch-byte-recompile-directory is to be used only with -batch"))
4119 (or command-line-args-left
4120 (setq command-line-args-left '(".")))
4121 (while command-line-args-left
4122 (byte-recompile-directory (car command-line-args-left) arg)
4123 (setq command-line-args-left (cdr command-line-args-left)))
4124 (kill-emacs 0))
4126 (provide 'byte-compile)
4127 (provide 'bytecomp)
4130 ;;; report metering (see the hacks in bytecode.c)
4132 (defvar byte-code-meter)
4133 (defun byte-compile-report-ops ()
4134 (with-output-to-temp-buffer "*Meter*"
4135 (set-buffer "*Meter*")
4136 (let ((i 0) n op off)
4137 (while (< i 256)
4138 (setq n (aref (aref byte-code-meter 0) i)
4139 off nil)
4140 (if t ;(not (zerop n))
4141 (progn
4142 (setq op i)
4143 (setq off nil)
4144 (cond ((< op byte-nth)
4145 (setq off (logand op 7))
4146 (setq op (logand op 248)))
4147 ((>= op byte-constant)
4148 (setq off (- op byte-constant)
4149 op byte-constant)))
4150 (setq op (aref byte-code-vector op))
4151 (insert (format "%-4d" i))
4152 (insert (symbol-name op))
4153 (if off (insert " [" (int-to-string off) "]"))
4154 (indent-to 40)
4155 (insert (int-to-string n) "\n")))
4156 (setq i (1+ i))))))
4158 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4159 ;; itself, compile some of its most used recursive functions (at load time).
4161 (eval-when-compile
4162 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4163 (assq 'byte-code (symbol-function 'byte-compile-form))
4164 (let ((byte-optimize nil) ; do it fast
4165 (byte-compile-warnings nil))
4166 (mapcar (lambda (x)
4167 (or noninteractive (message "compiling %s..." x))
4168 (byte-compile x)
4169 (or noninteractive (message "compiling %s...done" x)))
4170 '(byte-compile-normal-call
4171 byte-compile-form
4172 byte-compile-body
4173 ;; Inserted some more than necessary, to speed it up.
4174 byte-compile-top-level
4175 byte-compile-out-toplevel
4176 byte-compile-constant
4177 byte-compile-variable-ref))))
4178 nil)
4180 (run-hooks 'bytecomp-load-hook)
4182 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4183 ;;; bytecomp.el ends here