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