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