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