Make sure x_default_search_path is always set even
[emacs.git] / lisp / emacs-lisp / bytecomp.el
blob02a88c13973837dd4efe5fa7f855bd3245b76e43
1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
8 ;; Maintainer: FSF
9 ;; Keywords: lisp
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
31 ;; of p-code (`lapcode') which takes up less space and can be interpreted
32 ;; faster. [`LAP' == `Lisp Assembly Program'.]
33 ;; The user entry points are byte-compile-file and byte-recompile-directory.
35 ;;; Code:
37 ;; ========================================================================
38 ;; Entry points:
39 ;; byte-recompile-directory, byte-compile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
42 ;; display-call-tree
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
50 ;; is unused;
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
52 ;; and (ash 1 6);
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables:
73 ;; byte-compile-verbose Whether to report the function currently being
74 ;; compiled in the echo area;
75 ;; byte-optimize Whether to do optimizations; this may be
76 ;; t, nil, 'source, or 'byte;
77 ;; byte-optimize-log Whether to report (in excruciating detail)
78 ;; exactly which optimizations have been made.
79 ;; This may be t, nil, 'source, or 'byte;
80 ;; byte-compile-error-on-warn Whether to stop compilation when a warning is
81 ;; produced;
82 ;; byte-compile-delete-errors Whether the optimizer may delete calls or
83 ;; variable references that are side-effect-free
84 ;; except that they may return an error.
85 ;; byte-compile-generate-call-tree Whether to generate a histogram of
86 ;; function calls. This can be useful for
87 ;; finding unused functions, as well as simple
88 ;; performance metering.
89 ;; byte-compile-warnings List of warnings to issue, or t. May contain
90 ;; `free-vars' (references to variables not in the
91 ;; current lexical scope)
92 ;; `unresolved' (calls to unknown functions)
93 ;; `callargs' (lambda calls with args that don't
94 ;; match the lambda's definition)
95 ;; `redefine' (function cell redefined from
96 ;; a macro to a lambda or vice versa,
97 ;; or redefined to take other args)
98 ;; `obsolete' (obsolete variables and functions)
99 ;; `noruntime' (calls to functions only defined
100 ;; within `eval-when-compile')
101 ;; `cl-warnings' (calls to CL functions)
102 ;; `interactive-only' (calls to commands that are
103 ;; not good to call from Lisp)
104 ;; byte-compile-compatibility Whether the compiler should
105 ;; generate .elc files which can be loaded into
106 ;; generic emacs 18.
107 ;; emacs-lisp-file-regexp Regexp for the extension of source-files;
108 ;; see also the function byte-compile-dest-file.
110 ;; New Features:
112 ;; o The form `defsubst' is just like `defun', except that the function
113 ;; generated will be open-coded in compiled code which uses it. This
114 ;; means that no function call will be generated, it will simply be
115 ;; spliced in. Lisp functions calls are very slow, so this can be a
116 ;; big win.
118 ;; You can generally accomplish the same thing with `defmacro', but in
119 ;; that case, the defined procedure can't be used as an argument to
120 ;; mapcar, etc.
122 ;; o You can also open-code one particular call to a function without
123 ;; open-coding all calls. Use the 'inline' form to do this, like so:
125 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
126 ;; or...
127 ;; (inline ;; `foo' and `baz' will be
128 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
129 ;; (baz 0))
131 ;; o It is possible to open-code a function in the same file it is defined
132 ;; in without having to load that file before compiling it. The
133 ;; byte-compiler has been modified to remember function definitions in
134 ;; the compilation environment in the same way that it remembers macro
135 ;; definitions.
137 ;; o Forms like ((lambda ...) ...) are open-coded.
139 ;; o The form `eval-when-compile' is like progn, except that the body
140 ;; is evaluated at compile-time. When it appears at top-level, this
141 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
142 ;; When it does not appear at top-level, it is similar to the
143 ;; Common Lisp #. reader macro (but not in interpreted code).
145 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
146 ;; the whole form is evalled both at compile-time and at run-time.
148 ;; o The command compile-defun is analogous to eval-defun.
150 ;; o If you run byte-compile-file on a filename which is visited in a
151 ;; buffer, and that buffer is modified, you are asked whether you want
152 ;; to save the buffer before compiling.
154 ;; o byte-compiled files now start with the string `;ELC'.
155 ;; Some versions of `file' can be customized to recognize that.
157 (require 'backquote)
159 (or (fboundp 'defsubst)
160 ;; This really ought to be loaded already!
161 (load "byte-run"))
163 ;; The feature of compiling in a specific target Emacs version
164 ;; has been turned off because compile time options are a bad idea.
165 (defmacro byte-compile-single-version () nil)
166 (defmacro byte-compile-version-cond (cond) cond)
168 ;; The crud you see scattered through this file of the form
169 ;; (or (and (boundp 'epoch::version) epoch::version)
170 ;; (string-lessp emacs-version "19"))
171 ;; is because the Epoch folks couldn't be bothered to follow the
172 ;; normal emacs version numbering convention.
174 ;; (if (byte-compile-version-cond
175 ;; (or (and (boundp 'epoch::version) epoch::version)
176 ;; (string-lessp emacs-version "19")))
177 ;; (progn
178 ;; ;; emacs-18 compatibility.
179 ;; (defvar baud-rate (baud-rate)) ;Define baud-rate if it's undefined
181 ;; (if (byte-compile-single-version)
182 ;; (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil)
183 ;; (defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil))
185 ;; (or (and (fboundp 'member)
186 ;; ;; avoid using someone else's possibly bogus definition of this.
187 ;; (subrp (symbol-function 'member)))
188 ;; (defun member (elt list)
189 ;; "like memq, but uses equal instead of eq. In v19, this is a subr."
190 ;; (while (and list (not (equal elt (car list))))
191 ;; (setq list (cdr list)))
192 ;; list))))
195 (defgroup bytecomp nil
196 "Emacs Lisp byte-compiler."
197 :group 'lisp)
199 (defcustom emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
200 "\\.EL\\(;[0-9]+\\)?$"
201 "\\.el$")
202 "*Regexp which matches Emacs Lisp source files.
203 You may want to redefine the function `byte-compile-dest-file'
204 if you change this variable."
205 :group 'bytecomp
206 :type 'regexp)
208 ;; This enables file name handlers such as jka-compr
209 ;; to remove parts of the file name that should not be copied
210 ;; through to the output file name.
211 (defun byte-compiler-base-file-name (filename)
212 (let ((handler (find-file-name-handler filename
213 'byte-compiler-base-file-name)))
214 (if handler
215 (funcall handler 'byte-compiler-base-file-name filename)
216 filename)))
218 (or (fboundp 'byte-compile-dest-file)
219 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
220 ;; so only define it if it is undefined.
221 (defun byte-compile-dest-file (filename)
222 "Convert an Emacs Lisp source file name to a compiled file name."
223 (setq filename (byte-compiler-base-file-name filename))
224 (setq filename (file-name-sans-versions filename))
225 (cond ((eq system-type 'vax-vms)
226 (concat (substring filename 0 (string-match ";" filename)) "c"))
227 ((string-match emacs-lisp-file-regexp filename)
228 (concat (substring filename 0 (match-beginning 0)) ".elc"))
229 (t (concat filename ".elc")))))
231 ;; This can be the 'byte-compile property of any symbol.
232 (autoload 'byte-compile-inline-expand "byte-opt")
234 ;; This is the entrypoint to the lapcode optimizer pass1.
235 (autoload 'byte-optimize-form "byte-opt")
236 ;; This is the entrypoint to the lapcode optimizer pass2.
237 (autoload 'byte-optimize-lapcode "byte-opt")
238 (autoload 'byte-compile-unfold-lambda "byte-opt")
240 ;; This is the entry point to the decompiler, which is used by the
241 ;; disassembler. The disassembler just requires 'byte-compile, but
242 ;; that doesn't define this function, so this seems to be a reasonable
243 ;; thing to do.
244 (autoload 'byte-decompile-bytecode "byte-opt")
246 (defcustom byte-compile-verbose
247 (and (not noninteractive) (> baud-rate search-slow-speed))
248 "*Non-nil means print messages describing progress of byte-compiler."
249 :group 'bytecomp
250 :type 'boolean)
252 (defcustom byte-compile-compatibility nil
253 "*Non-nil means generate output that can run in Emacs 18.
254 This only means that it can run in principle, if it doesn't require
255 facilities that have been added more recently."
256 :group 'bytecomp
257 :type 'boolean)
259 ;; (defvar byte-compile-generate-emacs19-bytecodes
260 ;; (not (or (and (boundp 'epoch::version) epoch::version)
261 ;; (string-lessp emacs-version "19")))
262 ;; "*If this is true, then the byte-compiler will generate bytecode which
263 ;; makes use of byte-ops which are present only in Emacs 19. Code generated
264 ;; this way can never be run in Emacs 18, and may even cause it to crash.")
266 (defcustom byte-optimize t
267 "*Enables optimization in the byte compiler.
268 nil means don't do any optimization.
269 t means do all optimizations.
270 `source' means do source-level optimizations only.
271 `byte' means do code-level optimizations only."
272 :group 'bytecomp
273 :type '(choice (const :tag "none" nil)
274 (const :tag "all" t)
275 (const :tag "source-level" source)
276 (const :tag "byte-level" byte)))
278 (defcustom byte-compile-delete-errors nil
279 "*If non-nil, the optimizer may delete forms that may signal an error.
280 This includes variable references and calls to functions such as `car'."
281 :group 'bytecomp
282 :type 'boolean)
284 (defvar byte-compile-dynamic nil
285 "If non-nil, compile function bodies so they load lazily.
286 They are hidden in comments in the compiled file,
287 and each one is brought into core when the
288 function is called.
290 To enable this option, make it a file-local variable
291 in the source file you want it to apply to.
292 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
294 When this option is true, if you load the compiled file and then move it,
295 the functions you loaded will not be able to run.")
296 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
298 (defcustom byte-compile-dynamic-docstrings t
299 "*If non-nil, compile doc strings for lazy access.
300 We bury the doc strings of functions and variables
301 inside comments in the file, and bring them into core only when they
302 are actually needed.
304 When this option is true, if you load the compiled file and then move it,
305 you won't be able to find the documentation of anything in that file.
307 To disable this option for a certain file, make it a file-local variable
308 in the source file. For example, add this to the first line:
309 -*-byte-compile-dynamic-docstrings:nil;-*-
310 You can also set the variable globally.
312 This option is enabled by default because it reduces Emacs memory usage."
313 :group 'bytecomp
314 :type 'boolean)
315 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
317 (defcustom byte-optimize-log nil
318 "*If true, the byte-compiler will log its optimizations into *Compile-Log*.
319 If this is 'source, then only source-level optimizations will be logged.
320 If it is 'byte, then only byte-level optimizations will be logged."
321 :group 'bytecomp
322 :type '(choice (const :tag "none" nil)
323 (const :tag "all" t)
324 (const :tag "source-level" source)
325 (const :tag "byte-level" byte)))
327 (defcustom byte-compile-error-on-warn nil
328 "*If true, the byte-compiler reports warnings with `error'."
329 :group 'bytecomp
330 :type 'boolean)
332 (defconst byte-compile-warning-types
333 '(redefine callargs free-vars unresolved
334 obsolete noruntime cl-functions interactive-only)
335 "The list of warning types used when `byte-compile-warnings' is t.")
336 (defcustom byte-compile-warnings t
337 "*List of warnings that the byte-compiler should issue (t for all).
339 Elements of the list may be be:
341 free-vars references to variables not in the current lexical scope.
342 unresolved calls to unknown functions.
343 callargs function calls with args that don't match the definition.
344 redefine function name redefined from a macro to ordinary function or vice
345 versa, or redefined to take a different number of arguments.
346 obsolete obsolete variables and functions.
347 noruntime functions that may not be defined at runtime (typically
348 defined only under `eval-when-compile').
349 cl-functions calls to runtime functions from the CL package (as
350 distinguished from macros and aliases).
351 interactive-only
352 commands that normally shouldn't be called from Lisp code."
353 :group 'bytecomp
354 :type `(choice (const :tag "All" t)
355 (set :menu-tag "Some"
356 (const free-vars) (const unresolved)
357 (const callargs) (const redefine)
358 (const obsolete) (const noruntime)
359 (const cl-functions) (const interactive-only))))
360 (put 'byte-compile-warnings 'safe-local-variable 'byte-compile-warnings-safe-p)
361 ;;;###autoload
362 (defun byte-compile-warnings-safe-p (x)
363 (or (booleanp x)
364 (and (listp x)
365 (equal (mapcar
366 (lambda (e)
367 (when (memq e '(free-vars unresolved
368 callargs redefine
369 obsolete noruntime
370 cl-functions interactive-only))
373 x))))
375 (defvar byte-compile-interactive-only-functions
376 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
377 insert-file insert-buffer insert-file-literally)
378 "List of commands that are not meant to be called from Lisp.")
380 (defvar byte-compile-not-obsolete-var nil
381 "If non-nil, this is a variable that shouldn't be reported as obsolete.")
383 (defcustom byte-compile-generate-call-tree nil
384 "*Non-nil means collect call-graph information when compiling.
385 This records which functions were called and from where.
386 If the value is t, compilation displays the call graph when it finishes.
387 If the value is neither t nor nil, compilation asks you whether to display
388 the graph.
390 The call tree only lists functions called, not macros used. Those functions
391 which the byte-code interpreter knows about directly (eq, cons, etc.) are
392 not reported.
394 The call tree also lists those functions which are not known to be called
395 \(that is, to which no calls have been compiled). Functions which can be
396 invoked interactively are excluded from this list."
397 :group 'bytecomp
398 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
399 (other :tag "Ask" lambda)))
401 (defvar byte-compile-call-tree nil "Alist of functions and their call tree.
402 Each element looks like
404 \(FUNCTION CALLERS CALLS\)
406 where CALLERS is a list of functions that call FUNCTION, and CALLS
407 is a list of functions for which calls were generated while compiling
408 FUNCTION.")
410 (defcustom byte-compile-call-tree-sort 'name
411 "*If non-nil, sort the call tree.
412 The values `name', `callers', `calls', `calls+callers'
413 specify different fields to sort on."
414 :group 'bytecomp
415 :type '(choice (const name) (const callers) (const calls)
416 (const calls+callers) (const nil)))
418 (defvar byte-compile-debug nil)
420 ;; (defvar byte-compile-overwrite-file t
421 ;; "If nil, old .elc files are deleted before the new is saved, and .elc
422 ;; files will have the same modes as the corresponding .el file. Otherwise,
423 ;; existing .elc files will simply be overwritten, and the existing modes
424 ;; will not be changed. If this variable is nil, then an .elc file which
425 ;; is a symbolic link will be turned into a normal file, instead of the file
426 ;; which the link points to being overwritten.")
428 (defvar byte-compile-constants nil
429 "List of all constants encountered during compilation of this form.")
430 (defvar byte-compile-variables nil
431 "List of all variables encountered during compilation of this form.")
432 (defvar byte-compile-bound-variables nil
433 "List of variables bound in the context of the current form.
434 This list lives partly on the stack.")
435 (defvar byte-compile-const-variables nil
436 "List of variables declared as constants during compilation of this file.")
437 (defvar byte-compile-free-references)
438 (defvar byte-compile-free-assignments)
440 (defvar byte-compiler-error-flag)
442 (defconst byte-compile-initial-macro-environment
444 ;; (byte-compiler-options . (lambda (&rest forms)
445 ;; (apply 'byte-compiler-options-handler forms)))
446 (eval-when-compile . (lambda (&rest body)
447 (list 'quote
448 (byte-compile-eval (byte-compile-top-level
449 (cons 'progn body))))))
450 (eval-and-compile . (lambda (&rest body)
451 (byte-compile-eval-before-compile (cons 'progn body))
452 (cons 'progn body))))
453 "The default macro-environment passed to macroexpand by the compiler.
454 Placing a macro here will cause a macro to have different semantics when
455 expanded by the compiler as when expanded by the interpreter.")
457 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
458 "Alist of macros defined in the file being compiled.
459 Each element looks like (MACRONAME . DEFINITION). It is
460 \(MACRONAME . nil) when a macro is redefined as a function.")
462 (defvar byte-compile-function-environment nil
463 "Alist of functions defined in the file being compiled.
464 This is so we can inline them when necessary.
465 Each element looks like (FUNCTIONNAME . DEFINITION). It is
466 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
467 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
468 and we don't know the definition.")
470 (defvar byte-compile-unresolved-functions nil
471 "Alist of undefined functions to which calls have been compiled.
472 Used for warnings when the function is not known to be defined or is later
473 defined with incorrect args.")
475 (defvar byte-compile-noruntime-functions nil
476 "Alist of functions called that may not be defined when the compiled code is run.
477 Used for warnings about calling a function that is defined during compilation
478 but won't necessarily be defined when the compiled file is loaded.")
480 (defvar byte-compile-tag-number 0)
481 (defvar byte-compile-output nil
482 "Alist describing contents to put in byte code string.
483 Each element is (INDEX . VALUE)")
484 (defvar byte-compile-depth 0 "Current depth of execution stack.")
485 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
488 ;;; The byte codes; this information is duplicated in bytecomp.c
490 (defvar byte-code-vector nil
491 "An array containing byte-code names indexed by byte-code values.")
493 (defvar byte-stack+-info nil
494 "An array with the stack adjustment for each byte-code.")
496 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
497 ;; This is a speed-hack for building the byte-code-vector at compile-time.
498 ;; We fill in the vector at macroexpand-time, and then after the last call
499 ;; to byte-defop, we write the vector out as a constant instead of writing
500 ;; out a bunch of calls to aset.
501 ;; Actually, we don't fill in the vector itself, because that could make
502 ;; it problematic to compile big changes to this compiler; we store the
503 ;; values on its plist, and remove them later in -extrude.
504 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
505 (put 'byte-code-vector 'tmp-compile-time-value
506 (make-vector 256 nil))))
507 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
508 (put 'byte-stack+-info 'tmp-compile-time-value
509 (make-vector 256 nil)))))
510 (aset v1 opcode opname)
511 (aset v2 opcode stack-adjust))
512 (if docstring
513 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
514 (list 'defconst opname opcode)))
516 (defmacro byte-extrude-byte-code-vectors ()
517 (prog1 (list 'setq 'byte-code-vector
518 (get 'byte-code-vector 'tmp-compile-time-value)
519 'byte-stack+-info
520 (get 'byte-stack+-info 'tmp-compile-time-value))
521 (put 'byte-code-vector 'tmp-compile-time-value nil)
522 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
525 ;; unused: 0-7
527 ;; These opcodes are special in that they pack their argument into the
528 ;; opcode word.
530 (byte-defop 8 1 byte-varref "for variable reference")
531 (byte-defop 16 -1 byte-varset "for setting a variable")
532 (byte-defop 24 -1 byte-varbind "for binding a variable")
533 (byte-defop 32 0 byte-call "for calling a function")
534 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
535 ;; codes 8-47 are consumed by the preceding opcodes
537 ;; unused: 48-55
539 (byte-defop 56 -1 byte-nth)
540 (byte-defop 57 0 byte-symbolp)
541 (byte-defop 58 0 byte-consp)
542 (byte-defop 59 0 byte-stringp)
543 (byte-defop 60 0 byte-listp)
544 (byte-defop 61 -1 byte-eq)
545 (byte-defop 62 -1 byte-memq)
546 (byte-defop 63 0 byte-not)
547 (byte-defop 64 0 byte-car)
548 (byte-defop 65 0 byte-cdr)
549 (byte-defop 66 -1 byte-cons)
550 (byte-defop 67 0 byte-list1)
551 (byte-defop 68 -1 byte-list2)
552 (byte-defop 69 -2 byte-list3)
553 (byte-defop 70 -3 byte-list4)
554 (byte-defop 71 0 byte-length)
555 (byte-defop 72 -1 byte-aref)
556 (byte-defop 73 -2 byte-aset)
557 (byte-defop 74 0 byte-symbol-value)
558 (byte-defop 75 0 byte-symbol-function) ; this was commented out
559 (byte-defop 76 -1 byte-set)
560 (byte-defop 77 -1 byte-fset) ; this was commented out
561 (byte-defop 78 -1 byte-get)
562 (byte-defop 79 -2 byte-substring)
563 (byte-defop 80 -1 byte-concat2)
564 (byte-defop 81 -2 byte-concat3)
565 (byte-defop 82 -3 byte-concat4)
566 (byte-defop 83 0 byte-sub1)
567 (byte-defop 84 0 byte-add1)
568 (byte-defop 85 -1 byte-eqlsign)
569 (byte-defop 86 -1 byte-gtr)
570 (byte-defop 87 -1 byte-lss)
571 (byte-defop 88 -1 byte-leq)
572 (byte-defop 89 -1 byte-geq)
573 (byte-defop 90 -1 byte-diff)
574 (byte-defop 91 0 byte-negate)
575 (byte-defop 92 -1 byte-plus)
576 (byte-defop 93 -1 byte-max)
577 (byte-defop 94 -1 byte-min)
578 (byte-defop 95 -1 byte-mult) ; v19 only
579 (byte-defop 96 1 byte-point)
580 (byte-defop 98 0 byte-goto-char)
581 (byte-defop 99 0 byte-insert)
582 (byte-defop 100 1 byte-point-max)
583 (byte-defop 101 1 byte-point-min)
584 (byte-defop 102 0 byte-char-after)
585 (byte-defop 103 1 byte-following-char)
586 (byte-defop 104 1 byte-preceding-char)
587 (byte-defop 105 1 byte-current-column)
588 (byte-defop 106 0 byte-indent-to)
589 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
590 (byte-defop 108 1 byte-eolp)
591 (byte-defop 109 1 byte-eobp)
592 (byte-defop 110 1 byte-bolp)
593 (byte-defop 111 1 byte-bobp)
594 (byte-defop 112 1 byte-current-buffer)
595 (byte-defop 113 0 byte-set-buffer)
596 (byte-defop 114 0 byte-save-current-buffer
597 "To make a binding to record the current buffer")
598 (byte-defop 115 0 byte-set-mark-OBSOLETE)
599 (byte-defop 116 1 byte-interactive-p)
601 ;; These ops are new to v19
602 (byte-defop 117 0 byte-forward-char)
603 (byte-defop 118 0 byte-forward-word)
604 (byte-defop 119 -1 byte-skip-chars-forward)
605 (byte-defop 120 -1 byte-skip-chars-backward)
606 (byte-defop 121 0 byte-forward-line)
607 (byte-defop 122 0 byte-char-syntax)
608 (byte-defop 123 -1 byte-buffer-substring)
609 (byte-defop 124 -1 byte-delete-region)
610 (byte-defop 125 -1 byte-narrow-to-region)
611 (byte-defop 126 1 byte-widen)
612 (byte-defop 127 0 byte-end-of-line)
614 ;; unused: 128
616 ;; These store their argument in the next two bytes
617 (byte-defop 129 1 byte-constant2
618 "for reference to a constant with vector index >= byte-constant-limit")
619 (byte-defop 130 0 byte-goto "for unconditional jump")
620 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
621 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
622 (byte-defop 133 -1 byte-goto-if-nil-else-pop
623 "to examine top-of-stack, jump and don't pop it if it's nil,
624 otherwise pop it")
625 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
626 "to examine top-of-stack, jump and don't pop it if it's non nil,
627 otherwise pop it")
629 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
630 (byte-defop 136 -1 byte-discard "to discard one value from stack")
631 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
633 (byte-defop 138 0 byte-save-excursion
634 "to make a binding to record the buffer, point and mark")
635 (byte-defop 139 0 byte-save-window-excursion
636 "to make a binding to record entire window configuration")
637 (byte-defop 140 0 byte-save-restriction
638 "to make a binding to record the current buffer clipping restrictions")
639 (byte-defop 141 -1 byte-catch
640 "for catch. Takes, on stack, the tag and an expression for the body")
641 (byte-defop 142 -1 byte-unwind-protect
642 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
644 ;; For condition-case. Takes, on stack, the variable to bind,
645 ;; an expression for the body, and a list of clauses.
646 (byte-defop 143 -2 byte-condition-case)
648 ;; For entry to with-output-to-temp-buffer.
649 ;; Takes, on stack, the buffer name.
650 ;; Binds standard-output and does some other things.
651 ;; Returns with temp buffer on the stack in place of buffer name.
652 (byte-defop 144 0 byte-temp-output-buffer-setup)
654 ;; For exit from with-output-to-temp-buffer.
655 ;; Expects the temp buffer on the stack underneath value to return.
656 ;; Pops them both, then pushes the value back on.
657 ;; Unbinds standard-output and makes the temp buffer visible.
658 (byte-defop 145 -1 byte-temp-output-buffer-show)
660 ;; these ops are new to v19
662 ;; To unbind back to the beginning of this frame.
663 ;; Not used yet, but will be needed for tail-recursion elimination.
664 (byte-defop 146 0 byte-unbind-all)
666 ;; these ops are new to v19
667 (byte-defop 147 -2 byte-set-marker)
668 (byte-defop 148 0 byte-match-beginning)
669 (byte-defop 149 0 byte-match-end)
670 (byte-defop 150 0 byte-upcase)
671 (byte-defop 151 0 byte-downcase)
672 (byte-defop 152 -1 byte-string=)
673 (byte-defop 153 -1 byte-string<)
674 (byte-defop 154 -1 byte-equal)
675 (byte-defop 155 -1 byte-nthcdr)
676 (byte-defop 156 -1 byte-elt)
677 (byte-defop 157 -1 byte-member)
678 (byte-defop 158 -1 byte-assq)
679 (byte-defop 159 0 byte-nreverse)
680 (byte-defop 160 -1 byte-setcar)
681 (byte-defop 161 -1 byte-setcdr)
682 (byte-defop 162 0 byte-car-safe)
683 (byte-defop 163 0 byte-cdr-safe)
684 (byte-defop 164 -1 byte-nconc)
685 (byte-defop 165 -1 byte-quo)
686 (byte-defop 166 -1 byte-rem)
687 (byte-defop 167 0 byte-numberp)
688 (byte-defop 168 0 byte-integerp)
690 ;; unused: 169-174
691 (byte-defop 175 nil byte-listN)
692 (byte-defop 176 nil byte-concatN)
693 (byte-defop 177 nil byte-insertN)
695 ;; unused: 178-191
697 (byte-defop 192 1 byte-constant "for reference to a constant")
698 ;; codes 193-255 are consumed by byte-constant.
699 (defconst byte-constant-limit 64
700 "Exclusive maximum index usable in the `byte-constant' opcode.")
702 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
703 byte-goto-if-nil-else-pop
704 byte-goto-if-not-nil-else-pop)
705 "List of byte-codes whose offset is a pc.")
707 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
709 (byte-extrude-byte-code-vectors)
711 ;;; lapcode generator
713 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
714 ;; source -> bytecode, because it's a lot easier to make optimizations
715 ;; on lapcode than on bytecode.
717 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
718 ;; where instruction is a symbol naming a byte-code instruction,
719 ;; and parameter is an argument to that instruction, if any.
721 ;; The instruction can be the pseudo-op TAG, which means that this position
722 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
723 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
724 ;; parameter for some goto op.
726 ;; If the operation is varbind, varref, varset or push-constant, then the
727 ;; parameter is (variable/constant . index_in_constant_vector).
729 ;; First, the source code is macroexpanded and optimized in various ways.
730 ;; Then the resultant code is compiled into lapcode. Another set of
731 ;; optimizations are then run over the lapcode. Then the variables and
732 ;; constants referenced by the lapcode are collected and placed in the
733 ;; constants-vector. (This happens now so that variables referenced by dead
734 ;; code don't consume space.) And finally, the lapcode is transformed into
735 ;; compacted byte-code.
737 ;; A distinction is made between variables and constants because the variable-
738 ;; referencing instructions are more sensitive to the variables being near the
739 ;; front of the constants-vector than the constant-referencing instructions.
740 ;; Also, this lets us notice references to free variables.
742 (defun byte-compile-lapcode (lap)
743 "Turns lapcode into bytecode. The lapcode is destroyed."
744 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
745 (let ((pc 0) ; Program counter
746 op off ; Operation & offset
747 (bytes '()) ; Put the output bytes here
748 (patchlist nil)) ; List of tags and goto's to patch
749 (while lap
750 (setq op (car (car lap))
751 off (cdr (car lap)))
752 (cond ((not (symbolp op))
753 (error "Non-symbolic opcode `%s'" op))
754 ((eq op 'TAG)
755 (setcar off pc)
756 (setq patchlist (cons off patchlist)))
757 ((memq op byte-goto-ops)
758 (setq pc (+ pc 3))
759 (setq bytes (cons (cons pc (cdr off))
760 (cons nil
761 (cons (symbol-value op) bytes))))
762 (setq patchlist (cons bytes patchlist)))
764 (setq bytes
765 (cond ((cond ((consp off)
766 ;; Variable or constant reference
767 (setq off (cdr off))
768 (eq op 'byte-constant)))
769 (cond ((< off byte-constant-limit)
770 (setq pc (1+ pc))
771 (cons (+ byte-constant off) bytes))
773 (setq pc (+ 3 pc))
774 (cons (lsh off -8)
775 (cons (logand off 255)
776 (cons byte-constant2 bytes))))))
777 ((<= byte-listN (symbol-value op))
778 (setq pc (+ 2 pc))
779 (cons off (cons (symbol-value op) bytes)))
780 ((< off 6)
781 (setq pc (1+ pc))
782 (cons (+ (symbol-value op) off) bytes))
783 ((< off 256)
784 (setq pc (+ 2 pc))
785 (cons off (cons (+ (symbol-value op) 6) bytes)))
787 (setq pc (+ 3 pc))
788 (cons (lsh off -8)
789 (cons (logand off 255)
790 (cons (+ (symbol-value op) 7)
791 bytes))))))))
792 (setq lap (cdr lap)))
793 ;;(if (not (= pc (length bytes)))
794 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
795 ;; Patch PC into jumps
796 (let (bytes)
797 (while patchlist
798 (setq bytes (car patchlist))
799 (cond ((atom (car bytes))) ; Tag
800 (t ; Absolute jump
801 (setq pc (car (cdr (car bytes)))) ; Pick PC from tag
802 (setcar (cdr bytes) (logand pc 255))
803 (setcar bytes (lsh pc -8))))
804 (setq patchlist (cdr patchlist))))
805 (concat (nreverse bytes))))
808 ;;; compile-time evaluation
810 (defun byte-compile-eval (form)
811 "Eval FORM and mark the functions defined therein.
812 Each function's symbol gets added to `byte-compile-noruntime-functions'."
813 (let ((hist-orig load-history)
814 (hist-nil-orig current-load-list))
815 (prog1 (eval form)
816 (when (memq 'noruntime byte-compile-warnings)
817 (let ((hist-new load-history)
818 (hist-nil-new current-load-list))
819 ;; Go through load-history, look for newly loaded files
820 ;; and mark all the functions defined therein.
821 (while (and hist-new (not (eq hist-new hist-orig)))
822 (let ((xs (pop hist-new))
823 old-autoloads)
824 ;; Make sure the file was not already loaded before.
825 (unless (or (assoc (car xs) hist-orig)
826 (equal (car xs) "cl"))
827 (dolist (s xs)
828 (cond
829 ((symbolp s)
830 (unless (memq s old-autoloads)
831 (push s byte-compile-noruntime-functions)))
832 ((and (consp s) (eq t (car s)))
833 (push (cdr s) old-autoloads))
834 ((and (consp s) (eq 'autoload (car s)))
835 (push (cdr s) byte-compile-noruntime-functions)))))))
836 ;; Go through current-load-list for the locally defined funs.
837 (let (old-autoloads)
838 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
839 (let ((s (pop hist-nil-new)))
840 (when (and (symbolp s) (not (memq s old-autoloads)))
841 (push s byte-compile-noruntime-functions))
842 (when (and (consp s) (eq t (car s)))
843 (push (cdr s) old-autoloads)))))))
844 (when (memq 'cl-functions byte-compile-warnings)
845 (let ((hist-new load-history)
846 (hist-nil-new current-load-list))
847 ;; Go through load-history, look for newly loaded files
848 ;; and mark all the functions defined therein.
849 (while (and hist-new (not (eq hist-new hist-orig)))
850 (let ((xs (pop hist-new))
851 old-autoloads)
852 ;; Make sure the file was not already loaded before.
853 (when (and (equal (car xs) "cl") (not (assoc (car xs) hist-orig)))
854 (byte-compile-find-cl-functions)))))))))
856 (defun byte-compile-eval-before-compile (form)
857 "Evaluate FORM for `eval-and-compile'."
858 (let ((hist-nil-orig current-load-list))
859 (prog1 (eval form)
860 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
861 (let ((tem current-load-list))
862 (while (not (eq tem hist-nil-orig))
863 (when (equal (car tem) '(require . cl))
864 (setq byte-compile-warnings
865 (remq 'cl-functions byte-compile-warnings)))
866 (setq tem (cdr tem)))))))
868 ;;; byte compiler messages
870 (defvar byte-compile-current-form nil)
871 (defvar byte-compile-dest-file nil)
872 (defvar byte-compile-current-file nil)
873 (defvar byte-compile-current-buffer nil)
875 ;; Log something that isn't a warning.
876 (defmacro byte-compile-log (format-string &rest args)
877 `(and
878 byte-optimize
879 (memq byte-optimize-log '(t source))
880 (let ((print-escape-newlines t)
881 (print-level 4)
882 (print-length 4))
883 (byte-compile-log-1
884 (format
885 ,format-string
886 ,@(mapcar
887 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
888 args))))))
890 ;; Log something that isn't a warning.
891 (defun byte-compile-log-1 (string)
892 (with-current-buffer "*Compile-Log*"
893 (let ((inhibit-read-only t))
894 (goto-char (point-max))
895 (byte-compile-warning-prefix nil nil)
896 (cond (noninteractive
897 (message " %s" string))
899 (insert (format "%s\n" string)))))))
901 (defvar byte-compile-read-position nil
902 "Character position we began the last `read' from.")
903 (defvar byte-compile-last-position nil
904 "Last known character position in the input.")
906 ;; copied from gnus-util.el
907 (defsubst byte-compile-delete-first (elt list)
908 (if (eq (car list) elt)
909 (cdr list)
910 (let ((total list))
911 (while (and (cdr list)
912 (not (eq (cadr list) elt)))
913 (setq list (cdr list)))
914 (when (cdr list)
915 (setcdr list (cddr list)))
916 total)))
918 ;; The purpose of this function is to iterate through the
919 ;; `read-symbol-positions-list'. Each time we process, say, a
920 ;; function definition (`defun') we remove `defun' from
921 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
922 ;; to that symbol's character position. Similarly, if we encounter a
923 ;; variable reference, like in (1+ foo), we remove `foo' from the
924 ;; list. If our current position is after the symbol's position, we
925 ;; assume we've already passed that point, and look for the next
926 ;; occurrence of the symbol.
928 ;; This function should not be called twice for the same occurrence of
929 ;; a symbol, and it should not be called for symbols generated by the
930 ;; byte compiler itself; because rather than just fail looking up the
931 ;; symbol, we may find an occurrence of the symbol further ahead, and
932 ;; then `byte-compile-last-position' as advanced too far.
934 ;; So your're probably asking yourself: Isn't this function a
935 ;; gross hack? And the answer, of course, would be yes.
936 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
937 (when byte-compile-read-position
938 (let (last entry)
939 (while (progn
940 (setq last byte-compile-last-position
941 entry (assq sym read-symbol-positions-list))
942 (when entry
943 (setq byte-compile-last-position
944 (+ byte-compile-read-position (cdr entry))
945 read-symbol-positions-list
946 (byte-compile-delete-first
947 entry read-symbol-positions-list)))
948 (or (and allow-previous (not (= last byte-compile-last-position)))
949 (> last byte-compile-last-position)))))))
951 (defvar byte-compile-last-warned-form nil)
952 (defvar byte-compile-last-logged-file nil)
954 ;; This is used as warning-prefix for the compiler.
955 ;; It is always called with the warnings buffer current.
956 (defun byte-compile-warning-prefix (level entry)
957 (let* ((inhibit-read-only t)
958 (dir default-directory)
959 (file (cond ((stringp byte-compile-current-file)
960 (format "%s:" (file-relative-name byte-compile-current-file dir)))
961 ((bufferp byte-compile-current-file)
962 (format "Buffer %s:"
963 (buffer-name byte-compile-current-file)))
964 (t "")))
965 (pos (if (and byte-compile-current-file
966 (integerp byte-compile-read-position))
967 (with-current-buffer byte-compile-current-buffer
968 (format "%d:%d:" (count-lines (point-min)
969 byte-compile-last-position)
970 (save-excursion
971 (goto-char byte-compile-last-position)
972 (1+ (current-column)))))
973 ""))
974 (form (if (eq byte-compile-current-form :end) "end of data"
975 (or byte-compile-current-form "toplevel form"))))
976 (when (or (and byte-compile-current-file
977 (not (equal byte-compile-current-file
978 byte-compile-last-logged-file)))
979 (and byte-compile-current-form
980 (not (eq byte-compile-current-form
981 byte-compile-last-warned-form))))
982 (insert (format "\nIn %s:\n" form)))
983 (when level
984 (insert (format "%s%s" file pos))))
985 (setq byte-compile-last-logged-file byte-compile-current-file
986 byte-compile-last-warned-form byte-compile-current-form)
987 entry)
989 ;; This no-op function is used as the value of warning-series
990 ;; to tell inner calls to displaying-byte-compile-warnings
991 ;; not to bind warning-series.
992 (defun byte-compile-warning-series (&rest ignore)
993 nil)
995 ;; Log the start of a file in *Compile-Log*, and mark it as done.
996 ;; Return the position of the start of the page in the log buffer.
997 ;; But do nothing in batch mode.
998 (defun byte-compile-log-file ()
999 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1000 (not noninteractive)
1001 (save-excursion
1002 (set-buffer (get-buffer-create "*Compile-Log*"))
1003 (goto-char (point-max))
1004 (let* ((inhibit-read-only t)
1005 (dir (and byte-compile-current-file
1006 (file-name-directory byte-compile-current-file)))
1007 (was-same (equal default-directory dir))
1009 (when dir
1010 (unless was-same
1011 (insert (format "Leaving directory `%s'\n" default-directory))))
1012 (unless (bolp)
1013 (insert "\n"))
1014 (setq pt (point-marker))
1015 (if byte-compile-current-file
1016 (insert "\f\nCompiling "
1017 (if (stringp byte-compile-current-file)
1018 (concat "file " byte-compile-current-file)
1019 (concat "buffer " (buffer-name byte-compile-current-file)))
1020 " at " (current-time-string) "\n")
1021 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1022 (when dir
1023 (setq default-directory dir)
1024 (unless was-same
1025 (insert (format "Entering directory `%s'\n" default-directory))))
1026 (setq byte-compile-last-logged-file byte-compile-current-file
1027 byte-compile-last-warned-form nil)
1028 ;; Do this after setting default-directory.
1029 (unless (eq major-mode 'compilation-mode)
1030 (compilation-mode))
1031 (compilation-forget-errors)
1032 pt))))
1034 ;; Log a message STRING in *Compile-Log*.
1035 ;; Also log the current function and file if not already done.
1036 (defun byte-compile-log-warning (string &optional fill level)
1037 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1038 (warning-type-format "")
1039 (warning-fill-prefix (if fill " "))
1040 (inhibit-read-only t))
1041 (display-warning 'bytecomp string level "*Compile-Log*")))
1043 (defun byte-compile-warn (format &rest args)
1044 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1045 (setq format (apply 'format format args))
1046 (if byte-compile-error-on-warn
1047 (error "%s" format) ; byte-compile-file catches and logs it
1048 (byte-compile-log-warning format t :warning)))
1050 (defun byte-compile-report-error (error-info)
1051 "Report Lisp error in compilation. ERROR-INFO is the error data."
1052 (setq byte-compiler-error-flag t)
1053 (byte-compile-log-warning
1054 (error-message-string error-info)
1055 nil :error))
1057 ;;; Used by make-obsolete.
1058 (defun byte-compile-obsolete (form)
1059 (let* ((new (get (car form) 'byte-obsolete-info))
1060 (handler (nth 1 new))
1061 (when (nth 2 new)))
1062 (byte-compile-set-symbol-position (car form))
1063 (if (memq 'obsolete byte-compile-warnings)
1064 (byte-compile-warn "`%s' is an obsolete function%s; %s" (car form)
1065 (if when (concat " (as of Emacs " when ")") "")
1066 (if (stringp (car new))
1067 (car new)
1068 (format "use `%s' instead." (car new)))))
1069 (funcall (or handler 'byte-compile-normal-call) form)))
1071 ;; Compiler options
1073 ;; (defvar byte-compiler-valid-options
1074 ;; '((optimize byte-optimize (t nil source byte) val)
1075 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1076 ;; (eq val 'emacs18))
1077 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1078 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1079 ;; (verbose byte-compile-verbose (t nil) val)
1080 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1081 ;; val)))
1083 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1084 ;; #### This should print a warning if the user tries to change something
1085 ;; than can't be changed because the running compiler doesn't support it.
1086 ;; (cond
1087 ;; ((byte-compile-single-version)
1088 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1089 ;; (list (byte-compile-version-cond
1090 ;; byte-compile-generate-emacs19-bytecodes)))
1091 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1092 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1093 ;; '(emacs18) '(emacs19)))))
1095 ;; (defun byte-compiler-options-handler (&rest args)
1096 ;; (let (key val desc choices)
1097 ;; (while args
1098 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1099 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1100 ;; (setq key (car (car args))
1101 ;; val (car (cdr (car args)))
1102 ;; desc (assq key byte-compiler-valid-options))
1103 ;; (or desc
1104 ;; (error "Unknown byte-compiler option `%s'" key))
1105 ;; (setq choices (nth 2 desc))
1106 ;; (if (consp (car choices))
1107 ;; (let (this
1108 ;; (handler 'cons)
1109 ;; (ret (and (memq (car val) '(+ -))
1110 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1111 ;; choices
1112 ;; (symbol-value (nth 1 desc)))))))
1113 ;; (setq choices (car choices))
1114 ;; (while val
1115 ;; (setq this (car val))
1116 ;; (cond ((memq this choices)
1117 ;; (setq ret (funcall handler this ret)))
1118 ;; ((eq this '+) (setq handler 'cons))
1119 ;; ((eq this '-) (setq handler 'delq))
1120 ;; ((error "`%s' only accepts %s" key choices)))
1121 ;; (setq val (cdr val)))
1122 ;; (set (nth 1 desc) ret))
1123 ;; (or (memq val choices)
1124 ;; (error "`%s' must be one of `%s'" key choices))
1125 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1126 ;; (setq args (cdr args)))
1127 ;; nil))
1129 ;;; sanity-checking arglists
1131 ;; If a function has an entry saying (FUNCTION . t).
1132 ;; that means we know it is defined but we don't know how.
1133 ;; If a function has an entry saying (FUNCTION . nil),
1134 ;; that means treat it as not defined.
1135 (defun byte-compile-fdefinition (name macro-p)
1136 (let* ((list (if macro-p
1137 byte-compile-macro-environment
1138 byte-compile-function-environment))
1139 (env (cdr (assq name list))))
1140 (or env
1141 (let ((fn name))
1142 (while (and (symbolp fn)
1143 (fboundp fn)
1144 (or (symbolp (symbol-function fn))
1145 (consp (symbol-function fn))
1146 (and (not macro-p)
1147 (byte-code-function-p (symbol-function fn)))))
1148 (setq fn (symbol-function fn)))
1149 (if (and (not macro-p) (byte-code-function-p fn))
1151 (and (consp fn)
1152 (if (eq 'macro (car fn))
1153 (cdr fn)
1154 (if macro-p
1156 (if (eq 'autoload (car fn))
1158 fn)))))))))
1160 (defun byte-compile-arglist-signature (arglist)
1161 (let ((args 0)
1162 opts
1163 restp)
1164 (while arglist
1165 (cond ((eq (car arglist) '&optional)
1166 (or opts (setq opts 0)))
1167 ((eq (car arglist) '&rest)
1168 (if (cdr arglist)
1169 (setq restp t
1170 arglist nil)))
1172 (if opts
1173 (setq opts (1+ opts))
1174 (setq args (1+ args)))))
1175 (setq arglist (cdr arglist)))
1176 (cons args (if restp nil (if opts (+ args opts) args)))))
1179 (defun byte-compile-arglist-signatures-congruent-p (old new)
1180 (not (or
1181 (> (car new) (car old)) ; requires more args now
1182 (and (null (cdr old)) ; took rest-args, doesn't any more
1183 (cdr new))
1184 (and (cdr new) (cdr old) ; can't take as many args now
1185 (< (cdr new) (cdr old)))
1188 (defun byte-compile-arglist-signature-string (signature)
1189 (cond ((null (cdr signature))
1190 (format "%d+" (car signature)))
1191 ((= (car signature) (cdr signature))
1192 (format "%d" (car signature)))
1193 (t (format "%d-%d" (car signature) (cdr signature)))))
1196 ;; Warn if the form is calling a function with the wrong number of arguments.
1197 (defun byte-compile-callargs-warn (form)
1198 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1199 (byte-compile-fdefinition (car form) t)))
1200 (sig (if (and def (not (eq def t)))
1201 (byte-compile-arglist-signature
1202 (if (eq 'lambda (car-safe def))
1203 (nth 1 def)
1204 (if (byte-code-function-p def)
1205 (aref def 0)
1206 '(&rest def))))
1207 (if (and (fboundp (car form))
1208 (subrp (symbol-function (car form))))
1209 (subr-arity (symbol-function (car form))))))
1210 (ncall (length (cdr form))))
1211 ;; Check many or unevalled from subr-arity.
1212 (if (and (cdr-safe sig)
1213 (not (numberp (cdr sig))))
1214 (setcdr sig nil))
1215 (if sig
1216 (when (or (< ncall (car sig))
1217 (and (cdr sig) (> ncall (cdr sig))))
1218 (byte-compile-set-symbol-position (car form))
1219 (byte-compile-warn
1220 "%s called with %d argument%s, but %s %s"
1221 (car form) ncall
1222 (if (= 1 ncall) "" "s")
1223 (if (< ncall (car sig))
1224 "requires"
1225 "accepts only")
1226 (byte-compile-arglist-signature-string sig))))
1227 (byte-compile-format-warn form)
1228 ;; Check to see if the function will be available at runtime
1229 ;; and/or remember its arity if it's unknown.
1230 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1231 (not (memq (car form) byte-compile-noruntime-functions)))
1232 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1233 ; with recursion.
1234 ;; It's a currently-undefined function.
1235 ;; Remember number of args in call.
1236 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1237 (n (length (cdr form))))
1238 (if cons
1239 (or (memq n (cdr cons))
1240 (setcdr cons (cons n (cdr cons))))
1241 (push (list (car form) n)
1242 byte-compile-unresolved-functions))))))
1244 (defun byte-compile-format-warn (form)
1245 "Warn if FORM is `format'-like with inconsistent args.
1246 Applies if head of FORM is a symbol with non-nil property
1247 `byte-compile-format-like' and first arg is a constant string.
1248 Then check the number of format fields matches the number of
1249 extra args."
1250 (when (and (symbolp (car form))
1251 (stringp (nth 1 form))
1252 (get (car form) 'byte-compile-format-like))
1253 (let ((nfields (with-temp-buffer
1254 (insert (nth 1 form))
1255 (goto-char 1)
1256 (let ((n 0))
1257 (while (re-search-forward "%." nil t)
1258 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1259 (setq n (1+ n))))
1260 n)))
1261 (nargs (- (length form) 2)))
1262 (unless (= nargs nfields)
1263 (byte-compile-warn
1264 "`%s' called with %d args to fill %d format field(s)" (car form)
1265 nargs nfields)))))
1267 (dolist (elt '(format message error))
1268 (put elt 'byte-compile-format-like t))
1270 ;; Warn if a custom definition fails to specify :group.
1271 (defun byte-compile-nogroup-warn (form)
1272 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1273 (name (cadr form)))
1274 (or (not (eq (car-safe name) 'quote))
1275 (and (eq (car form) 'custom-declare-group)
1276 (equal name ''emacs))
1277 (plist-get keyword-args :group)
1278 (not (and (consp name) (eq (car name) 'quote)))
1279 (byte-compile-warn
1280 "%s for `%s' fails to specify containing group"
1281 (cdr (assq (car form)
1282 '((custom-declare-group . defgroup)
1283 (custom-declare-face . defface)
1284 (custom-declare-variable . defcustom))))
1285 (cadr name)))))
1287 ;; Warn if the function or macro is being redefined with a different
1288 ;; number of arguments.
1289 (defun byte-compile-arglist-warn (form macrop)
1290 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
1291 (if (and old (not (eq old t)))
1292 (let ((sig1 (byte-compile-arglist-signature
1293 (if (eq 'lambda (car-safe old))
1294 (nth 1 old)
1295 (if (byte-code-function-p old)
1296 (aref old 0)
1297 '(&rest def)))))
1298 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1299 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1300 (byte-compile-set-symbol-position (nth 1 form))
1301 (byte-compile-warn
1302 "%s %s used to take %s %s, now takes %s"
1303 (if (eq (car form) 'defun) "function" "macro")
1304 (nth 1 form)
1305 (byte-compile-arglist-signature-string sig1)
1306 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1307 (byte-compile-arglist-signature-string sig2))))
1308 ;; This is the first definition. See if previous calls are compatible.
1309 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1310 nums sig min max)
1311 (if calls
1312 (progn
1313 (setq sig (byte-compile-arglist-signature (nth 2 form))
1314 nums (sort (copy-sequence (cdr calls)) (function <))
1315 min (car nums)
1316 max (car (nreverse nums)))
1317 (when (or (< min (car sig))
1318 (and (cdr sig) (> max (cdr sig))))
1319 (byte-compile-set-symbol-position (nth 1 form))
1320 (byte-compile-warn
1321 "%s being defined to take %s%s, but was previously called with %s"
1322 (nth 1 form)
1323 (byte-compile-arglist-signature-string sig)
1324 (if (equal sig '(1 . 1)) " arg" " args")
1325 (byte-compile-arglist-signature-string (cons min max))))
1327 (setq byte-compile-unresolved-functions
1328 (delq calls byte-compile-unresolved-functions)))))
1331 (defvar byte-compile-cl-functions nil
1332 "List of functions defined in CL.")
1334 (defun byte-compile-find-cl-functions ()
1335 (unless byte-compile-cl-functions
1336 (dolist (elt load-history)
1337 (when (and (stringp (car elt))
1338 (string-match "^cl\\>" (car elt)))
1339 (setq byte-compile-cl-functions
1340 (append byte-compile-cl-functions
1341 (cdr elt)))))
1342 (let ((tail byte-compile-cl-functions))
1343 (while tail
1344 (if (and (consp (car tail))
1345 (eq (car (car tail)) 'autoload))
1346 (setcar tail (cdr (car tail))))
1347 (setq tail (cdr tail))))))
1349 (defun byte-compile-cl-warn (form)
1350 "Warn if FORM is a call of a function from the CL package."
1351 (let ((func (car-safe form)))
1352 (if (and byte-compile-cl-functions
1353 (memq func byte-compile-cl-functions)
1354 ;; Aliases which won't have been expanded at this point.
1355 ;; These aren't all aliases of subrs, so not trivial to
1356 ;; avoid hardwiring the list.
1357 (not (memq func
1358 '(cl-block-wrapper cl-block-throw
1359 multiple-value-call nth-value
1360 copy-seq first second rest endp cl-member
1361 ;; These are included in generated code
1362 ;; that can't be called except at compile time
1363 ;; or unless cl is loaded anyway.
1364 cl-defsubst-expand cl-struct-setf-expander
1365 ;; These would sometimes be warned about
1366 ;; but such warnings are never useful,
1367 ;; so don't warn about them.
1368 macroexpand cl-macroexpand-all
1369 cl-compiling-file)))
1370 ;; Avoid warnings for things which are safe because they
1371 ;; have suitable compiler macros, but those aren't
1372 ;; expanded at this stage. There should probably be more
1373 ;; here than caaar and friends.
1374 (not (and (eq (get func 'byte-compile)
1375 'cl-byte-compile-compiler-macro)
1376 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
1377 (byte-compile-warn "Function `%s' from cl package called at runtime"
1378 func)))
1379 form)
1381 (defun byte-compile-print-syms (str1 strn syms)
1382 (when syms
1383 (byte-compile-set-symbol-position (car syms) t))
1384 (cond ((and (cdr syms) (not noninteractive))
1385 (let* ((str strn)
1386 (L (length str))
1388 (while syms
1389 (setq s (symbol-name (pop syms))
1390 L (+ L (length s) 2))
1391 (if (< L (1- fill-column))
1392 (setq str (concat str " " s (and syms ",")))
1393 (setq str (concat str "\n " s (and syms ","))
1394 L (+ (length s) 4))))
1395 (byte-compile-warn "%s" str)))
1396 ((cdr syms)
1397 (byte-compile-warn "%s %s"
1398 strn
1399 (mapconcat #'symbol-name syms ", ")))
1401 (syms
1402 (byte-compile-warn str1 (car syms)))))
1404 ;; If we have compiled any calls to functions which are not known to be
1405 ;; defined, issue a warning enumerating them.
1406 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1407 (defun byte-compile-warn-about-unresolved-functions ()
1408 (when (memq 'unresolved byte-compile-warnings)
1409 (let ((byte-compile-current-form :end)
1410 (noruntime nil)
1411 (unresolved nil))
1412 ;; Separate the functions that will not be available at runtime
1413 ;; from the truly unresolved ones.
1414 (dolist (f byte-compile-unresolved-functions)
1415 (setq f (car f))
1416 (if (fboundp f) (push f noruntime) (push f unresolved)))
1417 ;; Complain about the no-run-time functions
1418 (byte-compile-print-syms
1419 "the function `%s' might not be defined at runtime."
1420 "the following functions might not be defined at runtime:"
1421 noruntime)
1422 ;; Complain about the unresolved functions
1423 (byte-compile-print-syms
1424 "the function `%s' is not known to be defined."
1425 "the following functions are not known to be defined:"
1426 unresolved)))
1427 nil)
1430 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1431 "Non-nil if SYMBOL is constant.
1432 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1433 symbol itself."
1434 (or (memq symbol '(nil t))
1435 (keywordp symbol)
1436 (if any-value (memq symbol byte-compile-const-variables))))
1438 (defmacro byte-compile-constp (form)
1439 "Return non-nil if FORM is a constant."
1440 `(cond ((consp ,form) (eq (car ,form) 'quote))
1441 ((not (symbolp ,form)))
1442 ((byte-compile-const-symbol-p ,form))))
1444 (defmacro byte-compile-close-variables (&rest body)
1445 (cons 'let
1446 (cons '(;;
1447 ;; Close over these variables to encapsulate the
1448 ;; compilation state
1450 (byte-compile-macro-environment
1451 ;; Copy it because the compiler may patch into the
1452 ;; macroenvironment.
1453 (copy-alist byte-compile-initial-macro-environment))
1454 (byte-compile-function-environment nil)
1455 (byte-compile-bound-variables nil)
1456 (byte-compile-const-variables nil)
1457 (byte-compile-free-references nil)
1458 (byte-compile-free-assignments nil)
1460 ;; Close over these variables so that `byte-compiler-options'
1461 ;; can change them on a per-file basis.
1463 (byte-compile-verbose byte-compile-verbose)
1464 (byte-optimize byte-optimize)
1465 (byte-compile-compatibility byte-compile-compatibility)
1466 (byte-compile-dynamic byte-compile-dynamic)
1467 (byte-compile-dynamic-docstrings
1468 byte-compile-dynamic-docstrings)
1469 ;; (byte-compile-generate-emacs19-bytecodes
1470 ;; byte-compile-generate-emacs19-bytecodes)
1471 (byte-compile-warnings (if (eq byte-compile-warnings t)
1472 byte-compile-warning-types
1473 byte-compile-warnings))
1475 body)))
1477 (defmacro displaying-byte-compile-warnings (&rest body)
1478 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1479 (warning-series-started
1480 (and (markerp warning-series)
1481 (eq (marker-buffer warning-series)
1482 (get-buffer "*Compile-Log*")))))
1483 (byte-compile-find-cl-functions)
1484 (if (or (eq warning-series 'byte-compile-warning-series)
1485 warning-series-started)
1486 ;; warning-series does come from compilation,
1487 ;; so don't bind it, but maybe do set it.
1488 (let (tem)
1489 ;; Log the file name. Record position of that text.
1490 (setq tem (byte-compile-log-file))
1491 (unless warning-series-started
1492 (setq warning-series (or tem 'byte-compile-warning-series)))
1493 (if byte-compile-debug
1494 (funcall --displaying-byte-compile-warnings-fn)
1495 (condition-case error-info
1496 (funcall --displaying-byte-compile-warnings-fn)
1497 (error (byte-compile-report-error error-info)))))
1498 ;; warning-series does not come from compilation, so bind it.
1499 (let ((warning-series
1500 ;; Log the file name. Record position of that text.
1501 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1502 (if byte-compile-debug
1503 (funcall --displaying-byte-compile-warnings-fn)
1504 (condition-case error-info
1505 (funcall --displaying-byte-compile-warnings-fn)
1506 (error (byte-compile-report-error error-info))))))))
1508 ;;;###autoload
1509 (defun byte-force-recompile (directory)
1510 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1511 Files in subdirectories of DIRECTORY are processed also."
1512 (interactive "DByte force recompile (directory): ")
1513 (byte-recompile-directory directory nil t))
1515 ;;;###autoload
1516 (defun byte-recompile-directory (directory &optional arg force)
1517 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1518 This is if a `.elc' file exists but is older than the `.el' file.
1519 Files in subdirectories of DIRECTORY are processed also.
1521 If the `.elc' file does not exist, normally this function *does not*
1522 compile the corresponding `.el' file. However,
1523 if ARG (the prefix argument) is 0, that means do compile all those files.
1524 A nonzero ARG means ask the user, for each such `.el' file,
1525 whether to compile it.
1527 A nonzero ARG also means ask about each subdirectory before scanning it.
1529 If the third argument FORCE is non-nil,
1530 recompile every `.el' file that already has a `.elc' file."
1531 (interactive "DByte recompile directory: \nP")
1532 (if arg
1533 (setq arg (prefix-numeric-value arg)))
1534 (if noninteractive
1536 (save-some-buffers)
1537 (force-mode-line-update))
1538 (save-current-buffer
1539 (set-buffer (get-buffer-create "*Compile-Log*"))
1540 (setq default-directory (expand-file-name directory))
1541 ;; compilation-mode copies value of default-directory.
1542 (unless (eq major-mode 'compilation-mode)
1543 (compilation-mode))
1544 (let ((directories (list (expand-file-name directory)))
1545 (default-directory default-directory)
1546 (skip-count 0)
1547 (fail-count 0)
1548 (file-count 0)
1549 (dir-count 0)
1550 last-dir)
1551 (displaying-byte-compile-warnings
1552 (while directories
1553 (setq directory (car directories))
1554 (message "Checking %s..." directory)
1555 (let ((files (directory-files directory))
1556 source dest)
1557 (dolist (file files)
1558 (setq source (expand-file-name file directory))
1559 (if (and (not (member file '("RCS" "CVS")))
1560 (not (eq ?\. (aref file 0)))
1561 (file-directory-p source)
1562 (not (file-symlink-p source)))
1563 ;; This file is a subdirectory. Handle them differently.
1564 (when (or (null arg)
1565 (eq 0 arg)
1566 (y-or-n-p (concat "Check " source "? ")))
1567 (setq directories
1568 (nconc directories (list source))))
1569 ;; It is an ordinary file. Decide whether to compile it.
1570 (if (and (string-match emacs-lisp-file-regexp source)
1571 (file-readable-p source)
1572 (not (auto-save-file-name-p source))
1573 (setq dest (byte-compile-dest-file source))
1574 (if (file-exists-p dest)
1575 ;; File was already compiled.
1576 (or force (file-newer-than-file-p source dest))
1577 ;; No compiled file exists yet.
1578 (and arg
1579 (or (eq 0 arg)
1580 (y-or-n-p (concat "Compile " source "? "))))))
1581 (progn (if (and noninteractive (not byte-compile-verbose))
1582 (message "Compiling %s..." source))
1583 (let ((res (byte-compile-file source)))
1584 (cond ((eq res 'no-byte-compile)
1585 (setq skip-count (1+ skip-count)))
1586 ((eq res t)
1587 (setq file-count (1+ file-count)))
1588 ((eq res nil)
1589 (setq fail-count (1+ fail-count)))))
1590 (or noninteractive
1591 (message "Checking %s..." directory))
1592 (if (not (eq last-dir directory))
1593 (setq last-dir directory
1594 dir-count (1+ dir-count)))
1595 )))))
1596 (setq directories (cdr directories))))
1597 (message "Done (Total of %d file%s compiled%s%s%s)"
1598 file-count (if (= file-count 1) "" "s")
1599 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1600 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1601 (if (> dir-count 1) (format " in %d directories" dir-count) "")))))
1603 (defvar no-byte-compile nil
1604 "Non-nil to prevent byte-compiling of emacs-lisp code.
1605 This is normally set in local file variables at the end of the elisp file:
1607 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1608 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1610 ;;;###autoload
1611 (defun byte-compile-file (filename &optional load)
1612 "Compile a file of Lisp code named FILENAME into a file of byte code.
1613 The output file's name is made by appending `c' to the end of FILENAME.
1614 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1615 The value is non-nil if there were no errors, nil if errors."
1616 ;; (interactive "fByte compile file: \nP")
1617 (interactive
1618 (let ((file buffer-file-name)
1619 (file-name nil)
1620 (file-dir nil))
1621 (and file
1622 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1623 'emacs-lisp-mode)
1624 (setq file-name (file-name-nondirectory file)
1625 file-dir (file-name-directory file)))
1626 (list (read-file-name (if current-prefix-arg
1627 "Byte compile and load file: "
1628 "Byte compile file: ")
1629 file-dir file-name nil)
1630 current-prefix-arg)))
1631 ;; Expand now so we get the current buffer's defaults
1632 (setq filename (expand-file-name filename))
1634 ;; If we're compiling a file that's in a buffer and is modified, offer
1635 ;; to save it first.
1636 (or noninteractive
1637 (let ((b (get-file-buffer (expand-file-name filename))))
1638 (if (and b (buffer-modified-p b)
1639 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1640 (save-excursion (set-buffer b) (save-buffer)))))
1642 ;; Force logging of the file name for each file compiled.
1643 (setq byte-compile-last-logged-file nil)
1644 (let ((byte-compile-current-file filename)
1645 (set-auto-coding-for-load t)
1646 target-file input-buffer output-buffer
1647 byte-compile-dest-file)
1648 (setq target-file (byte-compile-dest-file filename))
1649 (setq byte-compile-dest-file target-file)
1650 (save-excursion
1651 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1652 (set-buffer input-buffer)
1653 (erase-buffer)
1654 (setq buffer-file-coding-system nil)
1655 ;; Always compile an Emacs Lisp file as multibyte
1656 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1657 (set-buffer-multibyte t)
1658 (insert-file-contents filename)
1659 ;; Mimic the way after-insert-file-set-coding can make the
1660 ;; buffer unibyte when visiting this file.
1661 (when (or (eq last-coding-system-used 'no-conversion)
1662 (eq (coding-system-type last-coding-system-used) 5))
1663 ;; For coding systems no-conversion and raw-text...,
1664 ;; edit the buffer as unibyte.
1665 (set-buffer-multibyte nil))
1666 ;; Run hooks including the uncompression hook.
1667 ;; If they change the file name, then change it for the output also.
1668 (let ((buffer-file-name filename)
1669 (default-major-mode 'emacs-lisp-mode)
1670 ;; Ignore unsafe local variables.
1671 ;; We only care about a few of them for our purposes.
1672 (enable-local-variables :safe)
1673 (enable-local-eval nil))
1674 ;; Arg of t means don't alter enable-local-variables.
1675 (normal-mode t)
1676 (setq filename buffer-file-name))
1677 ;; Set the default directory, in case an eval-when-compile uses it.
1678 (setq default-directory (file-name-directory filename)))
1679 ;; Check if the file's local variables explicitly specify not to
1680 ;; compile this file.
1681 (if (with-current-buffer input-buffer no-byte-compile)
1682 (progn
1683 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1684 ;; (file-relative-name filename)
1685 ;; (with-current-buffer input-buffer no-byte-compile))
1686 (when (file-exists-p target-file)
1687 (message "%s deleted because of `no-byte-compile: %s'"
1688 (file-relative-name target-file)
1689 (buffer-local-value 'no-byte-compile input-buffer))
1690 (condition-case nil (delete-file target-file) (error nil)))
1691 ;; We successfully didn't compile this file.
1692 'no-byte-compile)
1693 (when byte-compile-verbose
1694 (message "Compiling %s..." filename))
1695 (setq byte-compiler-error-flag nil)
1696 ;; It is important that input-buffer not be current at this call,
1697 ;; so that the value of point set in input-buffer
1698 ;; within byte-compile-from-buffer lingers in that buffer.
1699 (setq output-buffer
1700 (save-current-buffer
1701 (byte-compile-from-buffer input-buffer filename)))
1702 (if byte-compiler-error-flag
1704 (when byte-compile-verbose
1705 (message "Compiling %s...done" filename))
1706 (kill-buffer input-buffer)
1707 (with-current-buffer output-buffer
1708 (goto-char (point-max))
1709 (insert "\n") ; aaah, unix.
1710 (let ((vms-stmlf-recfm t))
1711 (if (file-writable-p target-file)
1712 ;; We must disable any code conversion here.
1713 (let ((coding-system-for-write 'no-conversion))
1714 (if (memq system-type '(ms-dos 'windows-nt))
1715 (setq buffer-file-type t))
1716 (when (file-exists-p target-file)
1717 ;; Remove the target before writing it, so that any
1718 ;; hard-links continue to point to the old file (this makes
1719 ;; it possible for installed files to share disk space with
1720 ;; the build tree, without causing problems when emacs-lisp
1721 ;; files in the build tree are recompiled).
1722 (delete-file target-file))
1723 (write-region (point-min) (point-max) target-file))
1724 ;; This is just to give a better error message than write-region
1725 (signal 'file-error
1726 (list "Opening output file"
1727 (if (file-exists-p target-file)
1728 "cannot overwrite file"
1729 "directory not writable or nonexistent")
1730 target-file))))
1731 (kill-buffer (current-buffer)))
1732 (if (and byte-compile-generate-call-tree
1733 (or (eq t byte-compile-generate-call-tree)
1734 (y-or-n-p (format "Report call tree for %s? " filename))))
1735 (save-excursion
1736 (display-call-tree filename)))
1737 (if load
1738 (load target-file))
1739 t))))
1741 ;;(defun byte-compile-and-load-file (&optional filename)
1742 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1743 ;;and then load it. The output file's name is made by appending \"c\" to
1744 ;;the end of FILENAME."
1745 ;; (interactive)
1746 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1747 ;; (byte-compile-file filename t)
1748 ;; (let ((current-prefix-arg '(4)))
1749 ;; (call-interactively 'byte-compile-file))))
1751 ;;(defun byte-compile-buffer (&optional buffer)
1752 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1753 ;; (interactive "bByte compile buffer: ")
1754 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1755 ;; (message "Compiling %s..." (buffer-name buffer))
1756 ;; (let* ((filename (or (buffer-file-name buffer)
1757 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1758 ;; (byte-compile-current-file buffer))
1759 ;; (byte-compile-from-buffer buffer nil))
1760 ;; (message "Compiling %s...done" (buffer-name buffer))
1761 ;; t)
1763 ;;; compiling a single function
1764 ;;;###autoload
1765 (defun compile-defun (&optional arg)
1766 "Compile and evaluate the current top-level form.
1767 Print the result in the echo area.
1768 With argument, insert value in current buffer after the form."
1769 (interactive "P")
1770 (save-excursion
1771 (end-of-defun)
1772 (beginning-of-defun)
1773 (let* ((byte-compile-current-file nil)
1774 (byte-compile-current-buffer (current-buffer))
1775 (byte-compile-read-position (point))
1776 (byte-compile-last-position byte-compile-read-position)
1777 (byte-compile-last-warned-form 'nothing)
1778 (value (eval
1779 (let ((read-with-symbol-positions (current-buffer))
1780 (read-symbol-positions-list nil))
1781 (displaying-byte-compile-warnings
1782 (byte-compile-sexp (read (current-buffer))))))))
1783 (cond (arg
1784 (message "Compiling from buffer... done.")
1785 (prin1 value (current-buffer))
1786 (insert "\n"))
1787 ((message "%s" (prin1-to-string value)))))))
1790 (defun byte-compile-from-buffer (inbuffer &optional filename)
1791 ;; Filename is used for the loading-into-Emacs-18 error message.
1792 (let (outbuffer
1793 (byte-compile-current-buffer inbuffer)
1794 (byte-compile-read-position nil)
1795 (byte-compile-last-position nil)
1796 ;; Prevent truncation of flonums and lists as we read and print them
1797 (float-output-format nil)
1798 (case-fold-search nil)
1799 (print-length nil)
1800 (print-level nil)
1801 ;; Prevent edebug from interfering when we compile
1802 ;; and put the output into a file.
1803 ;; (edebug-all-defs nil)
1804 ;; (edebug-all-forms nil)
1805 ;; Simulate entry to byte-compile-top-level
1806 (byte-compile-constants nil)
1807 (byte-compile-variables nil)
1808 (byte-compile-tag-number 0)
1809 (byte-compile-depth 0)
1810 (byte-compile-maxdepth 0)
1811 (byte-compile-output nil)
1812 ;; This allows us to get the positions of symbols read; it's
1813 ;; new in Emacs 22.1.
1814 (read-with-symbol-positions inbuffer)
1815 (read-symbol-positions-list nil)
1816 ;; #### This is bound in b-c-close-variables.
1817 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1818 ;; byte-compile-warning-types
1819 ;; byte-compile-warnings))
1821 (byte-compile-close-variables
1822 (save-excursion
1823 (setq outbuffer
1824 (set-buffer (get-buffer-create " *Compiler Output*")))
1825 (set-buffer-multibyte t)
1826 (erase-buffer)
1827 ;; (emacs-lisp-mode)
1828 (setq case-fold-search nil)
1829 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1830 ;; write files containing binary information specially.
1831 ;; Under most circumstances, such files will be in binary
1832 ;; overwrite mode, so those OS's use that flag to guess how
1833 ;; they should write their data. Advise them that .elc files
1834 ;; need to be written carefully.
1835 (setq overwrite-mode 'overwrite-mode-binary))
1836 (displaying-byte-compile-warnings
1837 (and filename (byte-compile-insert-header filename inbuffer outbuffer))
1838 (save-excursion
1839 (set-buffer inbuffer)
1840 (goto-char 1)
1842 ;; Compile the forms from the input buffer.
1843 (while (progn
1844 (while (progn (skip-chars-forward " \t\n\^l")
1845 (looking-at ";"))
1846 (forward-line 1))
1847 (not (eobp)))
1848 (setq byte-compile-read-position (point)
1849 byte-compile-last-position byte-compile-read-position)
1850 (let ((form (read inbuffer)))
1851 (byte-compile-file-form form)))
1852 ;; Compile pending forms at end of file.
1853 (byte-compile-flush-pending)
1854 ;; Make warnings about unresolved functions
1855 ;; give the end of the file as their position.
1856 (setq byte-compile-last-position (point-max))
1857 (byte-compile-warn-about-unresolved-functions)
1858 ;; Should we always do this? When calling multiple files, it
1859 ;; would be useful to delay this warning until all have
1860 ;; been compiled.
1861 (setq byte-compile-unresolved-functions nil))
1862 ;; Fix up the header at the front of the output
1863 ;; if the buffer contains multibyte characters.
1864 (and filename (byte-compile-fix-header filename inbuffer outbuffer))))
1865 outbuffer))
1867 (defun byte-compile-fix-header (filename inbuffer outbuffer)
1868 (with-current-buffer outbuffer
1869 ;; See if the buffer has any multibyte characters.
1870 (when (< (point-max) (position-bytes (point-max)))
1871 (when (byte-compile-version-cond byte-compile-compatibility)
1872 (error "Version-18 compatibility not valid with multibyte characters"))
1873 (goto-char (point-min))
1874 ;; Find the comment that describes the version test.
1875 (search-forward "\n;;; This file")
1876 (beginning-of-line)
1877 (narrow-to-region (point) (point-max))
1878 ;; Find the line of ballast semicolons.
1879 (search-forward ";;;;;;;;;;")
1880 (beginning-of-line)
1882 (narrow-to-region (point-min) (point))
1883 (let ((old-header-end (point))
1884 delta)
1885 (goto-char (point-min))
1886 (delete-region (point) (progn (re-search-forward "^(")
1887 (beginning-of-line)
1888 (point)))
1889 (insert ";;; This file contains multibyte non-ASCII characters\n"
1890 ";;; and therefore cannot be loaded into Emacs 19.\n")
1891 ;; Replace "19" or "19.29" with "20", twice.
1892 (re-search-forward "19\\(\\.[0-9]+\\)")
1893 (replace-match "20")
1894 (re-search-forward "19\\(\\.[0-9]+\\)")
1895 (replace-match "20")
1896 ;; Now compensate for the change in size,
1897 ;; to make sure all positions in the file remain valid.
1898 (setq delta (- (point-max) old-header-end))
1899 (goto-char (point-max))
1900 (widen)
1901 (delete-char delta)))))
1903 (defun byte-compile-insert-header (filename inbuffer outbuffer)
1904 (set-buffer inbuffer)
1905 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1906 (dynamic byte-compile-dynamic))
1907 (set-buffer outbuffer)
1908 (goto-char 1)
1909 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1910 ;; that is the file-format version number (18, 19 or 20) as a
1911 ;; byte, followed by some nulls. The primary motivation for doing
1912 ;; this is to get some binary characters up in the first line of
1913 ;; the file so that `diff' will simply say "Binary files differ"
1914 ;; instead of actually doing a diff of two .elc files. An extra
1915 ;; benefit is that you can add this to /etc/magic:
1917 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1918 ;; >4 byte x version %d
1920 (insert
1921 ";ELC"
1922 (if (byte-compile-version-cond byte-compile-compatibility) 18 20)
1923 "\000\000\000\n"
1925 (insert ";;; Compiled by "
1926 (or (and (boundp 'user-mail-address) user-mail-address)
1927 (concat (user-login-name) "@" (system-name)))
1928 " on "
1929 (current-time-string) "\n;;; from file " filename "\n")
1930 (insert ";;; in Emacs version " emacs-version "\n")
1931 (insert ";;; "
1932 (cond
1933 ((eq byte-optimize 'source) "with source-level optimization only")
1934 ((eq byte-optimize 'byte) "with byte-level optimization only")
1935 (byte-optimize "with all optimizations")
1936 (t "without optimization"))
1937 (if (byte-compile-version-cond byte-compile-compatibility)
1938 "; compiled with Emacs 18 compatibility.\n"
1939 ".\n"))
1940 (if dynamic
1941 (insert ";;; Function definitions are lazy-loaded.\n"))
1942 (if (not (byte-compile-version-cond byte-compile-compatibility))
1943 (let (intro-string minimum-version)
1944 ;; Figure out which Emacs version to require,
1945 ;; and what comment to use to explain why.
1946 ;; Note that this fails to take account of whether
1947 ;; the buffer contains multibyte characters. We may have to
1948 ;; compensate at the end in byte-compile-fix-header.
1949 (if dynamic-docstrings
1950 (setq intro-string
1951 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1952 minimum-version "19.29")
1953 (setq intro-string
1954 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1955 minimum-version "19"))
1956 ;; Now insert the comment and the error check.
1957 (insert
1958 "\n"
1959 intro-string
1960 ;; Have to check if emacs-version is bound so that this works
1961 ;; in files loaded early in loadup.el.
1962 "(if (and (boundp 'emacs-version)\n"
1963 ;; If there is a name at the end of emacs-version,
1964 ;; don't try to check the version number.
1965 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1966 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1967 (format "\t (string-lessp emacs-version \"%s\")))\n"
1968 minimum-version)
1969 " (error \"`"
1970 ;; prin1-to-string is used to quote backslashes.
1971 (substring (prin1-to-string (file-name-nondirectory filename))
1972 1 -1)
1973 (format "' was compiled for Emacs %s or later\"))\n\n"
1974 minimum-version)
1975 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1976 ;; can delete them so as to keep the buffer positions
1977 ;; constant for the actual compiled code.
1978 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1979 ;; Here if we want Emacs 18 compatibility.
1980 (when dynamic-docstrings
1981 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1982 (when byte-compile-dynamic
1983 (error "Version-18 compatibility doesn't support dynamic byte code"))
1984 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1985 "\n"))))
1987 (defun byte-compile-output-file-form (form)
1988 ;; writes the given form to the output buffer, being careful of docstrings
1989 ;; in defun, defmacro, defvar, defconst, autoload and
1990 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1991 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1992 ;; it does not pay to first build the defalias in defmumble and then parse
1993 ;; it here.
1994 (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload
1995 custom-declare-variable))
1996 (stringp (nth 3 form)))
1997 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
1998 (memq (car form)
1999 '(autoload custom-declare-variable)))
2000 (let ((print-escape-newlines t)
2001 (print-length nil)
2002 (print-level nil)
2003 (print-quoted t)
2004 (print-gensym t))
2005 (princ "\n" outbuffer)
2006 (prin1 form outbuffer)
2007 nil)))
2009 (defvar print-gensym-alist) ;Used before print-circle existed.
2011 (defun byte-compile-output-docform (preface name info form specindex quoted)
2012 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2013 If PREFACE and NAME are non-nil, print them too,
2014 before INFO and the FORM but after the doc string itself.
2015 If SPECINDEX is non-nil, it is the index in FORM
2016 of the function bytecode string. In that case,
2017 we output that argument and the following argument (the constants vector)
2018 together, for lazy loading.
2019 QUOTED says that we have to put a quote before the
2020 list that represents a doc string reference.
2021 `autoload' and `custom-declare-variable' need that."
2022 ;; We need to examine byte-compile-dynamic-docstrings
2023 ;; in the input buffer (now current), not in the output buffer.
2024 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2025 (set-buffer
2026 (prog1 (current-buffer)
2027 (set-buffer outbuffer)
2028 (let (position)
2030 ;; Insert the doc string, and make it a comment with #@LENGTH.
2031 (and (>= (nth 1 info) 0)
2032 dynamic-docstrings
2033 (not byte-compile-compatibility)
2034 (progn
2035 ;; Make the doc string start at beginning of line
2036 ;; for make-docfile's sake.
2037 (insert "\n")
2038 (setq position
2039 (byte-compile-output-as-comment
2040 (nth (nth 1 info) form) nil))
2041 (setq position (- (position-bytes position) (point-min) -1))
2042 ;; If the doc string starts with * (a user variable),
2043 ;; negate POSITION.
2044 (if (and (stringp (nth (nth 1 info) form))
2045 (> (length (nth (nth 1 info) form)) 0)
2046 (eq (aref (nth (nth 1 info) form) 0) ?*))
2047 (setq position (- position)))))
2049 (if preface
2050 (progn
2051 (insert preface)
2052 (prin1 name outbuffer)))
2053 (insert (car info))
2054 (let ((print-escape-newlines t)
2055 (print-quoted t)
2056 ;; For compatibility with code before print-circle,
2057 ;; use a cons cell to say that we want
2058 ;; print-gensym-alist not to be cleared
2059 ;; between calls to print functions.
2060 (print-gensym '(t))
2061 print-gensym-alist ; was used before print-circle existed.
2062 (print-continuous-numbering t)
2063 print-number-table
2064 (index 0))
2065 (prin1 (car form) outbuffer)
2066 (while (setq form (cdr form))
2067 (setq index (1+ index))
2068 (insert " ")
2069 (cond ((and (numberp specindex) (= index specindex)
2070 ;; Don't handle the definition dynamically
2071 ;; if it refers (or might refer)
2072 ;; to objects already output
2073 ;; (for instance, gensyms in the arg list).
2074 (let (non-nil)
2075 (dotimes (i (length print-number-table))
2076 (if (aref print-number-table i)
2077 (setq non-nil t)))
2078 (not non-nil)))
2079 ;; Output the byte code and constants specially
2080 ;; for lazy dynamic loading.
2081 (let ((position
2082 (byte-compile-output-as-comment
2083 (cons (car form) (nth 1 form))
2084 t)))
2085 (setq position (- (position-bytes position) (point-min) -1))
2086 (princ (format "(#$ . %d) nil" position) outbuffer)
2087 (setq form (cdr form))
2088 (setq index (1+ index))))
2089 ((= index (nth 1 info))
2090 (if position
2091 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2092 position)
2093 outbuffer)
2094 (let ((print-escape-newlines nil))
2095 (goto-char (prog1 (1+ (point))
2096 (prin1 (car form) outbuffer)))
2097 (insert "\\\n")
2098 (goto-char (point-max)))))
2100 (prin1 (car form) outbuffer)))))
2101 (insert (nth 2 info))))))
2102 nil)
2104 (defun byte-compile-keep-pending (form &optional handler)
2105 (if (memq byte-optimize '(t source))
2106 (setq form (byte-optimize-form form t)))
2107 (if handler
2108 (let ((for-effect t))
2109 ;; To avoid consing up monstrously large forms at load time, we split
2110 ;; the output regularly.
2111 (and (memq (car-safe form) '(fset defalias))
2112 (nthcdr 300 byte-compile-output)
2113 (byte-compile-flush-pending))
2114 (funcall handler form)
2115 (if for-effect
2116 (byte-compile-discard)))
2117 (byte-compile-form form t))
2118 nil)
2120 (defun byte-compile-flush-pending ()
2121 (if byte-compile-output
2122 (let ((form (byte-compile-out-toplevel t 'file)))
2123 (cond ((eq (car-safe form) 'progn)
2124 (mapc 'byte-compile-output-file-form (cdr form)))
2125 (form
2126 (byte-compile-output-file-form form)))
2127 (setq byte-compile-constants nil
2128 byte-compile-variables nil
2129 byte-compile-depth 0
2130 byte-compile-maxdepth 0
2131 byte-compile-output nil))))
2133 (defun byte-compile-file-form (form)
2134 (let ((byte-compile-current-form nil) ; close over this for warnings.
2135 handler)
2136 (cond
2137 ((not (consp form))
2138 (byte-compile-keep-pending form))
2139 ((and (symbolp (car form))
2140 (setq handler (get (car form) 'byte-hunk-handler)))
2141 (cond ((setq form (funcall handler form))
2142 (byte-compile-flush-pending)
2143 (byte-compile-output-file-form form))))
2144 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2145 (byte-compile-keep-pending form))
2147 (byte-compile-file-form form)))))
2149 ;; Functions and variables with doc strings must be output separately,
2150 ;; so make-docfile can recognise them. Most other things can be output
2151 ;; as byte-code.
2153 (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2154 (defun byte-compile-file-form-defsubst (form)
2155 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2156 (setq byte-compile-current-form (nth 1 form))
2157 (byte-compile-warn "defsubst `%s' was used before it was defined"
2158 (nth 1 form)))
2159 (byte-compile-file-form
2160 (macroexpand form byte-compile-macro-environment))
2161 ;; Return nil so the form is not output twice.
2162 nil)
2164 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2165 (defun byte-compile-file-form-autoload (form)
2166 (and (let ((form form))
2167 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2168 (null form)) ;Constants only
2169 (eval (nth 5 form)) ;Macro
2170 (eval form)) ;Define the autoload.
2171 ;; Avoid undefined function warnings for the autoload.
2172 (if (and (consp (nth 1 form))
2173 (eq (car (nth 1 form)) 'quote)
2174 (consp (cdr (nth 1 form)))
2175 (symbolp (nth 1 (nth 1 form))))
2176 (push (cons (nth 1 (nth 1 form))
2177 (cons 'autoload (cdr (cdr form))))
2178 byte-compile-function-environment))
2179 (if (stringp (nth 3 form))
2180 form
2181 ;; No doc string, so we can compile this as a normal form.
2182 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2184 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2185 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2186 (defun byte-compile-file-form-defvar (form)
2187 (if (null (nth 3 form))
2188 ;; Since there is no doc string, we can compile this as a normal form,
2189 ;; and not do a file-boundary.
2190 (byte-compile-keep-pending form)
2191 (when (memq 'free-vars byte-compile-warnings)
2192 (push (nth 1 form) byte-compile-bound-variables)
2193 (if (eq (car form) 'defconst)
2194 (push (nth 1 form) byte-compile-const-variables)))
2195 (cond ((consp (nth 2 form))
2196 (setq form (copy-sequence form))
2197 (setcar (cdr (cdr form))
2198 (byte-compile-top-level (nth 2 form) nil 'file))))
2199 form))
2201 (put 'custom-declare-variable 'byte-hunk-handler
2202 'byte-compile-file-form-custom-declare-variable)
2203 (defun byte-compile-file-form-custom-declare-variable (form)
2204 (when (memq 'callargs byte-compile-warnings)
2205 (byte-compile-nogroup-warn form))
2206 (when (memq 'free-vars byte-compile-warnings)
2207 (push (nth 1 (nth 1 form)) byte-compile-bound-variables))
2208 (let ((tail (nthcdr 4 form)))
2209 (while tail
2210 ;; If there are any (function (lambda ...)) expressions, compile
2211 ;; those functions.
2212 (if (and (consp (car tail))
2213 (eq (car (car tail)) 'function)
2214 (consp (nth 1 (car tail))))
2215 (setcar tail (byte-compile-lambda (nth 1 (car tail))))
2216 ;; Likewise for a bare lambda.
2217 (if (and (consp (car tail))
2218 (eq (car (car tail)) 'lambda))
2219 (setcar tail (byte-compile-lambda (car tail)))))
2220 (setq tail (cdr tail))))
2221 form)
2223 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2224 (defun byte-compile-file-form-require (form)
2225 (let ((old-load-list current-load-list)
2226 (args (mapcar 'eval (cdr form))))
2227 (apply 'require args)
2228 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2229 (if (member (car args) '("cl" cl))
2230 (setq byte-compile-warnings
2231 (remq 'cl-functions byte-compile-warnings))))
2232 (byte-compile-keep-pending form 'byte-compile-normal-call))
2234 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2235 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2236 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2237 (defun byte-compile-file-form-progn (form)
2238 (mapc 'byte-compile-file-form (cdr form))
2239 ;; Return nil so the forms are not output twice.
2240 nil)
2242 ;; This handler is not necessary, but it makes the output from dont-compile
2243 ;; and similar macros cleaner.
2244 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2245 (defun byte-compile-file-form-eval (form)
2246 (if (eq (car-safe (nth 1 form)) 'quote)
2247 (nth 1 (nth 1 form))
2248 (byte-compile-keep-pending form)))
2250 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2251 (defun byte-compile-file-form-defun (form)
2252 (byte-compile-file-form-defmumble form nil))
2254 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2255 (defun byte-compile-file-form-defmacro (form)
2256 (byte-compile-file-form-defmumble form t))
2258 (defun byte-compile-file-form-defmumble (form macrop)
2259 (let* ((name (car (cdr form)))
2260 (this-kind (if macrop 'byte-compile-macro-environment
2261 'byte-compile-function-environment))
2262 (that-kind (if macrop 'byte-compile-function-environment
2263 'byte-compile-macro-environment))
2264 (this-one (assq name (symbol-value this-kind)))
2265 (that-one (assq name (symbol-value that-kind)))
2266 (byte-compile-free-references nil)
2267 (byte-compile-free-assignments nil))
2268 (byte-compile-set-symbol-position name)
2269 ;; When a function or macro is defined, add it to the call tree so that
2270 ;; we can tell when functions are not used.
2271 (if byte-compile-generate-call-tree
2272 (or (assq name byte-compile-call-tree)
2273 (setq byte-compile-call-tree
2274 (cons (list name nil nil) byte-compile-call-tree))))
2276 (setq byte-compile-current-form name) ; for warnings
2277 (if (memq 'redefine byte-compile-warnings)
2278 (byte-compile-arglist-warn form macrop))
2279 (if byte-compile-verbose
2280 (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
2281 (cond (that-one
2282 (if (and (memq 'redefine byte-compile-warnings)
2283 ;; don't warn when compiling the stubs in byte-run...
2284 (not (assq (nth 1 form)
2285 byte-compile-initial-macro-environment)))
2286 (byte-compile-warn
2287 "`%s' defined multiple times, as both function and macro"
2288 (nth 1 form)))
2289 (setcdr that-one nil))
2290 (this-one
2291 (when (and (memq 'redefine byte-compile-warnings)
2292 ;; hack: don't warn when compiling the magic internal
2293 ;; byte-compiler macros in byte-run.el...
2294 (not (assq (nth 1 form)
2295 byte-compile-initial-macro-environment)))
2296 (byte-compile-warn "%s `%s' defined multiple times in this file"
2297 (if macrop "macro" "function")
2298 (nth 1 form))))
2299 ((and (fboundp name)
2300 (eq (car-safe (symbol-function name))
2301 (if macrop 'lambda 'macro)))
2302 (when (memq 'redefine byte-compile-warnings)
2303 (byte-compile-warn "%s `%s' being redefined as a %s"
2304 (if macrop "function" "macro")
2305 (nth 1 form)
2306 (if macrop "macro" "function")))
2307 ;; shadow existing definition
2308 (set this-kind
2309 (cons (cons name nil) (symbol-value this-kind))))
2311 (let ((body (nthcdr 3 form)))
2312 (when (and (stringp (car body))
2313 (symbolp (car-safe (cdr-safe body)))
2314 (car-safe (cdr-safe body))
2315 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2316 (byte-compile-set-symbol-position (nth 1 form))
2317 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2318 (nth 1 form))))
2320 ;; Generate code for declarations in macro definitions.
2321 ;; Remove declarations from the body of the macro definition.
2322 (when macrop
2323 (let ((tail (nthcdr 2 form)))
2324 (when (stringp (car (cdr tail)))
2325 (setq tail (cdr tail)))
2326 (while (and (consp (car (cdr tail)))
2327 (eq (car (car (cdr tail))) 'declare))
2328 (let ((declaration (car (cdr tail))))
2329 (setcdr tail (cdr (cdr tail)))
2330 (princ `(if macro-declaration-function
2331 (funcall macro-declaration-function
2332 ',name ',declaration))
2333 outbuffer)))))
2335 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
2336 (code (byte-compile-byte-code-maker new-one)))
2337 (if this-one
2338 (setcdr this-one new-one)
2339 (set this-kind
2340 (cons (cons name new-one) (symbol-value this-kind))))
2341 (if (and (stringp (nth 3 form))
2342 (eq 'quote (car-safe code))
2343 (eq 'lambda (car-safe (nth 1 code))))
2344 (cons (car form)
2345 (cons name (cdr (nth 1 code))))
2346 (byte-compile-flush-pending)
2347 (if (not (stringp (nth 3 form)))
2348 ;; No doc string. Provide -1 as the "doc string index"
2349 ;; so that no element will be treated as a doc string.
2350 (byte-compile-output-docform
2351 (if (byte-compile-version-cond byte-compile-compatibility)
2352 "\n(fset '" "\n(defalias '")
2353 name
2354 (cond ((atom code)
2355 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2356 ((eq (car code) 'quote)
2357 (setq code new-one)
2358 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2359 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2360 (append code nil)
2361 (and (atom code) byte-compile-dynamic
2363 nil)
2364 ;; Output the form by hand, that's much simpler than having
2365 ;; b-c-output-file-form analyze the defalias.
2366 (byte-compile-output-docform
2367 (if (byte-compile-version-cond byte-compile-compatibility)
2368 "\n(fset '" "\n(defalias '")
2369 name
2370 (cond ((atom code)
2371 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2372 ((eq (car code) 'quote)
2373 (setq code new-one)
2374 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2375 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2376 (append code nil)
2377 (and (atom code) byte-compile-dynamic
2379 nil))
2380 (princ ")" outbuffer)
2381 nil))))
2383 ;; Print Lisp object EXP in the output file, inside a comment,
2384 ;; and return the file position it will have.
2385 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2386 (defun byte-compile-output-as-comment (exp quoted)
2387 (let ((position (point)))
2388 (set-buffer
2389 (prog1 (current-buffer)
2390 (set-buffer outbuffer)
2392 ;; Insert EXP, and make it a comment with #@LENGTH.
2393 (insert " ")
2394 (if quoted
2395 (prin1 exp outbuffer)
2396 (princ exp outbuffer))
2397 (goto-char position)
2398 ;; Quote certain special characters as needed.
2399 ;; get_doc_string in doc.c does the unquoting.
2400 (while (search-forward "\^A" nil t)
2401 (replace-match "\^A\^A" t t))
2402 (goto-char position)
2403 (while (search-forward "\000" nil t)
2404 (replace-match "\^A0" t t))
2405 (goto-char position)
2406 (while (search-forward "\037" nil t)
2407 (replace-match "\^A_" t t))
2408 (goto-char (point-max))
2409 (insert "\037")
2410 (goto-char position)
2411 (insert "#@" (format "%d" (- (position-bytes (point-max))
2412 (position-bytes position))))
2414 ;; Save the file position of the object.
2415 ;; Note we should add 1 to skip the space
2416 ;; that we inserted before the actual doc string,
2417 ;; and subtract 1 to convert from an 1-origin Emacs position
2418 ;; to a file position; they cancel.
2419 (setq position (point))
2420 (goto-char (point-max))))
2421 position))
2425 ;;;###autoload
2426 (defun byte-compile (form)
2427 "If FORM is a symbol, byte-compile its function definition.
2428 If FORM is a lambda or a macro, byte-compile it as a function."
2429 (displaying-byte-compile-warnings
2430 (byte-compile-close-variables
2431 (let* ((fun (if (symbolp form)
2432 (and (fboundp form) (symbol-function form))
2433 form))
2434 (macro (eq (car-safe fun) 'macro)))
2435 (if macro
2436 (setq fun (cdr fun)))
2437 (cond ((eq (car-safe fun) 'lambda)
2438 (setq fun (if macro
2439 (cons 'macro (byte-compile-lambda fun))
2440 (byte-compile-lambda fun)))
2441 (if (symbolp form)
2442 (defalias form fun)
2443 fun)))))))
2445 (defun byte-compile-sexp (sexp)
2446 "Compile and return SEXP."
2447 (displaying-byte-compile-warnings
2448 (byte-compile-close-variables
2449 (byte-compile-top-level sexp))))
2451 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2452 (defun byte-compile-byte-code-maker (fun)
2453 (cond
2454 ((byte-compile-version-cond byte-compile-compatibility)
2455 ;; Return (quote (lambda ...)).
2456 (list 'quote (byte-compile-byte-code-unmake fun)))
2457 ;; ## atom is faster than compiled-func-p.
2458 ((atom fun) ; compiled function.
2459 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2460 ;; would have produced a lambda.
2461 fun)
2462 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2463 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2464 ((let (tmp)
2465 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2466 (null (cdr (memq tmp fun))))
2467 ;; Generate a make-byte-code call.
2468 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2469 (nconc (list 'make-byte-code
2470 (list 'quote (nth 1 fun)) ;arglist
2471 (nth 1 tmp) ;bytes
2472 (nth 2 tmp) ;consts
2473 (nth 3 tmp)) ;depth
2474 (cond ((stringp (nth 2 fun))
2475 (list (nth 2 fun))) ;doc
2476 (interactive
2477 (list nil)))
2478 (cond (interactive
2479 (list (if (or (null (nth 1 interactive))
2480 (stringp (nth 1 interactive)))
2481 (nth 1 interactive)
2482 ;; Interactive spec is a list or a variable
2483 ;; (if it is correct).
2484 (list 'quote (nth 1 interactive))))))))
2485 ;; a non-compiled function (probably trivial)
2486 (list 'quote fun))))))
2488 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2489 (defun byte-compile-byte-code-unmake (function)
2490 (if (consp function)
2491 function;;It already is a lambda.
2492 (setq function (append function nil)) ; turn it into a list
2493 (nconc (list 'lambda (nth 0 function))
2494 (and (nth 4 function) (list (nth 4 function)))
2495 (if (nthcdr 5 function)
2496 (list (cons 'interactive (if (nth 5 function)
2497 (nthcdr 5 function)))))
2498 (list (list 'byte-code
2499 (nth 1 function) (nth 2 function)
2500 (nth 3 function))))))
2503 (defun byte-compile-check-lambda-list (list)
2504 "Check lambda-list LIST for errors."
2505 (let (vars)
2506 (while list
2507 (let ((arg (car list)))
2508 (when (symbolp arg)
2509 (byte-compile-set-symbol-position arg))
2510 (cond ((or (not (symbolp arg))
2511 (byte-compile-const-symbol-p arg t))
2512 (error "Invalid lambda variable %s" arg))
2513 ((eq arg '&rest)
2514 (unless (cdr list)
2515 (error "&rest without variable name"))
2516 (when (cddr list)
2517 (error "Garbage following &rest VAR in lambda-list")))
2518 ((eq arg '&optional)
2519 (unless (cdr list)
2520 (error "Variable name missing after &optional")))
2521 ((memq arg vars)
2522 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2524 (push arg vars))))
2525 (setq list (cdr list)))))
2528 ;; Byte-compile a lambda-expression and return a valid function.
2529 ;; The value is usually a compiled function but may be the original
2530 ;; lambda-expression.
2531 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2532 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2533 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2534 ;; for symbols generated by the byte compiler itself.
2535 (defun byte-compile-lambda (fun &optional add-lambda)
2536 (if add-lambda
2537 (setq fun (cons 'lambda fun))
2538 (unless (eq 'lambda (car-safe fun))
2539 (error "Not a lambda list: %S" fun))
2540 (byte-compile-set-symbol-position 'lambda))
2541 (byte-compile-check-lambda-list (nth 1 fun))
2542 (let* ((arglist (nth 1 fun))
2543 (byte-compile-bound-variables
2544 (nconc (and (memq 'free-vars byte-compile-warnings)
2545 (delq '&rest (delq '&optional (copy-sequence arglist))))
2546 byte-compile-bound-variables))
2547 (body (cdr (cdr fun)))
2548 (doc (if (stringp (car body))
2549 (prog1 (car body)
2550 ;; Discard the doc string
2551 ;; unless it is the last element of the body.
2552 (if (cdr body)
2553 (setq body (cdr body))))))
2554 (int (assq 'interactive body)))
2555 ;; Process the interactive spec.
2556 (when int
2557 (byte-compile-set-symbol-position 'interactive)
2558 ;; Skip (interactive) if it is in front (the most usual location).
2559 (if (eq int (car body))
2560 (setq body (cdr body)))
2561 (cond ((consp (cdr int))
2562 (if (cdr (cdr int))
2563 (byte-compile-warn "malformed interactive spec: %s"
2564 (prin1-to-string int)))
2565 ;; If the interactive spec is a call to `list', don't
2566 ;; compile it, because `call-interactively' looks at the
2567 ;; args of `list'. Actually, compile it to get warnings,
2568 ;; but don't use the result.
2569 (let ((form (nth 1 int)))
2570 (while (memq (car-safe form) '(let let* progn save-excursion))
2571 (while (consp (cdr form))
2572 (setq form (cdr form)))
2573 (setq form (car form)))
2574 (if (eq (car-safe form) 'list)
2575 (byte-compile-top-level (nth 1 int))
2576 (setq int (list 'interactive
2577 (byte-compile-top-level (nth 1 int)))))))
2578 ((cdr int)
2579 (byte-compile-warn "malformed interactive spec: %s"
2580 (prin1-to-string int)))))
2581 ;; Process the body.
2582 (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
2583 ;; Build the actual byte-coded function.
2584 (if (and (eq 'byte-code (car-safe compiled))
2585 (not (byte-compile-version-cond
2586 byte-compile-compatibility)))
2587 (apply 'make-byte-code
2588 (append (list arglist)
2589 ;; byte-string, constants-vector, stack depth
2590 (cdr compiled)
2591 ;; optionally, the doc string.
2592 (if (or doc int)
2593 (list doc))
2594 ;; optionally, the interactive spec.
2595 (if int
2596 (list (nth 1 int)))))
2597 (setq compiled
2598 (nconc (if int (list int))
2599 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2600 (compiled (list compiled)))))
2601 (nconc (list 'lambda arglist)
2602 (if (or doc (stringp (car compiled)))
2603 (cons doc (cond (compiled)
2604 (body (list nil))))
2605 compiled))))))
2607 (defun byte-compile-constants-vector ()
2608 ;; Builds the constants-vector from the current variables and constants.
2609 ;; This modifies the constants from (const . nil) to (const . offset).
2610 ;; To keep the byte-codes to look up the vector as short as possible:
2611 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2612 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2613 ;; Next variables again, to get 2-byte codes for variable lookup.
2614 ;; The rest of the constants and variables need 3-byte byte-codes.
2615 (let* ((i -1)
2616 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2617 (other (nreverse byte-compile-constants)) ; vars often are used most.
2618 ret tmp
2619 (limits '(5 ; Use the 1-byte varref codes,
2620 63 ; 1-constlim ; 1-byte byte-constant codes,
2621 255 ; 2-byte varref codes,
2622 65535)) ; 3-byte codes for the rest.
2623 limit)
2624 (while (or rest other)
2625 (setq limit (car limits))
2626 (while (and rest (not (eq i limit)))
2627 (if (setq tmp (assq (car (car rest)) ret))
2628 (setcdr (car rest) (cdr tmp))
2629 (setcdr (car rest) (setq i (1+ i)))
2630 (setq ret (cons (car rest) ret)))
2631 (setq rest (cdr rest)))
2632 (setq limits (cdr limits)
2633 rest (prog1 other
2634 (setq other rest))))
2635 (apply 'vector (nreverse (mapcar 'car ret)))))
2637 ;; Given an expression FORM, compile it and return an equivalent byte-code
2638 ;; expression (a call to the function byte-code).
2639 (defun byte-compile-top-level (form &optional for-effect output-type)
2640 ;; OUTPUT-TYPE advises about how form is expected to be used:
2641 ;; 'eval or nil -> a single form,
2642 ;; 'progn or t -> a list of forms,
2643 ;; 'lambda -> body of a lambda,
2644 ;; 'file -> used at file-level.
2645 (let ((byte-compile-constants nil)
2646 (byte-compile-variables nil)
2647 (byte-compile-tag-number 0)
2648 (byte-compile-depth 0)
2649 (byte-compile-maxdepth 0)
2650 (byte-compile-output nil))
2651 (if (memq byte-optimize '(t source))
2652 (setq form (byte-optimize-form form for-effect)))
2653 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2654 (setq form (nth 1 form)))
2655 (if (and (eq 'byte-code (car-safe form))
2656 (not (memq byte-optimize '(t byte)))
2657 (stringp (nth 1 form)) (vectorp (nth 2 form))
2658 (natnump (nth 3 form)))
2659 form
2660 (byte-compile-form form for-effect)
2661 (byte-compile-out-toplevel for-effect output-type))))
2663 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2664 (if for-effect
2665 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2666 (if (eq (car (car byte-compile-output)) 'byte-discard)
2667 (setq byte-compile-output (cdr byte-compile-output))
2668 (byte-compile-push-constant
2669 ;; Push any constant - preferably one which already is used, and
2670 ;; a number or symbol - ie not some big sequence. The return value
2671 ;; isn't returned, but it would be a shame if some textually large
2672 ;; constant was not optimized away because we chose to return it.
2673 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2674 (let ((tmp (reverse byte-compile-constants)))
2675 (while (and tmp (not (or (symbolp (caar tmp))
2676 (numberp (caar tmp)))))
2677 (setq tmp (cdr tmp)))
2678 (caar tmp))))))
2679 (byte-compile-out 'byte-return 0)
2680 (setq byte-compile-output (nreverse byte-compile-output))
2681 (if (memq byte-optimize '(t byte))
2682 (setq byte-compile-output
2683 (byte-optimize-lapcode byte-compile-output for-effect)))
2685 ;; Decompile trivial functions:
2686 ;; only constants and variables, or a single funcall except in lambdas.
2687 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2688 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2689 ;; Note that even (quote foo) must be parsed just as any subr by the
2690 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2691 ;; What to leave uncompiled:
2692 ;; lambda -> never. we used to leave it uncompiled if the body was
2693 ;; a single atom, but that causes confusion if the docstring
2694 ;; uses the (file . pos) syntax. Besides, now that we have
2695 ;; the Lisp_Compiled type, the compiled form is faster.
2696 ;; eval -> atom, quote or (function atom atom atom)
2697 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2698 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2699 (let (rest
2700 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2701 tmp body)
2702 (cond
2703 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2704 ((or (eq output-type 'lambda)
2705 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2706 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2707 (not (setq tmp (assq 'byte-return byte-compile-output)))
2708 (progn
2709 (setq rest (nreverse
2710 (cdr (memq tmp (reverse byte-compile-output)))))
2711 (while (cond
2712 ((memq (car (car rest)) '(byte-varref byte-constant))
2713 (setq tmp (car (cdr (car rest))))
2714 (if (if (eq (car (car rest)) 'byte-constant)
2715 (or (consp tmp)
2716 (and (symbolp tmp)
2717 (not (byte-compile-const-symbol-p tmp)))))
2718 (if maycall
2719 (setq body (cons (list 'quote tmp) body)))
2720 (setq body (cons tmp body))))
2721 ((and maycall
2722 ;; Allow a funcall if at most one atom follows it.
2723 (null (nthcdr 3 rest))
2724 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2725 (or (null (cdr rest))
2726 (and (memq output-type '(file progn t))
2727 (cdr (cdr rest))
2728 (eq (car (nth 1 rest)) 'byte-discard)
2729 (progn (setq rest (cdr rest)) t))))
2730 (setq maycall nil) ; Only allow one real function call.
2731 (setq body (nreverse body))
2732 (setq body (list
2733 (if (and (eq tmp 'funcall)
2734 (eq (car-safe (car body)) 'quote))
2735 (cons (nth 1 (car body)) (cdr body))
2736 (cons tmp body))))
2737 (or (eq output-type 'file)
2738 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2739 (setq rest (cdr rest)))
2740 rest))
2741 (let ((byte-compile-vector (byte-compile-constants-vector)))
2742 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2743 byte-compile-vector byte-compile-maxdepth)))
2744 ;; it's a trivial function
2745 ((cdr body) (cons 'progn (nreverse body)))
2746 ((car body)))))
2748 ;; Given BODY, compile it and return a new body.
2749 (defun byte-compile-top-level-body (body &optional for-effect)
2750 (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
2751 (cond ((eq (car-safe body) 'progn)
2752 (cdr body))
2753 (body
2754 (list body))))
2756 ;; This is the recursive entry point for compiling each subform of an
2757 ;; expression.
2758 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2759 ;; before terminating (ie no value will be left on the stack).
2760 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2761 ;; which does not leave a value on the stack, and then set for-effect to nil
2762 ;; (to prevent byte-compile-form from outputting the byte-discard).
2763 ;; If a handler wants to call another handler, it should do so via
2764 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2765 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2767 (defun byte-compile-form (form &optional for-effect)
2768 (setq form (macroexpand form byte-compile-macro-environment))
2769 (cond ((not (consp form))
2770 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2771 (when (symbolp form)
2772 (byte-compile-set-symbol-position form))
2773 (byte-compile-constant form))
2774 ((and for-effect byte-compile-delete-errors)
2775 (when (symbolp form)
2776 (byte-compile-set-symbol-position form))
2777 (setq for-effect nil))
2778 (t (byte-compile-variable-ref 'byte-varref form))))
2779 ((symbolp (car form))
2780 (let* ((fn (car form))
2781 (handler (get fn 'byte-compile)))
2782 (when (byte-compile-const-symbol-p fn)
2783 (byte-compile-warn "`%s' called as a function" fn))
2784 (and (memq 'interactive-only byte-compile-warnings)
2785 (memq fn byte-compile-interactive-only-functions)
2786 (byte-compile-warn "`%s' used from Lisp code\n\
2787 That command is designed for interactive use only" fn))
2788 (if (and handler
2789 ;; Make sure that function exists. This is important
2790 ;; for CL compiler macros since the symbol may be
2791 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2792 ;; loaded, this function doesn't exist.
2793 (or (not (memq handler '(cl-byte-compile-compiler-macro)))
2794 (functionp handler))
2795 (not (and (byte-compile-version-cond
2796 byte-compile-compatibility)
2797 (get (get fn 'byte-opcode) 'emacs19-opcode))))
2798 (funcall handler form)
2799 (when (memq 'callargs byte-compile-warnings)
2800 (if (memq fn '(custom-declare-group custom-declare-variable custom-declare-face))
2801 (byte-compile-nogroup-warn form))
2802 (byte-compile-callargs-warn form))
2803 (byte-compile-normal-call form))
2804 (if (memq 'cl-functions byte-compile-warnings)
2805 (byte-compile-cl-warn form))))
2806 ((and (or (byte-code-function-p (car form))
2807 (eq (car-safe (car form)) 'lambda))
2808 ;; if the form comes out the same way it went in, that's
2809 ;; because it was malformed, and we couldn't unfold it.
2810 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2811 (byte-compile-form form for-effect)
2812 (setq for-effect nil))
2813 ((byte-compile-normal-call form)))
2814 (if for-effect
2815 (byte-compile-discard)))
2817 (defun byte-compile-normal-call (form)
2818 (if byte-compile-generate-call-tree
2819 (byte-compile-annotate-call-tree form))
2820 (byte-compile-push-constant (car form))
2821 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2822 (byte-compile-out 'byte-call (length (cdr form))))
2824 (defun byte-compile-variable-ref (base-op var)
2825 (when (symbolp var)
2826 (byte-compile-set-symbol-position var))
2827 (if (or (not (symbolp var))
2828 (byte-compile-const-symbol-p var (not (eq base-op 'byte-varref))))
2829 (byte-compile-warn
2830 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2831 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2832 (t "variable reference to %s `%s'"))
2833 (if (symbolp var) "constant" "nonvariable")
2834 (prin1-to-string var))
2835 (if (and (get var 'byte-obsolete-variable)
2836 (memq 'obsolete byte-compile-warnings)
2837 (not (eq var byte-compile-not-obsolete-var)))
2838 (let* ((ob (get var 'byte-obsolete-variable))
2839 (when (cdr ob)))
2840 (byte-compile-warn "`%s' is an obsolete variable%s; %s" var
2841 (if when (concat " (as of Emacs " when ")") "")
2842 (if (stringp (car ob))
2843 (car ob)
2844 (format "use `%s' instead." (car ob))))))
2845 (if (memq 'free-vars byte-compile-warnings)
2846 (if (eq base-op 'byte-varbind)
2847 (push var byte-compile-bound-variables)
2848 (or (boundp var)
2849 (memq var byte-compile-bound-variables)
2850 (if (eq base-op 'byte-varset)
2851 (or (memq var byte-compile-free-assignments)
2852 (progn
2853 (byte-compile-warn "assignment to free variable `%s'" var)
2854 (push var byte-compile-free-assignments)))
2855 (or (memq var byte-compile-free-references)
2856 (progn
2857 (byte-compile-warn "reference to free variable `%s'" var)
2858 (push var byte-compile-free-references))))))))
2859 (let ((tmp (assq var byte-compile-variables)))
2860 (unless tmp
2861 (setq tmp (list var))
2862 (push tmp byte-compile-variables))
2863 (byte-compile-out base-op tmp)))
2865 (defmacro byte-compile-get-constant (const)
2866 `(or (if (stringp ,const)
2867 (assoc-default ,const byte-compile-constants
2868 'equal-including-properties nil)
2869 (assq ,const byte-compile-constants))
2870 (car (setq byte-compile-constants
2871 (cons (list ,const) byte-compile-constants)))))
2873 ;; Use this when the value of a form is a constant. This obeys for-effect.
2874 (defun byte-compile-constant (const)
2875 (if for-effect
2876 (setq for-effect nil)
2877 (when (symbolp const)
2878 (byte-compile-set-symbol-position const))
2879 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2881 ;; Use this for a constant that is not the value of its containing form.
2882 ;; This ignores for-effect.
2883 (defun byte-compile-push-constant (const)
2884 (let ((for-effect nil))
2885 (inline (byte-compile-constant const))))
2888 ;; Compile those primitive ordinary functions
2889 ;; which have special byte codes just for speed.
2891 (defmacro byte-defop-compiler (function &optional compile-handler)
2892 ;; add a compiler-form for FUNCTION.
2893 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2894 ;; the opcode to be used. If function is a list, the first element
2895 ;; is the function and the second element is the bytecode-symbol.
2896 ;; The second element may be nil, meaning there is no opcode.
2897 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2898 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2899 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2900 (let (opcode)
2901 (if (symbolp function)
2902 (setq opcode (intern (concat "byte-" (symbol-name function))))
2903 (setq opcode (car (cdr function))
2904 function (car function)))
2905 (let ((fnform
2906 (list 'put (list 'quote function) ''byte-compile
2907 (list 'quote
2908 (or (cdr (assq compile-handler
2909 '((0 . byte-compile-no-args)
2910 (1 . byte-compile-one-arg)
2911 (2 . byte-compile-two-args)
2912 (3 . byte-compile-three-args)
2913 (0-1 . byte-compile-zero-or-one-arg)
2914 (1-2 . byte-compile-one-or-two-args)
2915 (2-3 . byte-compile-two-or-three-args)
2917 compile-handler
2918 (intern (concat "byte-compile-"
2919 (symbol-name function))))))))
2920 (if opcode
2921 (list 'progn fnform
2922 (list 'put (list 'quote function)
2923 ''byte-opcode (list 'quote opcode))
2924 (list 'put (list 'quote opcode)
2925 ''byte-opcode-invert (list 'quote function)))
2926 fnform))))
2928 (defmacro byte-defop-compiler19 (function &optional compile-handler)
2929 ;; Just like byte-defop-compiler, but defines an opcode that will only
2930 ;; be used when byte-compile-compatibility is false.
2931 (if (and (byte-compile-single-version)
2932 byte-compile-compatibility)
2933 ;; #### instead of doing nothing, this should do some remprops,
2934 ;; #### to protect against the case where a single-version compiler
2935 ;; #### is loaded into a world that has contained a multi-version one.
2937 (list 'progn
2938 (list 'put
2939 (list 'quote
2940 (or (car (cdr-safe function))
2941 (intern (concat "byte-"
2942 (symbol-name (or (car-safe function) function))))))
2943 ''emacs19-opcode t)
2944 (list 'byte-defop-compiler function compile-handler))))
2946 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
2947 (list 'byte-defop-compiler (list function nil) compile-handler))
2950 (put 'byte-call 'byte-opcode-invert 'funcall)
2951 (put 'byte-list1 'byte-opcode-invert 'list)
2952 (put 'byte-list2 'byte-opcode-invert 'list)
2953 (put 'byte-list3 'byte-opcode-invert 'list)
2954 (put 'byte-list4 'byte-opcode-invert 'list)
2955 (put 'byte-listN 'byte-opcode-invert 'list)
2956 (put 'byte-concat2 'byte-opcode-invert 'concat)
2957 (put 'byte-concat3 'byte-opcode-invert 'concat)
2958 (put 'byte-concat4 'byte-opcode-invert 'concat)
2959 (put 'byte-concatN 'byte-opcode-invert 'concat)
2960 (put 'byte-insertN 'byte-opcode-invert 'insert)
2962 (byte-defop-compiler point 0)
2963 ;;(byte-defop-compiler mark 0) ;; obsolete
2964 (byte-defop-compiler point-max 0)
2965 (byte-defop-compiler point-min 0)
2966 (byte-defop-compiler following-char 0)
2967 (byte-defop-compiler preceding-char 0)
2968 (byte-defop-compiler current-column 0)
2969 (byte-defop-compiler eolp 0)
2970 (byte-defop-compiler eobp 0)
2971 (byte-defop-compiler bolp 0)
2972 (byte-defop-compiler bobp 0)
2973 (byte-defop-compiler current-buffer 0)
2974 ;;(byte-defop-compiler read-char 0) ;; obsolete
2975 (byte-defop-compiler interactive-p 0)
2976 (byte-defop-compiler19 widen 0)
2977 (byte-defop-compiler19 end-of-line 0-1)
2978 (byte-defop-compiler19 forward-char 0-1)
2979 (byte-defop-compiler19 forward-line 0-1)
2980 (byte-defop-compiler symbolp 1)
2981 (byte-defop-compiler consp 1)
2982 (byte-defop-compiler stringp 1)
2983 (byte-defop-compiler listp 1)
2984 (byte-defop-compiler not 1)
2985 (byte-defop-compiler (null byte-not) 1)
2986 (byte-defop-compiler car 1)
2987 (byte-defop-compiler cdr 1)
2988 (byte-defop-compiler length 1)
2989 (byte-defop-compiler symbol-value 1)
2990 (byte-defop-compiler symbol-function 1)
2991 (byte-defop-compiler (1+ byte-add1) 1)
2992 (byte-defop-compiler (1- byte-sub1) 1)
2993 (byte-defop-compiler goto-char 1)
2994 (byte-defop-compiler char-after 0-1)
2995 (byte-defop-compiler set-buffer 1)
2996 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2997 (byte-defop-compiler19 forward-word 0-1)
2998 (byte-defop-compiler19 char-syntax 1)
2999 (byte-defop-compiler19 nreverse 1)
3000 (byte-defop-compiler19 car-safe 1)
3001 (byte-defop-compiler19 cdr-safe 1)
3002 (byte-defop-compiler19 numberp 1)
3003 (byte-defop-compiler19 integerp 1)
3004 (byte-defop-compiler19 skip-chars-forward 1-2)
3005 (byte-defop-compiler19 skip-chars-backward 1-2)
3006 (byte-defop-compiler eq 2)
3007 (byte-defop-compiler memq 2)
3008 (byte-defop-compiler cons 2)
3009 (byte-defop-compiler aref 2)
3010 (byte-defop-compiler set 2)
3011 (byte-defop-compiler (= byte-eqlsign) 2)
3012 (byte-defop-compiler (< byte-lss) 2)
3013 (byte-defop-compiler (> byte-gtr) 2)
3014 (byte-defop-compiler (<= byte-leq) 2)
3015 (byte-defop-compiler (>= byte-geq) 2)
3016 (byte-defop-compiler get 2)
3017 (byte-defop-compiler nth 2)
3018 (byte-defop-compiler substring 2-3)
3019 (byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
3020 (byte-defop-compiler19 set-marker 2-3)
3021 (byte-defop-compiler19 match-beginning 1)
3022 (byte-defop-compiler19 match-end 1)
3023 (byte-defop-compiler19 upcase 1)
3024 (byte-defop-compiler19 downcase 1)
3025 (byte-defop-compiler19 string= 2)
3026 (byte-defop-compiler19 string< 2)
3027 (byte-defop-compiler19 (string-equal byte-string=) 2)
3028 (byte-defop-compiler19 (string-lessp byte-string<) 2)
3029 (byte-defop-compiler19 equal 2)
3030 (byte-defop-compiler19 nthcdr 2)
3031 (byte-defop-compiler19 elt 2)
3032 (byte-defop-compiler19 member 2)
3033 (byte-defop-compiler19 assq 2)
3034 (byte-defop-compiler19 (rplaca byte-setcar) 2)
3035 (byte-defop-compiler19 (rplacd byte-setcdr) 2)
3036 (byte-defop-compiler19 setcar 2)
3037 (byte-defop-compiler19 setcdr 2)
3038 (byte-defop-compiler19 buffer-substring 2)
3039 (byte-defop-compiler19 delete-region 2)
3040 (byte-defop-compiler19 narrow-to-region 2)
3041 (byte-defop-compiler19 (% byte-rem) 2)
3042 (byte-defop-compiler aset 3)
3044 (byte-defop-compiler max byte-compile-associative)
3045 (byte-defop-compiler min byte-compile-associative)
3046 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3047 (byte-defop-compiler19 (* byte-mult) byte-compile-associative)
3049 ;;####(byte-defop-compiler19 move-to-column 1)
3050 (byte-defop-compiler-1 interactive byte-compile-noop)
3053 (defun byte-compile-subr-wrong-args (form n)
3054 (byte-compile-set-symbol-position (car form))
3055 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3056 (car form) (length (cdr form))
3057 (if (= 1 (length (cdr form))) "" "s") n)
3058 ;; get run-time wrong-number-of-args error.
3059 (byte-compile-normal-call form))
3061 (defun byte-compile-no-args (form)
3062 (if (not (= (length form) 1))
3063 (byte-compile-subr-wrong-args form "none")
3064 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3066 (defun byte-compile-one-arg (form)
3067 (if (not (= (length form) 2))
3068 (byte-compile-subr-wrong-args form 1)
3069 (byte-compile-form (car (cdr form))) ;; Push the argument
3070 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3072 (defun byte-compile-two-args (form)
3073 (if (not (= (length form) 3))
3074 (byte-compile-subr-wrong-args form 2)
3075 (byte-compile-form (car (cdr form))) ;; Push the arguments
3076 (byte-compile-form (nth 2 form))
3077 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3079 (defun byte-compile-three-args (form)
3080 (if (not (= (length form) 4))
3081 (byte-compile-subr-wrong-args form 3)
3082 (byte-compile-form (car (cdr form))) ;; Push the arguments
3083 (byte-compile-form (nth 2 form))
3084 (byte-compile-form (nth 3 form))
3085 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3087 (defun byte-compile-zero-or-one-arg (form)
3088 (let ((len (length form)))
3089 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3090 ((= len 2) (byte-compile-one-arg form))
3091 (t (byte-compile-subr-wrong-args form "0-1")))))
3093 (defun byte-compile-one-or-two-args (form)
3094 (let ((len (length form)))
3095 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3096 ((= len 3) (byte-compile-two-args form))
3097 (t (byte-compile-subr-wrong-args form "1-2")))))
3099 (defun byte-compile-two-or-three-args (form)
3100 (let ((len (length form)))
3101 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3102 ((= len 4) (byte-compile-three-args form))
3103 (t (byte-compile-subr-wrong-args form "2-3")))))
3105 (defun byte-compile-noop (form)
3106 (byte-compile-constant nil))
3108 (defun byte-compile-discard ()
3109 (byte-compile-out 'byte-discard 0))
3112 ;; Compile a function that accepts one or more args and is right-associative.
3113 ;; We do it by left-associativity so that the operations
3114 ;; are done in the same order as in interpreted code.
3115 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3116 ;; in order to convert markers to numbers, and trigger expected errors.
3117 (defun byte-compile-associative (form)
3118 (if (cdr form)
3119 (let ((opcode (get (car form) 'byte-opcode))
3120 (args (copy-sequence (cdr form))))
3121 (byte-compile-form (car args))
3122 (setq args (cdr args))
3123 (or args (setq args '(0)
3124 opcode (get '+ 'byte-opcode)))
3125 (dolist (arg args)
3126 (byte-compile-form arg)
3127 (byte-compile-out opcode 0)))
3128 (byte-compile-constant (eval form))))
3131 ;; more complicated compiler macros
3133 (byte-defop-compiler list)
3134 (byte-defop-compiler concat)
3135 (byte-defop-compiler fset)
3136 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3137 (byte-defop-compiler indent-to)
3138 (byte-defop-compiler insert)
3139 (byte-defop-compiler-1 function byte-compile-function-form)
3140 (byte-defop-compiler-1 - byte-compile-minus)
3141 (byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
3142 (byte-defop-compiler19 nconc)
3144 (defun byte-compile-list (form)
3145 (let ((count (length (cdr form))))
3146 (cond ((= count 0)
3147 (byte-compile-constant nil))
3148 ((< count 5)
3149 (mapc 'byte-compile-form (cdr form))
3150 (byte-compile-out
3151 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3152 ((and (< count 256) (not (byte-compile-version-cond
3153 byte-compile-compatibility)))
3154 (mapc 'byte-compile-form (cdr form))
3155 (byte-compile-out 'byte-listN count))
3156 (t (byte-compile-normal-call form)))))
3158 (defun byte-compile-concat (form)
3159 (let ((count (length (cdr form))))
3160 (cond ((and (< 1 count) (< count 5))
3161 (mapc 'byte-compile-form (cdr form))
3162 (byte-compile-out
3163 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3165 ;; Concat of one arg is not a no-op if arg is not a string.
3166 ((= count 0)
3167 (byte-compile-form ""))
3168 ((and (< count 256) (not (byte-compile-version-cond
3169 byte-compile-compatibility)))
3170 (mapc 'byte-compile-form (cdr form))
3171 (byte-compile-out 'byte-concatN count))
3172 ((byte-compile-normal-call form)))))
3174 (defun byte-compile-minus (form)
3175 (if (null (setq form (cdr form)))
3176 (byte-compile-constant 0)
3177 (byte-compile-form (car form))
3178 (if (cdr form)
3179 (while (setq form (cdr form))
3180 (byte-compile-form (car form))
3181 (byte-compile-out 'byte-diff 0))
3182 (byte-compile-out 'byte-negate 0))))
3184 (defun byte-compile-quo (form)
3185 (let ((len (length form)))
3186 (cond ((<= len 2)
3187 (byte-compile-subr-wrong-args form "2 or more"))
3189 (byte-compile-form (car (setq form (cdr form))))
3190 (while (setq form (cdr form))
3191 (byte-compile-form (car form))
3192 (byte-compile-out 'byte-quo 0))))))
3194 (defun byte-compile-nconc (form)
3195 (let ((len (length form)))
3196 (cond ((= len 1)
3197 (byte-compile-constant nil))
3198 ((= len 2)
3199 ;; nconc of one arg is a noop, even if that arg isn't a list.
3200 (byte-compile-form (nth 1 form)))
3202 (byte-compile-form (car (setq form (cdr form))))
3203 (while (setq form (cdr form))
3204 (byte-compile-form (car form))
3205 (byte-compile-out 'byte-nconc 0))))))
3207 (defun byte-compile-fset (form)
3208 ;; warn about forms like (fset 'foo '(lambda () ...))
3209 ;; (where the lambda expression is non-trivial...)
3210 (let ((fn (nth 2 form))
3211 body)
3212 (if (and (eq (car-safe fn) 'quote)
3213 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3214 (progn
3215 (setq body (cdr (cdr fn)))
3216 (if (stringp (car body)) (setq body (cdr body)))
3217 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3218 (if (and (consp (car body))
3219 (not (eq 'byte-code (car (car body)))))
3220 (byte-compile-warn
3221 "A quoted lambda form is the second argument of `fset'. This is probably
3222 not what you want, as that lambda cannot be compiled. Consider using
3223 the syntax (function (lambda (...) ...)) instead.")))))
3224 (byte-compile-two-args form))
3226 (defun byte-compile-funarg (form)
3227 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3228 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3229 (byte-compile-normal-call
3230 (let ((fn (nth 1 form)))
3231 (if (and (eq (car-safe fn) 'quote)
3232 (eq (car-safe (nth 1 fn)) 'lambda))
3233 (cons (car form)
3234 (cons (cons 'function (cdr fn))
3235 (cdr (cdr form))))
3236 form))))
3238 (defun byte-compile-funarg-2 (form)
3239 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3240 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3241 (byte-compile-normal-call
3242 (let ((fn (nth 2 form)))
3243 (if (and (eq (car-safe fn) 'quote)
3244 (eq (car-safe (nth 1 fn)) 'lambda))
3245 (cons (car form)
3246 (cons (nth 1 form)
3247 (cons (cons 'function (cdr fn))
3248 (cdr (cdr (cdr form))))))
3249 form))))
3251 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3252 ;; Otherwise it will be incompatible with the interpreter,
3253 ;; and (funcall (function foo)) will lose with autoloads.
3255 (defun byte-compile-function-form (form)
3256 (byte-compile-constant
3257 (cond ((symbolp (nth 1 form))
3258 (nth 1 form))
3259 ;; If we're not allowed to use #[] syntax, then output a form like
3260 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3261 ;; In this situation, calling make-byte-code at run-time will usually
3262 ;; be less efficient than processing a call to byte-code.
3263 ((byte-compile-version-cond byte-compile-compatibility)
3264 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
3265 ((byte-compile-lambda (nth 1 form))))))
3267 (defun byte-compile-indent-to (form)
3268 (let ((len (length form)))
3269 (cond ((= len 2)
3270 (byte-compile-form (car (cdr form)))
3271 (byte-compile-out 'byte-indent-to 0))
3272 ((= len 3)
3273 ;; no opcode for 2-arg case.
3274 (byte-compile-normal-call form))
3276 (byte-compile-subr-wrong-args form "1-2")))))
3278 (defun byte-compile-insert (form)
3279 (cond ((null (cdr form))
3280 (byte-compile-constant nil))
3281 ((and (not (byte-compile-version-cond
3282 byte-compile-compatibility))
3283 (<= (length form) 256))
3284 (mapc 'byte-compile-form (cdr form))
3285 (if (cdr (cdr form))
3286 (byte-compile-out 'byte-insertN (length (cdr form)))
3287 (byte-compile-out 'byte-insert 0)))
3288 ((memq t (mapcar 'consp (cdr (cdr form))))
3289 (byte-compile-normal-call form))
3290 ;; We can split it; there is no function call after inserting 1st arg.
3292 (while (setq form (cdr form))
3293 (byte-compile-form (car form))
3294 (byte-compile-out 'byte-insert 0)
3295 (if (cdr form)
3296 (byte-compile-discard))))))
3299 (byte-defop-compiler-1 setq)
3300 (byte-defop-compiler-1 setq-default)
3301 (byte-defop-compiler-1 quote)
3302 (byte-defop-compiler-1 quote-form)
3304 (defun byte-compile-setq (form)
3305 (let ((args (cdr form)))
3306 (if args
3307 (while args
3308 (byte-compile-form (car (cdr args)))
3309 (or for-effect (cdr (cdr args))
3310 (byte-compile-out 'byte-dup 0))
3311 (byte-compile-variable-ref 'byte-varset (car args))
3312 (setq args (cdr (cdr args))))
3313 ;; (setq), with no arguments.
3314 (byte-compile-form nil for-effect))
3315 (setq for-effect nil)))
3317 (defun byte-compile-setq-default (form)
3318 (let ((args (cdr form))
3319 setters)
3320 (while args
3321 (setq setters
3322 (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
3323 setters))
3324 (setq args (cdr (cdr args))))
3325 (byte-compile-form (cons 'progn (nreverse setters)))))
3327 (defun byte-compile-quote (form)
3328 (byte-compile-constant (car (cdr form))))
3330 (defun byte-compile-quote-form (form)
3331 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3334 ;;; control structures
3336 (defun byte-compile-body (body &optional for-effect)
3337 (while (cdr body)
3338 (byte-compile-form (car body) t)
3339 (setq body (cdr body)))
3340 (byte-compile-form (car body) for-effect))
3342 (defsubst byte-compile-body-do-effect (body)
3343 (byte-compile-body body for-effect)
3344 (setq for-effect nil))
3346 (defsubst byte-compile-form-do-effect (form)
3347 (byte-compile-form form for-effect)
3348 (setq for-effect nil))
3350 (byte-defop-compiler-1 inline byte-compile-progn)
3351 (byte-defop-compiler-1 progn)
3352 (byte-defop-compiler-1 prog1)
3353 (byte-defop-compiler-1 prog2)
3354 (byte-defop-compiler-1 if)
3355 (byte-defop-compiler-1 cond)
3356 (byte-defop-compiler-1 and)
3357 (byte-defop-compiler-1 or)
3358 (byte-defop-compiler-1 while)
3359 (byte-defop-compiler-1 funcall)
3360 (byte-defop-compiler-1 apply byte-compile-funarg)
3361 (byte-defop-compiler-1 mapcar byte-compile-funarg)
3362 (byte-defop-compiler-1 mapatoms byte-compile-funarg)
3363 (byte-defop-compiler-1 mapconcat byte-compile-funarg)
3364 (byte-defop-compiler-1 mapc byte-compile-funarg)
3365 (byte-defop-compiler-1 maphash byte-compile-funarg)
3366 (byte-defop-compiler-1 map-char-table byte-compile-funarg)
3367 (byte-defop-compiler-1 sort byte-compile-funarg-2)
3368 (byte-defop-compiler-1 let)
3369 (byte-defop-compiler-1 let*)
3371 (defun byte-compile-progn (form)
3372 (byte-compile-body-do-effect (cdr form)))
3374 (defun byte-compile-prog1 (form)
3375 (byte-compile-form-do-effect (car (cdr form)))
3376 (byte-compile-body (cdr (cdr form)) t))
3378 (defun byte-compile-prog2 (form)
3379 (byte-compile-form (nth 1 form) t)
3380 (byte-compile-form-do-effect (nth 2 form))
3381 (byte-compile-body (cdr (cdr (cdr form))) t))
3383 (defmacro byte-compile-goto-if (cond discard tag)
3384 `(byte-compile-goto
3385 (if ,cond
3386 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3387 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3388 ,tag))
3390 (defmacro byte-compile-maybe-guarded (condition &rest body)
3391 "Execute forms in BODY, potentially guarded by CONDITION.
3392 CONDITION is a variable whose value is a test in an `if' or `cond'.
3393 BODY is the code to compile first arm of the if or the body of the
3394 cond clause. If CONDITION's value is of the form (fboundp 'foo)
3395 or (boundp 'foo), the relevant warnings from BODY about foo's
3396 being undefined will be suppressed.
3398 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3399 that suppresses all warnings during execution of BODY."
3400 (declare (indent 1) (debug t))
3401 `(let* ((fbound
3402 (if (eq 'fboundp (car-safe ,condition))
3403 (and (eq 'quote (car-safe (nth 1 ,condition)))
3404 ;; Ignore if the symbol is already on the
3405 ;; unresolved list.
3406 (not (assq (nth 1 (nth 1 ,condition)) ; the relevant symbol
3407 byte-compile-unresolved-functions))
3408 (nth 1 (nth 1 ,condition)))))
3409 (bound (if (or (eq 'boundp (car-safe ,condition))
3410 (eq 'default-boundp (car-safe ,condition)))
3411 (and (eq 'quote (car-safe (nth 1 ,condition)))
3412 (nth 1 (nth 1 ,condition)))))
3413 ;; Maybe add to the bound list.
3414 (byte-compile-bound-variables
3415 (if bound
3416 (cons bound byte-compile-bound-variables)
3417 byte-compile-bound-variables))
3418 ;; Suppress all warnings, for code not used in Emacs.
3419 (byte-compile-warnings
3420 (if (member ,condition '((featurep 'xemacs)
3421 (not (featurep 'emacs))))
3422 nil byte-compile-warnings)))
3423 (unwind-protect
3424 (progn ,@body)
3425 ;; Maybe remove the function symbol from the unresolved list.
3426 (if fbound
3427 (setq byte-compile-unresolved-functions
3428 (delq (assq fbound byte-compile-unresolved-functions)
3429 byte-compile-unresolved-functions))))))
3431 (defun byte-compile-if (form)
3432 (byte-compile-form (car (cdr form)))
3433 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3434 ;; and avoid warnings about the relevent symbols in the consequent.
3435 (let ((clause (nth 1 form))
3436 (donetag (byte-compile-make-tag)))
3437 (if (null (nthcdr 3 form))
3438 ;; No else-forms
3439 (progn
3440 (byte-compile-goto-if nil for-effect donetag)
3441 (byte-compile-maybe-guarded clause
3442 (byte-compile-form (nth 2 form) for-effect))
3443 (byte-compile-out-tag donetag))
3444 (let ((elsetag (byte-compile-make-tag)))
3445 (byte-compile-goto 'byte-goto-if-nil elsetag)
3446 (byte-compile-maybe-guarded clause
3447 (byte-compile-form (nth 2 form) for-effect))
3448 (byte-compile-goto 'byte-goto donetag)
3449 (byte-compile-out-tag elsetag)
3450 (byte-compile-maybe-guarded (list 'not clause)
3451 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3452 (byte-compile-out-tag donetag))))
3453 (setq for-effect nil))
3455 (defun byte-compile-cond (clauses)
3456 (let ((donetag (byte-compile-make-tag))
3457 nexttag clause)
3458 (while (setq clauses (cdr clauses))
3459 (setq clause (car clauses))
3460 (cond ((or (eq (car clause) t)
3461 (and (eq (car-safe (car clause)) 'quote)
3462 (car-safe (cdr-safe (car clause)))))
3463 ;; Unconditional clause
3464 (setq clause (cons t clause)
3465 clauses nil))
3466 ((cdr clauses)
3467 (byte-compile-form (car clause))
3468 (if (null (cdr clause))
3469 ;; First clause is a singleton.
3470 (byte-compile-goto-if t for-effect donetag)
3471 (setq nexttag (byte-compile-make-tag))
3472 (byte-compile-goto 'byte-goto-if-nil nexttag)
3473 (byte-compile-maybe-guarded (car clause)
3474 (byte-compile-body (cdr clause) for-effect))
3475 (byte-compile-goto 'byte-goto donetag)
3476 (byte-compile-out-tag nexttag)))))
3477 ;; Last clause
3478 (let ((guard (car clause)))
3479 (and (cdr clause) (not (eq guard t))
3480 (progn (byte-compile-form guard)
3481 (byte-compile-goto-if nil for-effect donetag)
3482 (setq clause (cdr clause))))
3483 (byte-compile-maybe-guarded guard
3484 (byte-compile-body-do-effect clause)))
3485 (byte-compile-out-tag donetag)))
3487 (defun byte-compile-and (form)
3488 (let ((failtag (byte-compile-make-tag))
3489 (args (cdr form)))
3490 (if (null args)
3491 (byte-compile-form-do-effect t)
3492 (byte-compile-and-recursion args failtag))))
3494 ;; Handle compilation of a nontrivial `and' call.
3495 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3496 (defun byte-compile-and-recursion (rest failtag)
3497 (if (cdr rest)
3498 (progn
3499 (byte-compile-form (car rest))
3500 (byte-compile-goto-if nil for-effect failtag)
3501 (byte-compile-maybe-guarded (car rest)
3502 (byte-compile-and-recursion (cdr rest) failtag)))
3503 (byte-compile-form-do-effect (car rest))
3504 (byte-compile-out-tag failtag)))
3506 (defun byte-compile-or (form)
3507 (let ((wintag (byte-compile-make-tag))
3508 (args (cdr form)))
3509 (if (null args)
3510 (byte-compile-form-do-effect nil)
3511 (byte-compile-or-recursion args wintag))))
3513 ;; Handle compilation of a nontrivial `or' call.
3514 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3515 (defun byte-compile-or-recursion (rest wintag)
3516 (if (cdr rest)
3517 (progn
3518 (byte-compile-form (car rest))
3519 (byte-compile-goto-if t for-effect wintag)
3520 (byte-compile-maybe-guarded (list 'not (car rest))
3521 (byte-compile-or-recursion (cdr rest) wintag)))
3522 (byte-compile-form-do-effect (car rest))
3523 (byte-compile-out-tag wintag)))
3525 (defun byte-compile-while (form)
3526 (let ((endtag (byte-compile-make-tag))
3527 (looptag (byte-compile-make-tag)))
3528 (byte-compile-out-tag looptag)
3529 (byte-compile-form (car (cdr form)))
3530 (byte-compile-goto-if nil for-effect endtag)
3531 (byte-compile-body (cdr (cdr form)) t)
3532 (byte-compile-goto 'byte-goto looptag)
3533 (byte-compile-out-tag endtag)
3534 (setq for-effect nil)))
3536 (defun byte-compile-funcall (form)
3537 (mapc 'byte-compile-form (cdr form))
3538 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3541 (defun byte-compile-let (form)
3542 ;; First compute the binding values in the old scope.
3543 (let ((varlist (car (cdr form))))
3544 (dolist (var varlist)
3545 (if (consp var)
3546 (byte-compile-form (car (cdr var)))
3547 (byte-compile-push-constant nil))))
3548 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3549 (varlist (reverse (car (cdr form)))))
3550 (dolist (var varlist)
3551 (byte-compile-variable-ref 'byte-varbind (if (consp var) (car var) var)))
3552 (byte-compile-body-do-effect (cdr (cdr form)))
3553 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3555 (defun byte-compile-let* (form)
3556 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3557 (varlist (copy-sequence (car (cdr form)))))
3558 (dolist (var varlist)
3559 (if (atom var)
3560 (byte-compile-push-constant nil)
3561 (byte-compile-form (car (cdr var)))
3562 (setq var (car var)))
3563 (byte-compile-variable-ref 'byte-varbind var))
3564 (byte-compile-body-do-effect (cdr (cdr form)))
3565 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3568 (byte-defop-compiler-1 /= byte-compile-negated)
3569 (byte-defop-compiler-1 atom byte-compile-negated)
3570 (byte-defop-compiler-1 nlistp byte-compile-negated)
3572 (put '/= 'byte-compile-negated-op '=)
3573 (put 'atom 'byte-compile-negated-op 'consp)
3574 (put 'nlistp 'byte-compile-negated-op 'listp)
3576 (defun byte-compile-negated (form)
3577 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3579 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3580 (defun byte-compile-negation-optimizer (form)
3581 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3582 (byte-compile-set-symbol-position (car form))
3583 (list 'not
3584 (cons (or (get (car form) 'byte-compile-negated-op)
3585 (error
3586 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3587 (car form)))
3588 (cdr form))))
3590 ;;; other tricky macro-like special-forms
3592 (byte-defop-compiler-1 catch)
3593 (byte-defop-compiler-1 unwind-protect)
3594 (byte-defop-compiler-1 condition-case)
3595 (byte-defop-compiler-1 save-excursion)
3596 (byte-defop-compiler-1 save-current-buffer)
3597 (byte-defop-compiler-1 save-restriction)
3598 (byte-defop-compiler-1 save-window-excursion)
3599 (byte-defop-compiler-1 with-output-to-temp-buffer)
3600 (byte-defop-compiler-1 track-mouse)
3602 (defun byte-compile-catch (form)
3603 (byte-compile-form (car (cdr form)))
3604 (byte-compile-push-constant
3605 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3606 (byte-compile-out 'byte-catch 0))
3608 (defun byte-compile-unwind-protect (form)
3609 (byte-compile-push-constant
3610 (byte-compile-top-level-body (cdr (cdr form)) t))
3611 (byte-compile-out 'byte-unwind-protect 0)
3612 (byte-compile-form-do-effect (car (cdr form)))
3613 (byte-compile-out 'byte-unbind 1))
3615 (defun byte-compile-track-mouse (form)
3616 (byte-compile-form
3617 `(funcall '(lambda nil
3618 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
3620 (defun byte-compile-condition-case (form)
3621 (let* ((var (nth 1 form))
3622 (byte-compile-bound-variables
3623 (if var (cons var byte-compile-bound-variables)
3624 byte-compile-bound-variables)))
3625 (byte-compile-set-symbol-position 'condition-case)
3626 (unless (symbolp var)
3627 (byte-compile-warn
3628 "`%s' is not a variable-name or nil (in condition-case)" var))
3629 (byte-compile-push-constant var)
3630 (byte-compile-push-constant (byte-compile-top-level
3631 (nth 2 form) for-effect))
3632 (let ((clauses (cdr (cdr (cdr form))))
3633 compiled-clauses)
3634 (while clauses
3635 (let* ((clause (car clauses))
3636 (condition (car clause)))
3637 (cond ((not (or (symbolp condition)
3638 (and (listp condition)
3639 (let ((syms condition) (ok t))
3640 (while syms
3641 (if (not (symbolp (car syms)))
3642 (setq ok nil))
3643 (setq syms (cdr syms)))
3644 ok))))
3645 (byte-compile-warn
3646 "`%s' is not a condition name or list of such (in condition-case)"
3647 (prin1-to-string condition)))
3648 ;; ((not (or (eq condition 't)
3649 ;; (and (stringp (get condition 'error-message))
3650 ;; (consp (get condition 'error-conditions)))))
3651 ;; (byte-compile-warn
3652 ;; "`%s' is not a known condition name (in condition-case)"
3653 ;; condition))
3655 (setq compiled-clauses
3656 (cons (cons condition
3657 (byte-compile-top-level-body
3658 (cdr clause) for-effect))
3659 compiled-clauses)))
3660 (setq clauses (cdr clauses)))
3661 (byte-compile-push-constant (nreverse compiled-clauses)))
3662 (byte-compile-out 'byte-condition-case 0)))
3665 (defun byte-compile-save-excursion (form)
3666 (byte-compile-out 'byte-save-excursion 0)
3667 (byte-compile-body-do-effect (cdr form))
3668 (byte-compile-out 'byte-unbind 1))
3670 (defun byte-compile-save-restriction (form)
3671 (byte-compile-out 'byte-save-restriction 0)
3672 (byte-compile-body-do-effect (cdr form))
3673 (byte-compile-out 'byte-unbind 1))
3675 (defun byte-compile-save-current-buffer (form)
3676 (byte-compile-out 'byte-save-current-buffer 0)
3677 (byte-compile-body-do-effect (cdr form))
3678 (byte-compile-out 'byte-unbind 1))
3680 (defun byte-compile-save-window-excursion (form)
3681 (byte-compile-push-constant
3682 (byte-compile-top-level-body (cdr form) for-effect))
3683 (byte-compile-out 'byte-save-window-excursion 0))
3685 (defun byte-compile-with-output-to-temp-buffer (form)
3686 (byte-compile-form (car (cdr form)))
3687 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3688 (byte-compile-body (cdr (cdr form)))
3689 (byte-compile-out 'byte-temp-output-buffer-show 0))
3691 ;;; top-level forms elsewhere
3693 (byte-defop-compiler-1 defun)
3694 (byte-defop-compiler-1 defmacro)
3695 (byte-defop-compiler-1 defvar)
3696 (byte-defop-compiler-1 defconst byte-compile-defvar)
3697 (byte-defop-compiler-1 autoload)
3698 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
3700 (defun byte-compile-defun (form)
3701 ;; This is not used for file-level defuns with doc strings.
3702 (if (symbolp (car form))
3703 (byte-compile-set-symbol-position (car form))
3704 (byte-compile-set-symbol-position 'defun)
3705 (error "defun name must be a symbol, not %s" (car form)))
3706 (if (byte-compile-version-cond byte-compile-compatibility)
3707 (progn
3708 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3709 (list 'fset
3710 (list 'quote (nth 1 form))
3711 (byte-compile-byte-code-maker
3712 (byte-compile-lambda (cdr (cdr form)) t))))
3713 (byte-compile-discard))
3714 ;; We prefer to generate a defalias form so it will record the function
3715 ;; definition just like interpreting a defun.
3716 (byte-compile-form
3717 (list 'defalias
3718 (list 'quote (nth 1 form))
3719 (byte-compile-byte-code-maker
3720 (byte-compile-lambda (cdr (cdr form)) t)))
3722 (byte-compile-constant (nth 1 form)))
3724 (defun byte-compile-defmacro (form)
3725 ;; This is not used for file-level defmacros with doc strings.
3726 (byte-compile-body-do-effect
3727 (list (list 'fset (list 'quote (nth 1 form))
3728 (let ((code (byte-compile-byte-code-maker
3729 (byte-compile-lambda (cdr (cdr form)) t))))
3730 (if (eq (car-safe code) 'make-byte-code)
3731 (list 'cons ''macro code)
3732 (list 'quote (cons 'macro (eval code))))))
3733 (list 'quote (nth 1 form)))))
3735 (defun byte-compile-defvar (form)
3736 ;; This is not used for file-level defvar/consts with doc strings.
3737 (let ((fun (nth 0 form))
3738 (var (nth 1 form))
3739 (value (nth 2 form))
3740 (string (nth 3 form)))
3741 (byte-compile-set-symbol-position fun)
3742 (when (or (> (length form) 4)
3743 (and (eq fun 'defconst) (null (cddr form))))
3744 (let ((ncall (length (cdr form))))
3745 (byte-compile-warn
3746 "`%s' called with %d argument%s, but %s %s"
3747 fun ncall
3748 (if (= 1 ncall) "" "s")
3749 (if (< ncall 2) "requires" "accepts only")
3750 "2-3")))
3751 (when (memq 'free-vars byte-compile-warnings)
3752 (push var byte-compile-bound-variables)
3753 (if (eq fun 'defconst)
3754 (push var byte-compile-const-variables)))
3755 (byte-compile-body-do-effect
3756 (list
3757 ;; Put the defined variable in this library's load-history entry
3758 ;; just as a real defvar would, but only in top-level forms.
3759 (when (and (cddr form) (null byte-compile-current-form))
3760 `(push ',var current-load-list))
3761 (when (> (length form) 3)
3762 (when (and string (not (stringp string)))
3763 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3764 fun var string))
3765 `(put ',var 'variable-documentation ,string))
3766 (if (cddr form) ; `value' provided
3767 (let ((byte-compile-not-obsolete-var var))
3768 (if (eq fun 'defconst)
3769 ;; `defconst' sets `var' unconditionally.
3770 (let ((tmp (make-symbol "defconst-tmp-var")))
3771 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3772 ,value))
3773 ;; `defvar' sets `var' only when unbound.
3774 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
3775 (when (eq fun 'defconst)
3776 ;; This will signal an appropriate error at runtime.
3777 `(eval ',form)))
3778 `',var))))
3780 (defun byte-compile-autoload (form)
3781 (byte-compile-set-symbol-position 'autoload)
3782 (and (byte-compile-constp (nth 1 form))
3783 (byte-compile-constp (nth 5 form))
3784 (eval (nth 5 form)) ; macro-p
3785 (not (fboundp (eval (nth 1 form))))
3786 (byte-compile-warn
3787 "The compiler ignores `autoload' except at top level. You should
3788 probably put the autoload of the macro `%s' at top-level."
3789 (eval (nth 1 form))))
3790 (byte-compile-normal-call form))
3792 ;; Lambdas in valid places are handled as special cases by various code.
3793 ;; The ones that remain are errors.
3794 (defun byte-compile-lambda-form (form)
3795 (byte-compile-set-symbol-position 'lambda)
3796 (error "`lambda' used as function name is invalid"))
3798 ;; Compile normally, but deal with warnings for the function being defined.
3799 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3800 (defun byte-compile-file-form-defalias (form)
3801 (if (and (consp (cdr form)) (consp (nth 1 form))
3802 (eq (car (nth 1 form)) 'quote)
3803 (consp (cdr (nth 1 form)))
3804 (symbolp (nth 1 (nth 1 form))))
3805 (let ((constant
3806 (and (consp (nthcdr 2 form))
3807 (consp (nth 2 form))
3808 (eq (car (nth 2 form)) 'quote)
3809 (consp (cdr (nth 2 form)))
3810 (symbolp (nth 1 (nth 2 form))))))
3811 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
3812 (push (cons (nth 1 (nth 1 form))
3813 (if constant (nth 1 (nth 2 form)) t))
3814 byte-compile-function-environment)))
3815 ;; We used to jus do: (byte-compile-normal-call form)
3816 ;; But it turns out that this fails to optimize the code.
3817 ;; So instead we now do the same as what other byte-hunk-handlers do,
3818 ;; which is to call back byte-compile-file-form and then return nil.
3819 ;; Except that we can't just call byte-compile-file-form since it would
3820 ;; call us right back.
3821 (byte-compile-keep-pending form)
3822 ;; Return nil so the form is not output twice.
3823 nil)
3825 ;; Turn off warnings about prior calls to the function being defalias'd.
3826 ;; This could be smarter and compare those calls with
3827 ;; the function it is being aliased to.
3828 (defun byte-compile-defalias-warn (new)
3829 (let ((calls (assq new byte-compile-unresolved-functions)))
3830 (if calls
3831 (setq byte-compile-unresolved-functions
3832 (delq calls byte-compile-unresolved-functions)))))
3834 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3835 (defun byte-compile-no-warnings (form)
3836 (let (byte-compile-warnings)
3837 (byte-compile-form (cons 'progn (cdr form)))))
3839 ;; Warn about misuses of make-variable-buffer-local.
3840 (byte-defop-compiler-1 make-variable-buffer-local byte-compile-make-variable-buffer-local)
3841 (defun byte-compile-make-variable-buffer-local (form)
3842 (if (eq (car-safe (car-safe (cdr-safe form))) 'quote)
3843 (byte-compile-warn
3844 "`make-variable-buffer-local' should be called at toplevel"))
3845 (byte-compile-normal-call form))
3846 (put 'make-variable-buffer-local
3847 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
3848 (defun byte-compile-form-make-variable-buffer-local (form)
3849 (byte-compile-keep-pending form 'byte-compile-normal-call))
3852 ;;; tags
3854 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3855 ;; optimization to have the 'TAG as a part of the tag.
3856 ;; Tags will be (TAG . (tag-number . stack-depth)).
3857 (defun byte-compile-make-tag ()
3858 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
3861 (defun byte-compile-out-tag (tag)
3862 (setq byte-compile-output (cons tag byte-compile-output))
3863 (if (cdr (cdr tag))
3864 (progn
3865 ;; ## remove this someday
3866 (and byte-compile-depth
3867 (not (= (cdr (cdr tag)) byte-compile-depth))
3868 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
3869 (setq byte-compile-depth (cdr (cdr tag))))
3870 (setcdr (cdr tag) byte-compile-depth)))
3872 (defun byte-compile-goto (opcode tag)
3873 (push (cons opcode tag) byte-compile-output)
3874 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
3875 (1- byte-compile-depth)
3876 byte-compile-depth))
3877 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
3878 (1- byte-compile-depth))))
3880 (defun byte-compile-out (opcode offset)
3881 (push (cons opcode offset) byte-compile-output)
3882 (cond ((eq opcode 'byte-call)
3883 (setq byte-compile-depth (- byte-compile-depth offset)))
3884 ((eq opcode 'byte-return)
3885 ;; This is actually an unnecessary case, because there should be
3886 ;; no more opcodes behind byte-return.
3887 (setq byte-compile-depth nil))
3889 (setq byte-compile-depth (+ byte-compile-depth
3890 (or (aref byte-stack+-info
3891 (symbol-value opcode))
3892 (- (1- offset))))
3893 byte-compile-maxdepth (max byte-compile-depth
3894 byte-compile-maxdepth))))
3895 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3899 ;;; call tree stuff
3901 (defun byte-compile-annotate-call-tree (form)
3902 (let (entry)
3903 ;; annotate the current call
3904 (if (setq entry (assq (car form) byte-compile-call-tree))
3905 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
3906 (setcar (cdr entry)
3907 (cons byte-compile-current-form (nth 1 entry))))
3908 (setq byte-compile-call-tree
3909 (cons (list (car form) (list byte-compile-current-form) nil)
3910 byte-compile-call-tree)))
3911 ;; annotate the current function
3912 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
3913 (or (memq (car form) (nth 2 entry)) ;called
3914 (setcar (cdr (cdr entry))
3915 (cons (car form) (nth 2 entry))))
3916 (setq byte-compile-call-tree
3917 (cons (list byte-compile-current-form nil (list (car form)))
3918 byte-compile-call-tree)))
3921 ;; Renamed from byte-compile-report-call-tree
3922 ;; to avoid interfering with completion of byte-compile-file.
3923 ;;;###autoload
3924 (defun display-call-tree (&optional filename)
3925 "Display a call graph of a specified file.
3926 This lists which functions have been called, what functions called
3927 them, and what functions they call. The list includes all functions
3928 whose definitions have been compiled in this Emacs session, as well as
3929 all functions called by those functions.
3931 The call graph does not include macros, inline functions, or
3932 primitives that the byte-code interpreter knows about directly \(eq,
3933 cons, etc.\).
3935 The call tree also lists those functions which are not known to be called
3936 \(that is, to which no calls have been compiled\), and which cannot be
3937 invoked interactively."
3938 (interactive)
3939 (message "Generating call tree...")
3940 (with-output-to-temp-buffer "*Call-Tree*"
3941 (set-buffer "*Call-Tree*")
3942 (erase-buffer)
3943 (message "Generating call tree... (sorting on %s)"
3944 byte-compile-call-tree-sort)
3945 (insert "Call tree for "
3946 (cond ((null byte-compile-current-file) (or filename "???"))
3947 ((stringp byte-compile-current-file)
3948 byte-compile-current-file)
3949 (t (buffer-name byte-compile-current-file)))
3950 " sorted on "
3951 (prin1-to-string byte-compile-call-tree-sort)
3952 ":\n\n")
3953 (if byte-compile-call-tree-sort
3954 (setq byte-compile-call-tree
3955 (sort byte-compile-call-tree
3956 (cond ((eq byte-compile-call-tree-sort 'callers)
3957 (function (lambda (x y) (< (length (nth 1 x))
3958 (length (nth 1 y))))))
3959 ((eq byte-compile-call-tree-sort 'calls)
3960 (function (lambda (x y) (< (length (nth 2 x))
3961 (length (nth 2 y))))))
3962 ((eq byte-compile-call-tree-sort 'calls+callers)
3963 (function (lambda (x y) (< (+ (length (nth 1 x))
3964 (length (nth 2 x)))
3965 (+ (length (nth 1 y))
3966 (length (nth 2 y)))))))
3967 ((eq byte-compile-call-tree-sort 'name)
3968 (function (lambda (x y) (string< (car x)
3969 (car y)))))
3970 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3971 byte-compile-call-tree-sort))))))
3972 (message "Generating call tree...")
3973 (let ((rest byte-compile-call-tree)
3974 (b (current-buffer))
3976 callers calls)
3977 (while rest
3978 (prin1 (car (car rest)) b)
3979 (setq callers (nth 1 (car rest))
3980 calls (nth 2 (car rest)))
3981 (insert "\t"
3982 (cond ((not (fboundp (setq f (car (car rest)))))
3983 (if (null f)
3984 " <top level>";; shouldn't insert nil then, actually -sk
3985 " <not defined>"))
3986 ((subrp (setq f (symbol-function f)))
3987 " <subr>")
3988 ((symbolp f)
3989 (format " ==> %s" f))
3990 ((byte-code-function-p f)
3991 "<compiled function>")
3992 ((not (consp f))
3993 "<malformed function>")
3994 ((eq 'macro (car f))
3995 (if (or (byte-code-function-p (cdr f))
3996 (assq 'byte-code (cdr (cdr (cdr f)))))
3997 " <compiled macro>"
3998 " <macro>"))
3999 ((assq 'byte-code (cdr (cdr f)))
4000 "<compiled lambda>")
4001 ((eq 'lambda (car f))
4002 "<function>")
4003 (t "???"))
4004 (format " (%d callers + %d calls = %d)"
4005 ;; Does the optimizer eliminate common subexpressions?-sk
4006 (length callers)
4007 (length calls)
4008 (+ (length callers) (length calls)))
4009 "\n")
4010 (if callers
4011 (progn
4012 (insert " called by:\n")
4013 (setq p (point))
4014 (insert " " (if (car callers)
4015 (mapconcat 'symbol-name callers ", ")
4016 "<top level>"))
4017 (let ((fill-prefix " "))
4018 (fill-region-as-paragraph p (point)))
4019 (unless (= 0 (current-column))
4020 (insert "\n"))))
4021 (if calls
4022 (progn
4023 (insert " calls:\n")
4024 (setq p (point))
4025 (insert " " (mapconcat 'symbol-name calls ", "))
4026 (let ((fill-prefix " "))
4027 (fill-region-as-paragraph p (point)))
4028 (unless (= 0 (current-column))
4029 (insert "\n"))))
4030 (setq rest (cdr rest)))
4032 (message "Generating call tree...(finding uncalled functions...)")
4033 (setq rest byte-compile-call-tree)
4034 (let ((uncalled nil))
4035 (while rest
4036 (or (nth 1 (car rest))
4037 (null (setq f (car (car rest))))
4038 (functionp (byte-compile-fdefinition f t))
4039 (commandp (byte-compile-fdefinition f nil))
4040 (setq uncalled (cons f uncalled)))
4041 (setq rest (cdr rest)))
4042 (if uncalled
4043 (let ((fill-prefix " "))
4044 (insert "Noninteractive functions not known to be called:\n ")
4045 (setq p (point))
4046 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4047 (fill-region-as-paragraph p (point)))))
4049 (message "Generating call tree...done.")
4053 ;;;###autoload
4054 (defun batch-byte-compile-if-not-done ()
4055 "Like `byte-compile-file' but doesn't recompile if already up to date.
4056 Use this from the command line, with `-batch';
4057 it won't work in an interactive Emacs."
4058 (batch-byte-compile t))
4060 ;;; by crl@newton.purdue.edu
4061 ;;; Only works noninteractively.
4062 ;;;###autoload
4063 (defun batch-byte-compile (&optional noforce)
4064 "Run `byte-compile-file' on the files remaining on the command line.
4065 Use this from the command line, with `-batch';
4066 it won't work in an interactive Emacs.
4067 Each file is processed even if an error occurred previously.
4068 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4069 If NOFORCE is non-nil, don't recompile a file that seems to be
4070 already up-to-date."
4071 ;; command-line-args-left is what is left of the command line (from startup.el)
4072 (defvar command-line-args-left) ;Avoid 'free variable' warning
4073 (if (not noninteractive)
4074 (error "`batch-byte-compile' is to be used only with -batch"))
4075 (let ((error nil))
4076 (while command-line-args-left
4077 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4078 ;; Directory as argument.
4079 (let ((files (directory-files (car command-line-args-left)))
4080 source dest)
4081 (dolist (file files)
4082 (if (and (string-match emacs-lisp-file-regexp file)
4083 (not (auto-save-file-name-p file))
4084 (setq source (expand-file-name file
4085 (car command-line-args-left)))
4086 (setq dest (byte-compile-dest-file source))
4087 (file-exists-p dest)
4088 (file-newer-than-file-p source dest))
4089 (if (null (batch-byte-compile-file source))
4090 (setq error t)))))
4091 ;; Specific file argument
4092 (if (or (not noforce)
4093 (let* ((source (car command-line-args-left))
4094 (dest (byte-compile-dest-file source)))
4095 (or (not (file-exists-p dest))
4096 (file-newer-than-file-p source dest))))
4097 (if (null (batch-byte-compile-file (car command-line-args-left)))
4098 (setq error t))))
4099 (setq command-line-args-left (cdr command-line-args-left)))
4100 (kill-emacs (if error 1 0))))
4102 (defun batch-byte-compile-file (file)
4103 (if debug-on-error
4104 (byte-compile-file file)
4105 (condition-case err
4106 (byte-compile-file file)
4107 (file-error
4108 (message (if (cdr err)
4109 ">>Error occurred processing %s: %s (%s)"
4110 ">>Error occurred processing %s: %s")
4111 file
4112 (get (car err) 'error-message)
4113 (prin1-to-string (cdr err)))
4114 (let ((destfile (byte-compile-dest-file file)))
4115 (if (file-exists-p destfile)
4116 (delete-file destfile)))
4117 nil)
4118 (error
4119 (message (if (cdr err)
4120 ">>Error occurred processing %s: %s (%s)"
4121 ">>Error occurred processing %s: %s")
4122 file
4123 (get (car err) 'error-message)
4124 (prin1-to-string (cdr err)))
4125 nil))))
4127 ;;;###autoload
4128 (defun batch-byte-recompile-directory (&optional arg)
4129 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4130 Must be used only with `-batch', and kills Emacs on completion.
4131 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4133 Optional argument ARG is passed as second argument ARG to
4134 `batch-recompile-directory'; see there for its possible values
4135 and corresponding effects."
4136 ;; command-line-args-left is what is left of the command line (startup.el)
4137 (defvar command-line-args-left) ;Avoid 'free variable' warning
4138 (if (not noninteractive)
4139 (error "batch-byte-recompile-directory is to be used only with -batch"))
4140 (or command-line-args-left
4141 (setq command-line-args-left '(".")))
4142 (while command-line-args-left
4143 (byte-recompile-directory (car command-line-args-left) arg)
4144 (setq command-line-args-left (cdr command-line-args-left)))
4145 (kill-emacs 0))
4147 (provide 'byte-compile)
4148 (provide 'bytecomp)
4151 ;;; report metering (see the hacks in bytecode.c)
4153 (defvar byte-code-meter)
4154 (defun byte-compile-report-ops ()
4155 (with-output-to-temp-buffer "*Meter*"
4156 (set-buffer "*Meter*")
4157 (let ((i 0) n op off)
4158 (while (< i 256)
4159 (setq n (aref (aref byte-code-meter 0) i)
4160 off nil)
4161 (if t ;(not (zerop n))
4162 (progn
4163 (setq op i)
4164 (setq off nil)
4165 (cond ((< op byte-nth)
4166 (setq off (logand op 7))
4167 (setq op (logand op 248)))
4168 ((>= op byte-constant)
4169 (setq off (- op byte-constant)
4170 op byte-constant)))
4171 (setq op (aref byte-code-vector op))
4172 (insert (format "%-4d" i))
4173 (insert (symbol-name op))
4174 (if off (insert " [" (int-to-string off) "]"))
4175 (indent-to 40)
4176 (insert (int-to-string n) "\n")))
4177 (setq i (1+ i))))))
4179 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4180 ;; itself, compile some of its most used recursive functions (at load time).
4182 (eval-when-compile
4183 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4184 (assq 'byte-code (symbol-function 'byte-compile-form))
4185 (let ((byte-optimize nil) ; do it fast
4186 (byte-compile-warnings nil))
4187 (mapcar (lambda (x)
4188 (or noninteractive (message "compiling %s..." x))
4189 (byte-compile x)
4190 (or noninteractive (message "compiling %s...done" x)))
4191 '(byte-compile-normal-call
4192 byte-compile-form
4193 byte-compile-body
4194 ;; Inserted some more than necessary, to speed it up.
4195 byte-compile-top-level
4196 byte-compile-out-toplevel
4197 byte-compile-constant
4198 byte-compile-variable-ref))))
4199 nil)
4201 (run-hooks 'bytecomp-load-hook)
4203 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4204 ;;; bytecomp.el ends here