1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
11 ;;; This version incorporates changes up to version 2.10 of the
12 ;;; Zawinski-Furuseth compiler.
13 (defconst byte-compile-version
"$Revision: 2.95 $")
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)
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.
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.
41 ;; ========================================================================
43 ;; byte-recompile-directory, byte-compile-file,
44 ;; batch-byte-compile, batch-byte-recompile-directory,
45 ;; byte-compile, compile-defun,
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
55 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
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
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
108 ;; emacs-lisp-file-regexp Regexp for the extension of source-files;
109 ;; see also the function byte-compile-dest-file.
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
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
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
128 ;; (inline ;; `foo' and `baz' will be
129 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
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
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.
160 (or (fboundp 'defsubst
)
161 ;; This really ought to be loaded already!
162 (load-library "byte-run"))
164 ;; The feature of compiling in a specific target Emacs version
165 ;; has been turned off because compile time options are a bad idea.
166 (defmacro byte-compile-single-version
() nil
)
167 (defmacro byte-compile-version-cond
(cond) cond
)
169 ;; The crud you see scattered through this file of the form
170 ;; (or (and (boundp 'epoch::version) epoch::version)
171 ;; (string-lessp emacs-version "19"))
172 ;; is because the Epoch folks couldn't be bothered to follow the
173 ;; normal emacs version numbering convention.
175 ;; (if (byte-compile-version-cond
176 ;; (or (and (boundp 'epoch::version) epoch::version)
177 ;; (string-lessp emacs-version "19")))
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)))
196 (defgroup bytecomp nil
197 "Emacs Lisp byte-compiler"
200 (defcustom emacs-lisp-file-regexp
(if (eq system-type
'vax-vms
)
201 "\\.EL\\(;[0-9]+\\)?$"
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."
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
)))
216 (funcall handler
'byte-compiler-base-file-name 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
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."
253 (defcustom byte-compile-compatibility nil
254 "*Non-nil means generate output that can run in Emacs 18."
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."
272 :type
'(choice (const :tag
"none" nil
)
274 (const :tag
"source-level" source
)
275 (const :tag
"byte-level" byte
)))
277 (defcustom byte-compile-delete-errors t
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'."
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
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
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."
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."
319 :type
'(choice (const :tag
"none" nil
)
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'."
329 (defconst byte-compile-warning-types
330 '(redefine callargs free-vars unresolved obsolete noruntime
))
331 (defcustom byte-compile-warnings t
332 "*List of warnings that the byte-compiler should issue (t for all).
333 Elements of the list may be be:
335 free-vars references to variables not in the current lexical scope.
336 unresolved calls to unknown functions.
337 callargs lambda calls with args that don't match the definition.
338 redefine function cell redefined from a macro to a lambda or vice
339 versa, or redefined to take a different number of arguments.
340 obsolete obsolete variables and functions."
342 :type
'(choice (const :tag
"All" t
)
343 (set :menu-tag
"Some"
344 (const free-vars
) (const unresolved
)
345 (const callargs
) (const redefined
)
346 (const obsolete
) (const noruntime
))))
348 (defcustom byte-compile-generate-call-tree nil
349 "*Non-nil means collect call-graph information when compiling.
350 This records functions were called and from where.
351 If the value is t, compilation displays the call graph when it finishes.
352 If the value is neither t nor nil, compilation asks you whether to display
355 The call tree only lists functions called, not macros used. Those functions
356 which the byte-code interpreter knows about directly (eq, cons, etc.) are
359 The call tree also lists those functions which are not known to be called
360 \(that is, to which no calls have been compiled). Functions which can be
361 invoked interactively are excluded from this list."
363 :type
'(choice (const :tag
"Yes" t
) (const :tag
"No" nil
)
364 (other :tag
"Ask" lambda
)))
366 (defvar byte-compile-call-tree nil
"Alist of functions and their call tree.
367 Each element looks like
369 \(FUNCTION CALLERS CALLS\)
371 where CALLERS is a list of functions that call FUNCTION, and CALLS
372 is a list of functions for which calls were generated while compiling
375 (defcustom byte-compile-call-tree-sort
'name
376 "*If non-nil, sort the call tree.
377 The values `name', `callers', `calls', `calls+callers'
378 specify different fields to sort on."
380 :type
'(choice (const name
) (const callers
) (const calls
)
381 (const calls
+callers
) (const nil
)))
383 ;; (defvar byte-compile-overwrite-file t
384 ;; "If nil, old .elc files are deleted before the new is saved, and .elc
385 ;; files will have the same modes as the corresponding .el file. Otherwise,
386 ;; existing .elc files will simply be overwritten, and the existing modes
387 ;; will not be changed. If this variable is nil, then an .elc file which
388 ;; is a symbolic link will be turned into a normal file, instead of the file
389 ;; which the link points to being overwritten.")
391 (defvar byte-compile-constants nil
392 "List of all constants encountered during compilation of this form.")
393 (defvar byte-compile-variables nil
394 "List of all variables encountered during compilation of this form.")
395 (defvar byte-compile-bound-variables nil
396 "List of variables bound in the context of the current form.
397 This list lives partly on the stack.")
398 (defvar byte-compile-free-references
)
399 (defvar byte-compile-free-assignments
)
401 (defvar byte-compiler-error-flag
)
403 (defconst byte-compile-initial-macro-environment
405 ;; (byte-compiler-options . (lambda (&rest forms)
406 ;; (apply 'byte-compiler-options-handler forms)))
407 (eval-when-compile .
(lambda (&rest body
)
409 (byte-compile-eval (byte-compile-top-level
410 (cons 'progn body
))))))
411 (eval-and-compile .
(lambda (&rest body
)
412 (eval (cons 'progn body
))
413 (cons 'progn body
))))
414 "The default macro-environment passed to macroexpand by the compiler.
415 Placing a macro here will cause a macro to have different semantics when
416 expanded by the compiler as when expanded by the interpreter.")
418 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
419 "Alist of macros defined in the file being compiled.
420 Each element looks like (MACRONAME . DEFINITION). It is
421 \(MACRONAME . nil) when a macro is redefined as a function.")
423 (defvar byte-compile-function-environment nil
424 "Alist of functions defined in the file being compiled.
425 This is so we can inline them when necessary.
426 Each element looks like (FUNCTIONNAME . DEFINITION). It is
427 \(FUNCTIONNAME . nil) when a function is redefined as a macro.")
429 (defvar byte-compile-unresolved-functions nil
430 "Alist of undefined functions to which calls have been compiled.
431 Used for warnings when the function is not known to be defined or is later
432 defined with incorrect args.")
434 (defvar byte-compile-tag-number
0)
435 (defvar byte-compile-output nil
436 "Alist describing contents to put in byte code string.
437 Each element is (INDEX . VALUE)")
438 (defvar byte-compile-depth
0 "Current depth of execution stack.")
439 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
442 ;;; The byte codes; this information is duplicated in bytecomp.c
444 (defvar byte-code-vector nil
445 "An array containing byte-code names indexed by byte-code values.")
447 (defvar byte-stack
+-info nil
448 "An array with the stack adjustment for each byte-code.")
450 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
451 ;; This is a speed-hack for building the byte-code-vector at compile-time.
452 ;; We fill in the vector at macroexpand-time, and then after the last call
453 ;; to byte-defop, we write the vector out as a constant instead of writing
454 ;; out a bunch of calls to aset.
455 ;; Actually, we don't fill in the vector itself, because that could make
456 ;; it problematic to compile big changes to this compiler; we store the
457 ;; values on its plist, and remove them later in -extrude.
458 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
459 (put 'byte-code-vector
'tmp-compile-time-value
460 (make-vector 256 nil
))))
461 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
462 (put 'byte-stack
+-info
'tmp-compile-time-value
463 (make-vector 256 nil
)))))
464 (aset v1 opcode opname
)
465 (aset v2 opcode stack-adjust
))
467 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
468 (list 'defconst opname opcode
)))
470 (defmacro byte-extrude-byte-code-vectors
()
471 (prog1 (list 'setq
'byte-code-vector
472 (get 'byte-code-vector
'tmp-compile-time-value
)
474 (get 'byte-stack
+-info
'tmp-compile-time-value
))
475 (put 'byte-code-vector
'tmp-compile-time-value nil
)
476 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
481 ;; These opcodes are special in that they pack their argument into the
484 (byte-defop 8 1 byte-varref
"for variable reference")
485 (byte-defop 16 -
1 byte-varset
"for setting a variable")
486 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
487 (byte-defop 32 0 byte-call
"for calling a function")
488 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
489 ;; codes 8-47 are consumed by the preceding opcodes
493 (byte-defop 56 -
1 byte-nth
)
494 (byte-defop 57 0 byte-symbolp
)
495 (byte-defop 58 0 byte-consp
)
496 (byte-defop 59 0 byte-stringp
)
497 (byte-defop 60 0 byte-listp
)
498 (byte-defop 61 -
1 byte-eq
)
499 (byte-defop 62 -
1 byte-memq
)
500 (byte-defop 63 0 byte-not
)
501 (byte-defop 64 0 byte-car
)
502 (byte-defop 65 0 byte-cdr
)
503 (byte-defop 66 -
1 byte-cons
)
504 (byte-defop 67 0 byte-list1
)
505 (byte-defop 68 -
1 byte-list2
)
506 (byte-defop 69 -
2 byte-list3
)
507 (byte-defop 70 -
3 byte-list4
)
508 (byte-defop 71 0 byte-length
)
509 (byte-defop 72 -
1 byte-aref
)
510 (byte-defop 73 -
2 byte-aset
)
511 (byte-defop 74 0 byte-symbol-value
)
512 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
513 (byte-defop 76 -
1 byte-set
)
514 (byte-defop 77 -
1 byte-fset
) ; this was commented out
515 (byte-defop 78 -
1 byte-get
)
516 (byte-defop 79 -
2 byte-substring
)
517 (byte-defop 80 -
1 byte-concat2
)
518 (byte-defop 81 -
2 byte-concat3
)
519 (byte-defop 82 -
3 byte-concat4
)
520 (byte-defop 83 0 byte-sub1
)
521 (byte-defop 84 0 byte-add1
)
522 (byte-defop 85 -
1 byte-eqlsign
)
523 (byte-defop 86 -
1 byte-gtr
)
524 (byte-defop 87 -
1 byte-lss
)
525 (byte-defop 88 -
1 byte-leq
)
526 (byte-defop 89 -
1 byte-geq
)
527 (byte-defop 90 -
1 byte-diff
)
528 (byte-defop 91 0 byte-negate
)
529 (byte-defop 92 -
1 byte-plus
)
530 (byte-defop 93 -
1 byte-max
)
531 (byte-defop 94 -
1 byte-min
)
532 (byte-defop 95 -
1 byte-mult
) ; v19 only
533 (byte-defop 96 1 byte-point
)
534 (byte-defop 98 0 byte-goto-char
)
535 (byte-defop 99 0 byte-insert
)
536 (byte-defop 100 1 byte-point-max
)
537 (byte-defop 101 1 byte-point-min
)
538 (byte-defop 102 0 byte-char-after
)
539 (byte-defop 103 1 byte-following-char
)
540 (byte-defop 104 1 byte-preceding-char
)
541 (byte-defop 105 1 byte-current-column
)
542 (byte-defop 106 0 byte-indent-to
)
543 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
544 (byte-defop 108 1 byte-eolp
)
545 (byte-defop 109 1 byte-eobp
)
546 (byte-defop 110 1 byte-bolp
)
547 (byte-defop 111 1 byte-bobp
)
548 (byte-defop 112 1 byte-current-buffer
)
549 (byte-defop 113 0 byte-set-buffer
)
550 (byte-defop 114 0 byte-save-current-buffer
551 "To make a binding to record the current buffer")
552 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
553 (byte-defop 116 1 byte-interactive-p
)
555 ;; These ops are new to v19
556 (byte-defop 117 0 byte-forward-char
)
557 (byte-defop 118 0 byte-forward-word
)
558 (byte-defop 119 -
1 byte-skip-chars-forward
)
559 (byte-defop 120 -
1 byte-skip-chars-backward
)
560 (byte-defop 121 0 byte-forward-line
)
561 (byte-defop 122 0 byte-char-syntax
)
562 (byte-defop 123 -
1 byte-buffer-substring
)
563 (byte-defop 124 -
1 byte-delete-region
)
564 (byte-defop 125 -
1 byte-narrow-to-region
)
565 (byte-defop 126 1 byte-widen
)
566 (byte-defop 127 0 byte-end-of-line
)
570 ;; These store their argument in the next two bytes
571 (byte-defop 129 1 byte-constant2
572 "for reference to a constant with vector index >= byte-constant-limit")
573 (byte-defop 130 0 byte-goto
"for unconditional jump")
574 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
575 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
576 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
577 "to examine top-of-stack, jump and don't pop it if it's nil,
579 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
580 "to examine top-of-stack, jump and don't pop it if it's non nil,
583 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
584 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
585 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
587 (byte-defop 138 0 byte-save-excursion
588 "to make a binding to record the buffer, point and mark")
589 (byte-defop 139 0 byte-save-window-excursion
590 "to make a binding to record entire window configuration")
591 (byte-defop 140 0 byte-save-restriction
592 "to make a binding to record the current buffer clipping restrictions")
593 (byte-defop 141 -
1 byte-catch
594 "for catch. Takes, on stack, the tag and an expression for the body")
595 (byte-defop 142 -
1 byte-unwind-protect
596 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
598 ;; For condition-case. Takes, on stack, the variable to bind,
599 ;; an expression for the body, and a list of clauses.
600 (byte-defop 143 -
2 byte-condition-case
)
602 ;; For entry to with-output-to-temp-buffer.
603 ;; Takes, on stack, the buffer name.
604 ;; Binds standard-output and does some other things.
605 ;; Returns with temp buffer on the stack in place of buffer name.
606 (byte-defop 144 0 byte-temp-output-buffer-setup
)
608 ;; For exit from with-output-to-temp-buffer.
609 ;; Expects the temp buffer on the stack underneath value to return.
610 ;; Pops them both, then pushes the value back on.
611 ;; Unbinds standard-output and makes the temp buffer visible.
612 (byte-defop 145 -
1 byte-temp-output-buffer-show
)
614 ;; these ops are new to v19
616 ;; To unbind back to the beginning of this frame.
617 ;; Not used yet, but will be needed for tail-recursion elimination.
618 (byte-defop 146 0 byte-unbind-all
)
620 ;; these ops are new to v19
621 (byte-defop 147 -
2 byte-set-marker
)
622 (byte-defop 148 0 byte-match-beginning
)
623 (byte-defop 149 0 byte-match-end
)
624 (byte-defop 150 0 byte-upcase
)
625 (byte-defop 151 0 byte-downcase
)
626 (byte-defop 152 -
1 byte-string
=)
627 (byte-defop 153 -
1 byte-string
<)
628 (byte-defop 154 -
1 byte-equal
)
629 (byte-defop 155 -
1 byte-nthcdr
)
630 (byte-defop 156 -
1 byte-elt
)
631 (byte-defop 157 -
1 byte-member
)
632 (byte-defop 158 -
1 byte-assq
)
633 (byte-defop 159 0 byte-nreverse
)
634 (byte-defop 160 -
1 byte-setcar
)
635 (byte-defop 161 -
1 byte-setcdr
)
636 (byte-defop 162 0 byte-car-safe
)
637 (byte-defop 163 0 byte-cdr-safe
)
638 (byte-defop 164 -
1 byte-nconc
)
639 (byte-defop 165 -
1 byte-quo
)
640 (byte-defop 166 -
1 byte-rem
)
641 (byte-defop 167 0 byte-numberp
)
642 (byte-defop 168 0 byte-integerp
)
645 (byte-defop 175 nil byte-listN
)
646 (byte-defop 176 nil byte-concatN
)
647 (byte-defop 177 nil byte-insertN
)
651 (byte-defop 192 1 byte-constant
"for reference to a constant")
652 ;; codes 193-255 are consumed by byte-constant.
653 (defconst byte-constant-limit
64
654 "Exclusive maximum index usable in the `byte-constant' opcode.")
656 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
657 byte-goto-if-nil-else-pop
658 byte-goto-if-not-nil-else-pop
)
659 "List of byte-codes whose offset is a pc.")
661 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
663 (byte-extrude-byte-code-vectors)
665 ;;; lapcode generator
667 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
668 ;; source -> bytecode, because it's a lot easier to make optimizations
669 ;; on lapcode than on bytecode.
671 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
672 ;; where instruction is a symbol naming a byte-code instruction,
673 ;; and parameter is an argument to that instruction, if any.
675 ;; The instruction can be the pseudo-op TAG, which means that this position
676 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
677 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
678 ;; parameter for some goto op.
680 ;; If the operation is varbind, varref, varset or push-constant, then the
681 ;; parameter is (variable/constant . index_in_constant_vector).
683 ;; First, the source code is macroexpanded and optimized in various ways.
684 ;; Then the resultant code is compiled into lapcode. Another set of
685 ;; optimizations are then run over the lapcode. Then the variables and
686 ;; constants referenced by the lapcode are collected and placed in the
687 ;; constants-vector. (This happens now so that variables referenced by dead
688 ;; code don't consume space.) And finally, the lapcode is transformed into
689 ;; compacted byte-code.
691 ;; A distinction is made between variables and constants because the variable-
692 ;; referencing instructions are more sensitive to the variables being near the
693 ;; front of the constants-vector than the constant-referencing instructions.
694 ;; Also, this lets us notice references to free variables.
696 (defun byte-compile-lapcode (lap)
697 "Turns lapcode into bytecode. The lapcode is destroyed."
698 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
699 (let ((pc 0) ; Program counter
700 op off
; Operation & offset
701 (bytes '()) ; Put the output bytes here
702 (patchlist nil
) ; List of tags and goto's to patch
705 (setq op
(car (car lap
))
707 (cond ((not (symbolp op
))
708 (error "Non-symbolic opcode `%s'" op
))
711 (setq patchlist
(cons off patchlist
)))
712 ((memq op byte-goto-ops
)
714 (setq bytes
(cons (cons pc
(cdr off
))
716 (cons (symbol-value op
) bytes
))))
717 (setq patchlist
(cons bytes patchlist
)))
720 (cond ((cond ((consp off
)
721 ;; Variable or constant reference
723 (eq op
'byte-constant
)))
724 (cond ((< off byte-constant-limit
)
726 (cons (+ byte-constant off
) bytes
))
730 (cons (logand off
255)
731 (cons byte-constant2 bytes
))))))
732 ((<= byte-listN
(symbol-value op
))
734 (cons off
(cons (symbol-value op
) bytes
)))
737 (cons (+ (symbol-value op
) off
) bytes
))
740 (cons off
(cons (+ (symbol-value op
) 6) bytes
)))
744 (cons (logand off
255)
745 (cons (+ (symbol-value op
) 7)
747 (setq lap
(cdr lap
)))
748 ;;(if (not (= pc (length bytes)))
749 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
750 ;; Patch PC into jumps
753 (setq bytes
(car patchlist
))
754 (cond ((atom (car bytes
))) ; Tag
756 (setq pc
(car (cdr (car bytes
)))) ; Pick PC from tag
757 (setcar (cdr bytes
) (logand pc
255))
758 (setcar bytes
(lsh pc -
8))))
759 (setq patchlist
(cdr patchlist
))))
760 (concat (nreverse bytes
))))
763 ;;; compile-time evaluation
765 (defun byte-compile-eval (form)
766 "Eval FORM and mark the functions defined therein.
767 Each function's symbol gets marked with the `byte-compile-noruntime' property."
768 (let ((hist-orig load-history
)
769 (hist-nil-orig current-load-list
))
771 (when (memq 'noruntime byte-compile-warnings
)
772 (let ((hist-new load-history
)
773 (hist-nil-new current-load-list
))
774 ;; Go through load-history, look for newly loaded files
775 ;; and mark all the functions defined therein.
776 (while (and hist-new
(not (eq hist-new hist-orig
)))
777 (let ((xs (pop hist-new
)))
778 ;; Make sure the file was not already loaded before.
779 (unless (assoc (car xs
) hist-orig
)
782 ((symbolp s
) (put s
'byte-compile-noruntime t
))
783 ((and (consp s
) (eq 'autoload
(car s
)))
784 (put (cdr s
) 'byte-compile-noruntime t
)))))))
785 ;; Go through current-load-list for the locally defined funs.
786 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
787 (let ((s (pop hist-nil-new
)))
789 (put s
'byte-compile-noruntime t
)))))))))
792 ;;; byte compiler messages
794 (defvar byte-compile-current-form nil
)
795 (defvar byte-compile-dest-file nil
)
796 (defvar byte-compile-current-file nil
)
798 (defmacro byte-compile-log
(format-string &rest args
)
801 '(memq byte-optimize-log
'(t source
))
802 (list 'let
'((print-escape-newlines t
)
805 (list 'byte-compile-log-1
810 (if (symbolp x
) (list 'prin1-to-string x
) x
))
813 (defvar byte-compile-last-warned-form nil
)
814 (defvar byte-compile-last-logged-file nil
)
816 (defvar byte-compile-last-line nil
817 "Last known line number in the input.")
820 (defun byte-compile-display-log-head-p ()
821 (and (not (eq byte-compile-current-form
:end
))
822 (or (and byte-compile-current-file
823 (not (equal byte-compile-current-file
824 byte-compile-last-logged-file
)))
825 (and byte-compile-last-warned-form
826 (not (eq byte-compile-current-form
827 byte-compile-last-warned-form
))))))
829 (defun byte-goto-log-buffer ()
830 (set-buffer (get-buffer-create "*Compile-Log*"))
831 (unless (eq major-mode
'compilation-mode
)
834 ;; Log a message STRING in *Compile-Log*.
835 ;; Also log the current function and file if not already done.
836 (defun byte-compile-log-1 (string &optional fill
)
837 (let* ((file (cond ((stringp byte-compile-current-file
)
838 (format "%s:" byte-compile-current-file
))
839 ((bufferp byte-compile-current-file
)
841 (buffer-name byte-compile-current-file
)))
843 (pos (if (and byte-compile-current-file
844 (integerp byte-compile-last-line
))
845 (format "%d:" byte-compile-last-line
)
847 (form (or byte-compile-current-form
"toplevel form")))
848 (cond (noninteractive
849 (when (byte-compile-display-log-head-p)
850 (message "%s In %s" file form
))
851 (message "%s%s %s" file pos string
))
854 (byte-goto-log-buffer)
855 (goto-char (point-max))
856 (when (byte-compile-display-log-head-p)
857 (insert (format "\nIn %s" form
)))
858 (insert (format "\n%s%s\n%s\n" file pos string
))
859 (when (and fill
(not (string-match "\n" string
)))
860 (let ((fill-prefix " ") (fill-column 78))
861 (fill-paragraph nil
)))))))
862 (setq byte-compile-last-logged-file byte-compile-current-file
863 byte-compile-last-warned-form byte-compile-current-form
))
865 ;; Log the start of a file in *Compile-Log*, and mark it as done.
866 ;; But do nothing in batch mode.
867 (defun byte-compile-log-file ()
868 (and byte-compile-current-file
869 (not (equal byte-compile-current-file byte-compile-last-logged-file
))
872 (byte-goto-log-buffer)
873 (goto-char (point-max))
874 (insert "\n\^L\nCompiling "
875 (if (stringp byte-compile-current-file
)
876 (concat "file " byte-compile-current-file
)
877 (concat "buffer " (buffer-name byte-compile-current-file
)))
878 " at " (current-time-string) "\n")
879 (setq byte-compile-last-logged-file byte-compile-current-file
))))
881 (defun byte-compile-warn (format &rest args
)
882 (setq format
(apply 'format format args
))
883 (if byte-compile-error-on-warn
884 (error "%s" format
) ; byte-compile-file catches and logs it
885 (byte-compile-log-1 (concat "warning: " format
) t
)
886 ;; It is useless to flash warnings too fast to be read.
887 ;; Besides, they will all be shown at the end.
888 ;; (or noninteractive ; already written on stdout.
889 ;; (message "Warning: %s" format))
892 ;;; This function should be used to report errors that have halted
893 ;;; compilation of the current file.
894 (defun byte-compile-report-error (error-info)
895 (setq byte-compiler-error-flag t
)
898 (format (if (cdr error-info
) "%s (%s)" "%s")
899 (downcase (get (car error-info
) 'error-message
))
900 (prin1-to-string (cdr error-info
))))))
902 ;;; Used by make-obsolete.
903 (defun byte-compile-obsolete (form)
904 (let* ((new (get (car form
) 'byte-obsolete-info
))
905 (handler (nth 1 new
))
907 (if (memq 'obsolete byte-compile-warnings
)
908 (byte-compile-warn "%s is an obsolete function%s; %s" (car form
)
909 (if when
(concat " since " when
) "")
910 (if (stringp (car new
))
912 (format "use %s instead." (car new
)))))
913 (funcall (or handler
'byte-compile-normal-call
) form
)))
917 ;; (defvar byte-compiler-valid-options
918 ;; '((optimize byte-optimize (t nil source byte) val)
919 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
920 ;; (eq val 'emacs18))
921 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
922 ;; (delete-errors byte-compile-delete-errors (t nil) val)
923 ;; (verbose byte-compile-verbose (t nil) val)
924 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
927 ;; Inhibit v18/v19 selectors if the version is hardcoded.
928 ;; #### This should print a warning if the user tries to change something
929 ;; than can't be changed because the running compiler doesn't support it.
931 ;; ((byte-compile-single-version)
932 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
933 ;; (list (byte-compile-version-cond
934 ;; byte-compile-generate-emacs19-bytecodes)))
935 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
936 ;; (if (byte-compile-version-cond byte-compile-compatibility)
937 ;; '(emacs18) '(emacs19)))))
939 ;; (defun byte-compiler-options-handler (&rest args)
940 ;; (let (key val desc choices)
942 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
943 ;; (error "Malformed byte-compiler option `%s'" (car args)))
944 ;; (setq key (car (car args))
945 ;; val (car (cdr (car args)))
946 ;; desc (assq key byte-compiler-valid-options))
948 ;; (error "Unknown byte-compiler option `%s'" key))
949 ;; (setq choices (nth 2 desc))
950 ;; (if (consp (car choices))
953 ;; (ret (and (memq (car val) '(+ -))
954 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
956 ;; (symbol-value (nth 1 desc)))))))
957 ;; (setq choices (car choices))
959 ;; (setq this (car val))
960 ;; (cond ((memq this choices)
961 ;; (setq ret (funcall handler this ret)))
962 ;; ((eq this '+) (setq handler 'cons))
963 ;; ((eq this '-) (setq handler 'delq))
964 ;; ((error "`%s' only accepts %s" key choices)))
965 ;; (setq val (cdr val)))
966 ;; (set (nth 1 desc) ret))
967 ;; (or (memq val choices)
968 ;; (error "`%s' must be one of `%s'" key choices))
969 ;; (set (nth 1 desc) (eval (nth 3 desc))))
970 ;; (setq args (cdr args)))
973 ;;; sanity-checking arglists
975 (defun byte-compile-fdefinition (name macro-p
)
976 (let* ((list (if macro-p
977 byte-compile-macro-environment
978 byte-compile-function-environment
))
979 (env (cdr (assq name list
))))
982 (while (and (symbolp fn
)
984 (or (symbolp (symbol-function fn
))
985 (consp (symbol-function fn
))
987 (byte-code-function-p (symbol-function fn
)))))
988 (setq fn
(symbol-function fn
)))
989 (if (and (not macro-p
) (byte-code-function-p fn
))
992 (if (eq 'macro
(car fn
))
996 (if (eq 'autoload
(car fn
))
1000 (defun byte-compile-arglist-signature (arglist)
1005 (cond ((eq (car arglist
) '&optional
)
1006 (or opts
(setq opts
0)))
1007 ((eq (car arglist
) '&rest
)
1013 (setq opts
(1+ opts
))
1014 (setq args
(1+ args
)))))
1015 (setq arglist
(cdr arglist
)))
1016 (cons args
(if restp nil
(if opts
(+ args opts
) args
)))))
1019 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1021 (> (car new
) (car old
)) ; requires more args now
1022 (and (null (cdr old
)) ; took rest-args, doesn't any more
1024 (and (cdr new
) (cdr old
) ; can't take as many args now
1025 (< (cdr new
) (cdr old
)))
1028 (defun byte-compile-arglist-signature-string (signature)
1029 (cond ((null (cdr signature
))
1030 (format "%d+" (car signature
)))
1031 ((= (car signature
) (cdr signature
))
1032 (format "%d" (car signature
)))
1033 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1036 ;; Warn if the form is calling a function with the wrong number of arguments.
1037 (defun byte-compile-callargs-warn (form)
1038 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1039 (byte-compile-fdefinition (car form
) t
)))
1041 (byte-compile-arglist-signature
1042 (if (eq 'lambda
(car-safe def
))
1044 (if (byte-code-function-p def
)
1047 (if (and (fboundp (car form
))
1048 (subrp (symbol-function (car form
))))
1049 (subr-arity (symbol-function (car form
))))))
1050 (ncall (length (cdr form
))))
1051 ;; Check many or unevalled from subr-arity.
1052 (if (and (cdr-safe sig
)
1053 (not (numberp (cdr sig
))))
1056 (if (or (< ncall
(car sig
))
1057 (and (cdr sig
) (> ncall
(cdr sig
))))
1059 "%s called with %d argument%s, but %s %s"
1061 (if (= 1 ncall
) "" "s")
1062 (if (< ncall
(car sig
))
1065 (byte-compile-arglist-signature-string sig
)))
1066 (or (and (fboundp (car form
)) ; might be a subr or autoload.
1067 (not (get (car form
) 'byte-compile-noruntime
)))
1068 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1070 ;; It's a currently-undefined function.
1071 ;; Remember number of args in call.
1072 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1073 (n (length (cdr form
))))
1075 (or (memq n
(cdr cons
))
1076 (setcdr cons
(cons n
(cdr cons
))))
1077 (setq byte-compile-unresolved-functions
1078 (cons (list (car form
) n
)
1079 byte-compile-unresolved-functions
))))))))
1081 ;; Warn if the function or macro is being redefined with a different
1082 ;; number of arguments.
1083 (defun byte-compile-arglist-warn (form macrop
)
1084 (let ((old (byte-compile-fdefinition (nth 1 form
) macrop
)))
1086 (let ((sig1 (byte-compile-arglist-signature
1087 (if (eq 'lambda
(car-safe old
))
1089 (if (byte-code-function-p old
)
1092 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1093 (or (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1094 (byte-compile-warn "%s %s used to take %s %s, now takes %s"
1095 (if (eq (car form
) 'defun
) "function" "macro")
1097 (byte-compile-arglist-signature-string sig1
)
1098 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1099 (byte-compile-arglist-signature-string sig2
))))
1100 ;; This is the first definition. See if previous calls are compatible.
1101 (let ((calls (assq (nth 1 form
) byte-compile-unresolved-functions
))
1105 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1106 nums
(sort (copy-sequence (cdr calls
)) (function <))
1108 max
(car (nreverse nums
)))
1109 (if (or (< min
(car sig
))
1110 (and (cdr sig
) (> max
(cdr sig
))))
1112 "%s being defined to take %s%s, but was previously called with %s"
1114 (byte-compile-arglist-signature-string sig
)
1115 (if (equal sig
'(1 .
1)) " arg" " args")
1116 (byte-compile-arglist-signature-string (cons min max
))))
1118 (setq byte-compile-unresolved-functions
1119 (delq calls byte-compile-unresolved-functions
)))))
1122 (defun byte-compile-print-syms (str1 strn syms
)
1123 (cond ((and (cdr syms
) (not noninteractive
))
1128 (setq s
(symbol-name (pop syms
))
1129 L
(+ L
(length s
) 2))
1130 (if (< L
(1- fill-column
))
1131 (setq str
(concat str
" " s
(and syms
",")))
1132 (setq str
(concat str
"\n " s
(and syms
","))
1133 L
(+ (length s
) 4))))
1134 (byte-compile-warn "%s" str
)))
1136 (byte-compile-warn "%s %s"
1138 (mapconcat #'symbol-name syms
", ")))
1141 (byte-compile-warn str1
(car syms
)))))
1143 ;; If we have compiled any calls to functions which are not known to be
1144 ;; defined, issue a warning enumerating them.
1145 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1146 (defun byte-compile-warn-about-unresolved-functions ()
1147 (when (memq 'unresolved byte-compile-warnings
)
1148 (let ((byte-compile-current-form :end
)
1151 ;; Separate the functions that will not be available at runtime
1152 ;; from the truly unresolved ones.
1153 (dolist (f byte-compile-unresolved-functions
)
1155 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1156 ;; Complain about the no-run-time functions
1157 (byte-compile-print-syms
1158 "the function `%s' might not be defined at runtime."
1159 "the following functions might not be defined at runtime:"
1161 ;; Complain about the unresolved functions
1162 (byte-compile-print-syms
1163 "the function `%s' is not known to be defined."
1164 "the following functions are not known to be defined:"
1169 (defsubst byte-compile-const-symbol-p
(symbol)
1170 (or (memq symbol
'(nil t
))
1173 (defmacro byte-compile-constp
(form)
1174 "Return non-nil if FORM is a constant."
1175 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1176 ((not (symbolp ,form
)))
1177 ((byte-compile-const-symbol-p ,form
))))
1179 (defmacro byte-compile-close-variables
(&rest body
)
1182 ;; Close over these variables to encapsulate the
1183 ;; compilation state
1185 (byte-compile-macro-environment
1186 ;; Copy it because the compiler may patch into the
1187 ;; macroenvironment.
1188 (copy-alist byte-compile-initial-macro-environment
))
1189 (byte-compile-function-environment nil
)
1190 (byte-compile-bound-variables nil
)
1191 (byte-compile-free-references nil
)
1192 (byte-compile-free-assignments nil
)
1194 ;; Close over these variables so that `byte-compiler-options'
1195 ;; can change them on a per-file basis.
1197 (byte-compile-verbose byte-compile-verbose
)
1198 (byte-optimize byte-optimize
)
1199 (byte-compile-compatibility byte-compile-compatibility
)
1200 (byte-compile-dynamic byte-compile-dynamic
)
1201 (byte-compile-dynamic-docstrings
1202 byte-compile-dynamic-docstrings
)
1203 ;; (byte-compile-generate-emacs19-bytecodes
1204 ;; byte-compile-generate-emacs19-bytecodes)
1205 (byte-compile-warnings (if (eq byte-compile-warnings t
)
1206 byte-compile-warning-types
1207 byte-compile-warnings
))
1211 (defvar byte-compile-warnings-point-max nil
)
1212 (defmacro displaying-byte-compile-warnings
(&rest body
)
1213 `(let ((byte-compile-warnings-point-max byte-compile-warnings-point-max
))
1214 ;; Log the file name.
1215 (byte-compile-log-file)
1216 ;; Record how much is logged now.
1217 ;; We will display the log buffer if anything more is logged
1218 ;; before the end of BODY.
1219 (unless byte-compile-warnings-point-max
1221 (byte-goto-log-buffer)
1222 (setq byte-compile-warnings-point-max
(point-max))))
1224 (condition-case error-info
1226 (error (byte-compile-report-error error-info
)))
1227 (with-current-buffer "*Compile-Log*"
1228 ;; If there were compilation warnings, display them.
1229 (unless (= byte-compile-warnings-point-max
(point-max))
1231 (prog1 (selected-window)
1232 (select-window (display-buffer (current-buffer)))
1233 (goto-char byte-compile-warnings-point-max
)
1240 (defun byte-force-recompile (directory)
1241 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1242 Files in subdirectories of DIRECTORY are processed also."
1243 (interactive "DByte force recompile (directory): ")
1244 (byte-recompile-directory directory nil t
))
1247 (defun byte-recompile-directory (directory &optional arg force
)
1248 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1249 This is if a `.elc' file exists but is older than the `.el' file.
1250 Files in subdirectories of DIRECTORY are processed also.
1252 If the `.elc' file does not exist, normally the `.el' file is *not* compiled.
1253 But a prefix argument (optional second arg) means ask user,
1254 for each such `.el' file, whether to compile it. Prefix argument 0 means
1255 don't ask and compile the file anyway.
1257 A nonzero prefix argument also means ask about each subdirectory.
1259 If the third argument FORCE is non-nil,
1260 recompile every `.el' file that already has a `.elc' file."
1261 (interactive "DByte recompile directory: \nP")
1263 (setq arg
(prefix-numeric-value arg
)))
1267 (force-mode-line-update))
1268 (let ((directories (list (expand-file-name directory
)))
1274 (displaying-byte-compile-warnings
1276 (setq directory
(car directories
))
1277 (message "Checking %s..." directory
)
1278 (let ((files (directory-files directory
))
1280 (dolist (file files
)
1281 (setq source
(expand-file-name file directory
))
1282 (if (and (not (member file
'("." ".." "RCS" "CVS")))
1283 (file-directory-p source
)
1284 (not (file-symlink-p source
)))
1285 ;; This file is a subdirectory. Handle them differently.
1286 (when (or (null arg
)
1288 (y-or-n-p (concat "Check " source
"? ")))
1290 (nconc directories
(list source
))))
1291 ;; It is an ordinary file. Decide whether to compile it.
1292 (if (and (string-match emacs-lisp-file-regexp source
)
1293 (file-readable-p source
)
1294 (not (auto-save-file-name-p source
))
1295 (setq dest
(byte-compile-dest-file source
))
1296 (if (file-exists-p dest
)
1297 ;; File was already compiled.
1298 (or force
(file-newer-than-file-p source dest
))
1299 ;; No compiled file exists yet.
1302 (y-or-n-p (concat "Compile " source
"? "))))))
1303 (progn (if (and noninteractive
(not byte-compile-verbose
))
1304 (message "Compiling %s..." source
))
1305 (let ((res (byte-compile-file source
)))
1306 (cond ((eq res
'no-byte-compile
)
1307 (setq skip-count
(1+ skip-count
)))
1309 (setq file-count
(1+ file-count
)))
1311 (setq fail-count
(1+ fail-count
)))))
1313 (message "Checking %s..." directory
))
1314 (if (not (eq last-dir directory
))
1315 (setq last-dir directory
1316 dir-count
(1+ dir-count
)))
1318 (setq directories
(cdr directories
))))
1319 (message "Done (Total of %d file%s compiled%s%s%s)"
1320 file-count
(if (= file-count
1) "" "s")
1321 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1322 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1323 (if (> dir-count
1) (format " in %d directories" dir-count
) ""))))
1325 (defvar no-byte-compile nil
1326 "Non-nil to prevent byte-compiling of emacs-lisp code.
1327 This is normally set in local file variables at the end of the elisp file:
1329 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1332 (defun byte-compile-file (filename &optional load
)
1333 "Compile a file of Lisp code named FILENAME into a file of byte code.
1334 The output file's name is made by appending `c' to the end of FILENAME.
1335 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1336 The value is non-nil if there were no errors, nil if errors."
1337 ;; (interactive "fByte compile file: \nP")
1339 (let ((file buffer-file-name
)
1343 (eq (cdr (assq 'major-mode
(buffer-local-variables)))
1345 (setq file-name
(file-name-nondirectory file
)
1346 file-dir
(file-name-directory file
)))
1347 (list (read-file-name (if current-prefix-arg
1348 "Byte compile and load file: "
1349 "Byte compile file: ")
1350 file-dir file-name nil
)
1351 current-prefix-arg
)))
1352 ;; Expand now so we get the current buffer's defaults
1353 (setq filename
(expand-file-name filename
))
1355 ;; If we're compiling a file that's in a buffer and is modified, offer
1356 ;; to save it first.
1358 (let ((b (get-file-buffer (expand-file-name filename
))))
1359 (if (and b
(buffer-modified-p b
)
1360 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1361 (save-excursion (set-buffer b
) (save-buffer)))))
1363 (let ((byte-compile-current-file filename
)
1364 (byte-compile-last-logged-file nil
)
1365 (set-auto-coding-for-load t
)
1366 target-file input-buffer output-buffer
1367 byte-compile-dest-file
)
1368 (setq target-file
(byte-compile-dest-file filename
))
1369 (setq byte-compile-dest-file target-file
)
1371 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1372 (set-buffer input-buffer
)
1374 (setq buffer-file-coding-system nil
)
1375 ;; Always compile an Emacs Lisp file as multibyte
1376 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1377 (set-buffer-multibyte t
)
1378 (insert-file-contents filename
)
1379 ;; Mimic the way after-insert-file-set-buffer-file-coding-system
1380 ;; can make the buffer unibyte when visiting this file.
1381 (when (or (eq last-coding-system-used
'no-conversion
)
1382 (eq (coding-system-type last-coding-system-used
) 5))
1383 ;; For coding systems no-conversion and raw-text...,
1384 ;; edit the buffer as unibyte.
1385 (set-buffer-multibyte nil
))
1386 ;; Run hooks including the uncompression hook.
1387 ;; If they change the file name, then change it for the output also.
1388 (let ((buffer-file-name filename
)
1389 (default-major-mode 'emacs-lisp-mode
)
1390 (enable-local-eval nil
))
1392 (setq filename buffer-file-name
))
1393 ;; Set the default directory, in case an eval-when-compile uses it.
1394 (setq default-directory
(file-name-directory filename
)))
1395 ;; Check if the file's local variables explicitly specify not to
1396 ;; compile this file.
1397 (if (with-current-buffer input-buffer no-byte-compile
)
1399 (message "%s not compiled because of `no-byte-compile: %s'"
1400 (file-relative-name filename
)
1401 (with-current-buffer input-buffer no-byte-compile
))
1402 (if (file-exists-p target-file
)
1403 (condition-case nil
(delete-file target-file
) (error nil
)))
1404 ;; We successfully didn't compile this file.
1406 (if byte-compile-verbose
1407 (message "Compiling %s..." filename
))
1408 (setq byte-compiler-error-flag nil
)
1409 ;; It is important that input-buffer not be current at this call,
1410 ;; so that the value of point set in input-buffer
1411 ;; within byte-compile-from-buffer lingers in that buffer.
1412 (setq output-buffer
(byte-compile-from-buffer input-buffer filename
))
1413 (if byte-compiler-error-flag
1415 (if byte-compile-verbose
1416 (message "Compiling %s...done" filename
))
1417 (kill-buffer input-buffer
)
1418 (with-current-buffer output-buffer
1419 (goto-char (point-max))
1420 (insert "\n") ; aaah, unix.
1421 (let ((vms-stmlf-recfm t
))
1422 (if (file-writable-p target-file
)
1423 ;; We must disable any code conversion here.
1424 (let ((coding-system-for-write 'no-conversion
))
1425 (if (memq system-type
'(ms-dos 'windows-nt
))
1426 (setq buffer-file-type t
))
1427 (when (file-exists-p target-file
)
1428 ;; Remove the target before writing it, so that any
1429 ;; hard-links continue to point to the old file (this makes
1430 ;; it possible for installed files to share disk space with
1431 ;; the build tree, without causing problems when emacs-lisp
1432 ;; files in the build tree are recompiled).
1433 (delete-file target-file
))
1434 (write-region 1 (point-max) target-file
))
1435 ;; This is just to give a better error message than write-region
1437 (list "Opening output file"
1438 (if (file-exists-p target-file
)
1439 "cannot overwrite file"
1440 "directory not writable or nonexistent")
1442 (kill-buffer (current-buffer)))
1443 (if (and byte-compile-generate-call-tree
1444 (or (eq t byte-compile-generate-call-tree
)
1445 (y-or-n-p (format "Report call tree for %s? " filename
))))
1447 (display-call-tree filename
)))
1452 ;;(defun byte-compile-and-load-file (&optional filename)
1453 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1454 ;;and then load it. The output file's name is made by appending \"c\" to
1455 ;;the end of FILENAME."
1457 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1458 ;; (byte-compile-file filename t)
1459 ;; (let ((current-prefix-arg '(4)))
1460 ;; (call-interactively 'byte-compile-file))))
1462 ;;(defun byte-compile-buffer (&optional buffer)
1463 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1464 ;; (interactive "bByte compile buffer: ")
1465 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1466 ;; (message "Compiling %s..." (buffer-name buffer))
1467 ;; (let* ((filename (or (buffer-file-name buffer)
1468 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1469 ;; (byte-compile-current-file buffer))
1470 ;; (byte-compile-from-buffer buffer nil))
1471 ;; (message "Compiling %s...done" (buffer-name buffer))
1474 ;;; compiling a single function
1476 (defun compile-defun (&optional arg
)
1477 "Compile and evaluate the current top-level form.
1478 Print the result in the minibuffer.
1479 With argument, insert value in current buffer after the form."
1483 (beginning-of-defun)
1484 (let* ((byte-compile-current-file nil
)
1485 (byte-compile-last-warned-form 'nothing
)
1486 (value (eval (displaying-byte-compile-warnings
1487 (byte-compile-sexp (read (current-buffer)))))))
1489 (message "Compiling from buffer... done.")
1490 (prin1 value
(current-buffer))
1492 ((message "%s" (prin1-to-string value
)))))))
1495 (defun byte-compile-from-buffer (inbuffer &optional filename
)
1496 ;; Filename is used for the loading-into-Emacs-18 error message.
1498 ;; Prevent truncation of flonums and lists as we read and print them
1499 (float-output-format nil
)
1500 (case-fold-search nil
)
1503 ;; Prevent edebug from interfering when we compile
1504 ;; and put the output into a file.
1505 (edebug-all-defs nil
)
1506 (edebug-all-forms nil
)
1507 ;; Simulate entry to byte-compile-top-level
1508 (byte-compile-constants nil
)
1509 (byte-compile-variables nil
)
1510 (byte-compile-tag-number 0)
1511 (byte-compile-depth 0)
1512 (byte-compile-maxdepth 0)
1513 (byte-compile-output nil
)
1514 ;; #### This is bound in b-c-close-variables.
1515 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1516 ;; byte-compile-warning-types
1517 ;; byte-compile-warnings))
1519 (byte-compile-close-variables
1522 (set-buffer (get-buffer-create " *Compiler Output*")))
1523 (set-buffer-multibyte t
)
1525 ;; (emacs-lisp-mode)
1526 (setq case-fold-search nil
)
1527 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1528 ;; write files containing binary information specially.
1529 ;; Under most circumstances, such files will be in binary
1530 ;; overwrite mode, so those OS's use that flag to guess how
1531 ;; they should write their data. Advise them that .elc files
1532 ;; need to be written carefully.
1533 (setq overwrite-mode
'overwrite-mode-binary
))
1534 (displaying-byte-compile-warnings
1535 (and filename
(byte-compile-insert-header filename inbuffer outbuffer
))
1537 (set-buffer inbuffer
)
1540 ;; Compile the forms from the input buffer.
1542 (while (progn (skip-chars-forward " \t\n\^l")
1546 (let ((byte-compile-last-line (count-lines (point-min) (point))))
1547 (byte-compile-file-form (read inbuffer
))))
1549 ;; Compile pending forms at end of file.
1550 (byte-compile-flush-pending)
1551 (byte-compile-warn-about-unresolved-functions)
1552 ;; Should we always do this? When calling multiple files, it
1553 ;; would be useful to delay this warning until all have
1555 (setq byte-compile-unresolved-functions nil
))
1556 ;; Fix up the header at the front of the output
1557 ;; if the buffer contains multibyte characters.
1558 (and filename
(byte-compile-fix-header filename inbuffer outbuffer
))))
1561 (defun byte-compile-fix-header (filename inbuffer outbuffer
)
1563 (set-buffer outbuffer
)
1564 ;; See if the buffer has any multibyte characters.
1565 (when (< (point-max) (position-bytes (point-max)))
1566 (when (byte-compile-version-cond byte-compile-compatibility
)
1567 (error "Version-18 compatibility not valid with multibyte characters"))
1568 (goto-char (point-min))
1569 ;; Find the comment that describes the version test.
1570 (search-forward "\n;;; This file")
1572 (narrow-to-region (point) (point-max))
1573 ;; Find the line of ballast semicolons.
1574 (search-forward ";;;;;;;;;;")
1577 (narrow-to-region (point-min) (point))
1578 (let ((old-header-end (point))
1580 (goto-char (point-min))
1581 (delete-region (point) (progn (re-search-forward "^(")
1584 (insert ";;; This file contains multibyte non-ASCII characters\n"
1585 ";;; and therefore cannot be loaded into Emacs 19.\n")
1586 ;; Replace "19" or "19.29" with "20", twice.
1587 (re-search-forward "19\\(\\.[0-9]+\\)")
1588 (replace-match "20")
1589 (re-search-forward "19\\(\\.[0-9]+\\)")
1590 (replace-match "20")
1591 ;; Now compensate for the change in size,
1592 ;; to make sure all positions in the file remain valid.
1593 (setq delta
(- (point-max) old-header-end
))
1594 (goto-char (point-max))
1596 (delete-char delta
)))))
1598 (defun byte-compile-insert-header (filename inbuffer outbuffer
)
1599 (set-buffer inbuffer
)
1600 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
1601 (dynamic byte-compile-dynamic
))
1602 (set-buffer outbuffer
)
1604 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1605 ;; that is the file-format version number (18, 19 or 20) as a
1606 ;; byte, followed by some nulls. The primary motivation for doing
1607 ;; this is to get some binary characters up in the first line of
1608 ;; the file so that `diff' will simply say "Binary files differ"
1609 ;; instead of actually doing a diff of two .elc files. An extra
1610 ;; benefit is that you can add this to /etc/magic:
1612 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1613 ;; >4 byte x version %d
1617 (if (byte-compile-version-cond byte-compile-compatibility
) 18 20)
1620 (insert ";;; Compiled by "
1621 (or (and (boundp 'user-mail-address
) user-mail-address
)
1622 (concat (user-login-name) "@" (system-name)))
1624 (current-time-string) "\n;;; from file " filename
"\n")
1625 (insert ";;; in Emacs version " emacs-version
"\n")
1626 (insert ";;; with bytecomp version "
1627 (progn (string-match "[0-9.]+" byte-compile-version
)
1628 (match-string 0 byte-compile-version
))
1631 ((eq byte-optimize
'source
) "with source-level optimization only")
1632 ((eq byte-optimize
'byte
) "with byte-level optimization only")
1633 (byte-optimize "with all optimizations")
1634 (t "without optimization"))
1635 (if (byte-compile-version-cond byte-compile-compatibility
)
1636 "; compiled with Emacs 18 compatibility.\n"
1639 (insert ";;; Function definitions are lazy-loaded.\n"))
1640 (if (not (byte-compile-version-cond byte-compile-compatibility
))
1641 (let (intro-string minimum-version
)
1642 ;; Figure out which Emacs version to require,
1643 ;; and what comment to use to explain why.
1644 ;; Note that this fails to take account of whether
1645 ;; the buffer contains multibyte characters. We may have to
1646 ;; compensate at the end in byte-compile-fix-header.
1647 (if dynamic-docstrings
1649 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1650 minimum-version
"19.29")
1652 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1653 minimum-version
"19"))
1654 ;; Now insert the comment and the error check.
1658 ;; Have to check if emacs-version is bound so that this works
1659 ;; in files loaded early in loadup.el.
1660 "(if (and (boundp 'emacs-version)\n"
1661 ;; If there is a name at the end of emacs-version,
1662 ;; don't try to check the version number.
1663 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1664 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1665 (format "\t (string-lessp emacs-version \"%s\")))\n"
1668 ;; prin1-to-string is used to quote backslashes.
1669 (substring (prin1-to-string (file-name-nondirectory filename
))
1671 (format "' was compiled for Emacs %s or later\"))\n\n"
1673 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1674 ;; can delete them so as to keep the buffer positions
1675 ;; constant for the actual compiled code.
1676 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1677 ;; Here if we want Emacs 18 compatibility.
1678 (when dynamic-docstrings
1679 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1680 (when byte-compile-dynamic
1681 (error "Version-18 compatibility doesn't support dynamic byte code"))
1682 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1685 (defun byte-compile-output-file-form (form)
1686 ;; writes the given form to the output buffer, being careful of docstrings
1687 ;; in defun, defmacro, defvar, defconst, autoload and
1688 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1689 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1690 ;; it does not pay to first build the defalias in defmumble and then parse
1692 (if (and (memq (car-safe form
) '(defun defmacro defvar defconst autoload
1693 custom-declare-variable
))
1694 (stringp (nth 3 form
)))
1695 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
1697 '(autoload custom-declare-variable
)))
1698 (let ((print-escape-newlines t
)
1703 (princ "\n" outbuffer
)
1704 (prin1 form outbuffer
)
1707 (defun byte-compile-output-docform (preface name info form specindex quoted
)
1708 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1709 If PREFACE and NAME are non-nil, print them too,
1710 before INFO and the FORM but after the doc string itself.
1711 If SPECINDEX is non-nil, it is the index in FORM
1712 of the function bytecode string. In that case,
1713 we output that argument and the following argument (the constants vector)
1714 together, for lazy loading.
1715 QUOTED says that we have to put a quote before the
1716 list that represents a doc string reference.
1717 `autoload' and `custom-declare-variable' need that."
1718 ;; We need to examine byte-compile-dynamic-docstrings
1719 ;; in the input buffer (now current), not in the output buffer.
1720 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
1722 (prog1 (current-buffer)
1723 (set-buffer outbuffer
)
1726 ;; Insert the doc string, and make it a comment with #@LENGTH.
1727 (and (>= (nth 1 info
) 0)
1729 (not byte-compile-compatibility
)
1731 ;; Make the doc string start at beginning of line
1732 ;; for make-docfile's sake.
1735 (byte-compile-output-as-comment
1736 (nth (nth 1 info
) form
) nil
))
1737 (setq position
(position-bytes position
))
1738 ;; If the doc string starts with * (a user variable),
1740 (if (and (stringp (nth (nth 1 info
) form
))
1741 (> (length (nth (nth 1 info
) form
)) 0)
1742 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
1743 (setq position
(- position
)))))
1748 (prin1 name outbuffer
)))
1750 (let ((print-escape-newlines t
)
1752 ;; For compatibility with code before print-circle,
1753 ;; use a cons cell to say that we want
1754 ;; print-gensym-alist not to be cleared
1755 ;; between calls to print functions.
1757 ;; print-gensym-alist was used before print-circle existed.
1759 (print-continuous-numbering t
)
1762 (prin1 (car form
) outbuffer
)
1763 (while (setq form
(cdr form
))
1764 (setq index
(1+ index
))
1766 (cond ((and (numberp specindex
) (= index specindex
))
1768 (byte-compile-output-as-comment
1769 (cons (car form
) (nth 1 form
))
1771 (setq position
(position-bytes position
))
1772 (princ (format "(#$ . %d) nil" position
) outbuffer
)
1773 (setq form
(cdr form
))
1774 (setq index
(1+ index
))))
1775 ((= index
(nth 1 info
))
1777 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
1780 (let ((print-escape-newlines nil
))
1781 (goto-char (prog1 (1+ (point))
1782 (prin1 (car form
) outbuffer
)))
1784 (goto-char (point-max)))))
1786 (prin1 (car form
) outbuffer
)))))
1787 (insert (nth 2 info
))))))
1790 (defun byte-compile-keep-pending (form &optional handler
)
1791 (if (memq byte-optimize
'(t source
))
1792 (setq form
(byte-optimize-form form t
)))
1794 (let ((for-effect t
))
1795 ;; To avoid consing up monstrously large forms at load time, we split
1796 ;; the output regularly.
1797 (and (memq (car-safe form
) '(fset defalias
))
1798 (nthcdr 300 byte-compile-output
)
1799 (byte-compile-flush-pending))
1800 (funcall handler form
)
1802 (byte-compile-discard)))
1803 (byte-compile-form form t
))
1806 (defun byte-compile-flush-pending ()
1807 (if byte-compile-output
1808 (let ((form (byte-compile-out-toplevel t
'file
)))
1809 (cond ((eq (car-safe form
) 'progn
)
1810 (mapc 'byte-compile-output-file-form
(cdr form
)))
1812 (byte-compile-output-file-form form
)))
1813 (setq byte-compile-constants nil
1814 byte-compile-variables nil
1815 byte-compile-depth
0
1816 byte-compile-maxdepth
0
1817 byte-compile-output nil
))))
1819 (defun byte-compile-file-form (form)
1820 (let ((byte-compile-current-form nil
) ; close over this for warnings.
1824 (byte-compile-keep-pending form
))
1825 ((and (symbolp (car form
))
1826 (setq handler
(get (car form
) 'byte-hunk-handler
)))
1827 (cond ((setq form
(funcall handler form
))
1828 (byte-compile-flush-pending)
1829 (byte-compile-output-file-form form
))))
1830 ((eq form
(setq form
(macroexpand form byte-compile-macro-environment
)))
1831 (byte-compile-keep-pending form
))
1833 (byte-compile-file-form form
)))))
1835 ;; Functions and variables with doc strings must be output separately,
1836 ;; so make-docfile can recognise them. Most other things can be output
1839 (put 'defsubst
'byte-hunk-handler
'byte-compile-file-form-defsubst
)
1840 (defun byte-compile-file-form-defsubst (form)
1841 (cond ((assq (nth 1 form
) byte-compile-unresolved-functions
)
1842 (setq byte-compile-current-form
(nth 1 form
))
1843 (byte-compile-warn "defsubst %s was used before it was defined"
1845 (byte-compile-file-form
1846 (macroexpand form byte-compile-macro-environment
))
1847 ;; Return nil so the form is not output twice.
1850 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
1851 (defun byte-compile-file-form-autoload (form)
1852 (and (let ((form form
))
1853 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
1854 (null form
)) ;Constants only
1855 (eval (nth 5 form
)) ;Macro
1856 (eval form
)) ;Define the autoload.
1857 ;; Avoid undefined function warnings for the autoload.
1858 (if (and (consp (nth 1 form
))
1859 (eq (car (nth 1 form
)) 'quote
)
1860 (consp (cdr (nth 1 form
)))
1861 (symbolp (nth 1 (nth 1 form
))))
1862 (add-to-list 'byte-compile-function-environment
1863 (cons (nth 1 (nth 1 form
))
1864 (cons 'autoload
(cdr (cdr form
))))))
1865 (if (stringp (nth 3 form
))
1867 ;; No doc string, so we can compile this as a normal form.
1868 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
1870 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
1871 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
1872 (defun byte-compile-file-form-defvar (form)
1873 (if (null (nth 3 form
))
1874 ;; Since there is no doc string, we can compile this as a normal form,
1875 ;; and not do a file-boundary.
1876 (byte-compile-keep-pending form
)
1877 (if (memq 'free-vars byte-compile-warnings
)
1878 (setq byte-compile-bound-variables
1879 (cons (nth 1 form
) byte-compile-bound-variables
)))
1880 (cond ((consp (nth 2 form
))
1881 (setq form
(copy-sequence form
))
1882 (setcar (cdr (cdr form
))
1883 (byte-compile-top-level (nth 2 form
) nil
'file
))))
1886 (put 'custom-declare-variable
'byte-hunk-handler
1887 'byte-compile-file-form-custom-declare-variable
)
1888 (defun byte-compile-file-form-custom-declare-variable (form)
1889 (if (memq 'free-vars byte-compile-warnings
)
1890 (setq byte-compile-bound-variables
1891 (cons (nth 1 (nth 1 form
)) byte-compile-bound-variables
)))
1894 (put 'require
'byte-hunk-handler
'byte-compile-file-form-eval-boundary
)
1895 (defun byte-compile-file-form-eval-boundary (form)
1897 (byte-compile-keep-pending form
'byte-compile-normal-call
))
1899 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
1900 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
1901 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
1902 (defun byte-compile-file-form-progn (form)
1903 (mapc 'byte-compile-file-form
(cdr form
))
1904 ;; Return nil so the forms are not output twice.
1907 ;; This handler is not necessary, but it makes the output from dont-compile
1908 ;; and similar macros cleaner.
1909 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
1910 (defun byte-compile-file-form-eval (form)
1911 (if (eq (car-safe (nth 1 form
)) 'quote
)
1912 (nth 1 (nth 1 form
))
1913 (byte-compile-keep-pending form
)))
1915 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
1916 (defun byte-compile-file-form-defun (form)
1917 (byte-compile-file-form-defmumble form nil
))
1919 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
1920 (defun byte-compile-file-form-defmacro (form)
1921 (byte-compile-file-form-defmumble form t
))
1923 (defun byte-compile-file-form-defmumble (form macrop
)
1924 (let* ((name (car (cdr form
)))
1925 (this-kind (if macrop
'byte-compile-macro-environment
1926 'byte-compile-function-environment
))
1927 (that-kind (if macrop
'byte-compile-function-environment
1928 'byte-compile-macro-environment
))
1929 (this-one (assq name
(symbol-value this-kind
)))
1930 (that-one (assq name
(symbol-value that-kind
)))
1931 (byte-compile-free-references nil
)
1932 (byte-compile-free-assignments nil
))
1934 ;; When a function or macro is defined, add it to the call tree so that
1935 ;; we can tell when functions are not used.
1936 (if byte-compile-generate-call-tree
1937 (or (assq name byte-compile-call-tree
)
1938 (setq byte-compile-call-tree
1939 (cons (list name nil nil
) byte-compile-call-tree
))))
1941 (setq byte-compile-current-form name
) ; for warnings
1942 (if (memq 'redefine byte-compile-warnings
)
1943 (byte-compile-arglist-warn form macrop
))
1944 (if byte-compile-verbose
1945 (message "Compiling %s... (%s)" (or filename
"") (nth 1 form
)))
1947 (if (and (memq 'redefine byte-compile-warnings
)
1948 ;; don't warn when compiling the stubs in byte-run...
1949 (not (assq (nth 1 form
)
1950 byte-compile-initial-macro-environment
)))
1952 "%s defined multiple times, as both function and macro"
1954 (setcdr that-one nil
))
1956 (if (and (memq 'redefine byte-compile-warnings
)
1957 ;; hack: don't warn when compiling the magic internal
1958 ;; byte-compiler macros in byte-run.el...
1959 (not (assq (nth 1 form
)
1960 byte-compile-initial-macro-environment
)))
1961 (byte-compile-warn "%s %s defined multiple times in this file"
1962 (if macrop
"macro" "function")
1964 ((and (fboundp name
)
1965 (eq (car-safe (symbol-function name
))
1966 (if macrop
'lambda
'macro
)))
1967 (if (memq 'redefine byte-compile-warnings
)
1968 (byte-compile-warn "%s %s being redefined as a %s"
1969 (if macrop
"function" "macro")
1971 (if macrop
"macro" "function")))
1972 ;; shadow existing definition
1974 (cons (cons name nil
) (symbol-value this-kind
))))
1976 (let ((body (nthcdr 3 form
)))
1977 (if (and (stringp (car body
))
1978 (symbolp (car-safe (cdr-safe body
)))
1979 (car-safe (cdr-safe body
))
1980 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
1981 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
1984 ;; Generate code for declarations in macro definitions.
1985 ;; Remove declarations from the body of the macro definition.
1987 (let ((tail (nthcdr 2 form
)))
1988 (when (stringp (car (cdr tail
)))
1989 (setq tail
(cdr tail
)))
1990 (while (and (consp (car (cdr tail
)))
1991 (eq (car (car (cdr tail
))) 'declare
))
1992 (let ((declaration (car (cdr tail
))))
1993 (setcdr tail
(cdr (cdr tail
)))
1994 (princ `(if macro-declaration-function
1995 (funcall macro-declaration-function
1996 ',name
',declaration
))
1999 (let* ((new-one (byte-compile-lambda (cons 'lambda
(nthcdr 2 form
))))
2000 (code (byte-compile-byte-code-maker new-one
)))
2002 (setcdr this-one new-one
)
2004 (cons (cons name new-one
) (symbol-value this-kind
))))
2005 (if (and (stringp (nth 3 form
))
2006 (eq 'quote
(car-safe code
))
2007 (eq 'lambda
(car-safe (nth 1 code
))))
2009 (cons name
(cdr (nth 1 code
))))
2010 (byte-compile-flush-pending)
2011 (if (not (stringp (nth 3 form
)))
2012 ;; No doc string. Provide -1 as the "doc string index"
2013 ;; so that no element will be treated as a doc string.
2014 (byte-compile-output-docform
2015 (if (byte-compile-version-cond byte-compile-compatibility
)
2016 "\n(fset '" "\n(defalias '")
2019 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]")))
2020 ((eq (car code
) 'quote
)
2022 (if macrop
'(" '(macro " -
1 ")") '(" '(" -
1 ")")))
2023 ((if macrop
'(" (cons 'macro (" -
1 "))") '(" (" -
1 ")"))))
2025 (and (atom code
) byte-compile-dynamic
2028 ;; Output the form by hand, that's much simpler than having
2029 ;; b-c-output-file-form analyze the defalias.
2030 (byte-compile-output-docform
2031 (if (byte-compile-version-cond byte-compile-compatibility
)
2032 "\n(fset '" "\n(defalias '")
2035 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2036 ((eq (car code
) 'quote
)
2038 (if macrop
'(" '(macro " 2 ")") '(" '(" 2 ")")))
2039 ((if macrop
'(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2041 (and (atom code
) byte-compile-dynamic
2044 (princ ")" outbuffer
)
2047 ;; Print Lisp object EXP in the output file, inside a comment,
2048 ;; and return the file position it will have.
2049 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2050 (defun byte-compile-output-as-comment (exp quoted
)
2051 (let ((position (point)))
2053 (prog1 (current-buffer)
2054 (set-buffer outbuffer
)
2056 ;; Insert EXP, and make it a comment with #@LENGTH.
2059 (prin1 exp outbuffer
)
2060 (princ exp outbuffer
))
2061 (goto-char position
)
2062 ;; Quote certain special characters as needed.
2063 ;; get_doc_string in doc.c does the unquoting.
2064 (while (search-forward "\^A" nil t
)
2065 (replace-match "\^A\^A" t t
))
2066 (goto-char position
)
2067 (while (search-forward "\000" nil t
)
2068 (replace-match "\^A0" t t
))
2069 (goto-char position
)
2070 (while (search-forward "\037" nil t
)
2071 (replace-match "\^A_" t t
))
2072 (goto-char (point-max))
2074 (goto-char position
)
2075 (insert "#@" (format "%d" (- (position-bytes (point-max))
2076 (position-bytes position
))))
2078 ;; Save the file position of the object.
2079 ;; Note we should add 1 to skip the space
2080 ;; that we inserted before the actual doc string,
2081 ;; and subtract 1 to convert from an 1-origin Emacs position
2082 ;; to a file position; they cancel.
2083 (setq position
(point))
2084 (goto-char (point-max))))
2090 (defun byte-compile (form)
2091 "If FORM is a symbol, byte-compile its function definition.
2092 If FORM is a lambda or a macro, byte-compile it as a function."
2093 (displaying-byte-compile-warnings
2094 (byte-compile-close-variables
2095 (let* ((fun (if (symbolp form
)
2096 (and (fboundp form
) (symbol-function form
))
2098 (macro (eq (car-safe fun
) 'macro
)))
2100 (setq fun
(cdr fun
)))
2101 (cond ((eq (car-safe fun
) 'lambda
)
2103 (cons 'macro
(byte-compile-lambda fun
))
2104 (byte-compile-lambda fun
)))
2109 (defun byte-compile-sexp (sexp)
2110 "Compile and return SEXP."
2111 (displaying-byte-compile-warnings
2112 (byte-compile-close-variables
2113 (byte-compile-top-level sexp
))))
2115 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2116 (defun byte-compile-byte-code-maker (fun)
2118 ((byte-compile-version-cond byte-compile-compatibility
)
2119 ;; Return (quote (lambda ...)).
2120 (list 'quote
(byte-compile-byte-code-unmake fun
)))
2121 ;; ## atom is faster than compiled-func-p.
2122 ((atom fun
) ; compiled function.
2123 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2124 ;; would have produced a lambda.
2126 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2127 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2129 (if (and (setq tmp
(assq 'byte-code
(cdr-safe (cdr fun
))))
2130 (null (cdr (memq tmp fun
))))
2131 ;; Generate a make-byte-code call.
2132 (let* ((interactive (assq 'interactive
(cdr (cdr fun
)))))
2133 (nconc (list 'make-byte-code
2134 (list 'quote
(nth 1 fun
)) ;arglist
2138 (cond ((stringp (nth 2 fun
))
2139 (list (nth 2 fun
))) ;doc
2143 (list (if (or (null (nth 1 interactive
))
2144 (stringp (nth 1 interactive
)))
2146 ;; Interactive spec is a list or a variable
2147 ;; (if it is correct).
2148 (list 'quote
(nth 1 interactive
))))))))
2149 ;; a non-compiled function (probably trivial)
2150 (list 'quote fun
))))))
2152 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2153 (defun byte-compile-byte-code-unmake (function)
2154 (if (consp function
)
2155 function
;;It already is a lambda.
2156 (setq function
(append function nil
)) ; turn it into a list
2157 (nconc (list 'lambda
(nth 0 function
))
2158 (and (nth 4 function
) (list (nth 4 function
)))
2159 (if (nthcdr 5 function
)
2160 (list (cons 'interactive
(if (nth 5 function
)
2161 (nthcdr 5 function
)))))
2162 (list (list 'byte-code
2163 (nth 1 function
) (nth 2 function
)
2164 (nth 3 function
))))))
2167 (defun byte-compile-check-lambda-list (list)
2168 "Check lambda-list LIST for errors."
2171 (let ((arg (car list
)))
2172 (cond ((or (not (symbolp arg
))
2174 (memq arg
'(t nil
)))
2175 (error "Invalid lambda variable %s" arg
))
2178 (error "&rest without variable name"))
2180 (error "Garbage following &rest VAR in lambda-list")))
2181 ((eq arg
'&optional
)
2183 (error "Variable name missing after &optional")))
2185 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2188 (setq list
(cdr list
)))))
2191 ;; Byte-compile a lambda-expression and return a valid function.
2192 ;; The value is usually a compiled function but may be the original
2193 ;; lambda-expression.
2194 (defun byte-compile-lambda (fun)
2195 (unless (eq 'lambda
(car-safe fun
))
2196 (error "Not a lambda list: %S" fun
))
2197 (byte-compile-check-lambda-list (nth 1 fun
))
2198 (let* ((arglist (nth 1 fun
))
2199 (byte-compile-bound-variables
2200 (nconc (and (memq 'free-vars byte-compile-warnings
)
2201 (delq '&rest
(delq '&optional
(copy-sequence arglist
))))
2202 byte-compile-bound-variables
))
2203 (body (cdr (cdr fun
)))
2204 (doc (if (stringp (car body
))
2206 ;; Discard the doc string
2207 ;; unless it is the last element of the body.
2209 (setq body
(cdr body
))))))
2210 (int (assq 'interactive body
)))
2212 ;; Skip (interactive) if it is in front (the most usual location).
2213 (if (eq int
(car body
))
2214 (setq body
(cdr body
)))
2215 (cond ((consp (cdr int
))
2217 (byte-compile-warn "malformed interactive spec: %s"
2218 (prin1-to-string int
)))
2219 ;; If the interactive spec is a call to `list',
2220 ;; don't compile it, because `call-interactively'
2221 ;; looks at the args of `list'.
2222 (let ((form (nth 1 int
)))
2223 (while (or (eq (car-safe form
) 'let
)
2224 (eq (car-safe form
) 'let
*)
2225 (eq (car-safe form
) 'save-excursion
))
2226 (while (consp (cdr form
))
2227 (setq form
(cdr form
)))
2228 (setq form
(car form
)))
2229 (or (eq (car-safe form
) 'list
)
2230 (setq int
(list 'interactive
2231 (byte-compile-top-level (nth 1 int
)))))))
2233 (byte-compile-warn "malformed interactive spec: %s"
2234 (prin1-to-string int
))))))
2235 (let ((compiled (byte-compile-top-level (cons 'progn body
) nil
'lambda
)))
2236 (if (and (eq 'byte-code
(car-safe compiled
))
2237 (not (byte-compile-version-cond
2238 byte-compile-compatibility
)))
2239 (apply 'make-byte-code
2240 (append (list arglist
)
2241 ;; byte-string, constants-vector, stack depth
2243 ;; optionally, the doc string.
2246 ;; optionally, the interactive spec.
2248 (list (nth 1 int
)))))
2250 (nconc (if int
(list int
))
2251 (cond ((eq (car-safe compiled
) 'progn
) (cdr compiled
))
2252 (compiled (list compiled
)))))
2253 (nconc (list 'lambda arglist
)
2254 (if (or doc
(stringp (car compiled
)))
2255 (cons doc
(cond (compiled)
2259 (defun byte-compile-constants-vector ()
2260 ;; Builds the constants-vector from the current variables and constants.
2261 ;; This modifies the constants from (const . nil) to (const . offset).
2262 ;; To keep the byte-codes to look up the vector as short as possible:
2263 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2264 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2265 ;; Next variables again, to get 2-byte codes for variable lookup.
2266 ;; The rest of the constants and variables need 3-byte byte-codes.
2268 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2269 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2271 (limits '(5 ; Use the 1-byte varref codes,
2272 63 ; 1-constlim ; 1-byte byte-constant codes,
2273 255 ; 2-byte varref codes,
2274 65535)) ; 3-byte codes for the rest.
2276 (while (or rest other
)
2277 (setq limit
(car limits
))
2278 (while (and rest
(not (eq i limit
)))
2279 (if (setq tmp
(assq (car (car rest
)) ret
))
2280 (setcdr (car rest
) (cdr tmp
))
2281 (setcdr (car rest
) (setq i
(1+ i
)))
2282 (setq ret
(cons (car rest
) ret
)))
2283 (setq rest
(cdr rest
)))
2284 (setq limits
(cdr limits
)
2286 (setq other rest
))))
2287 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2289 ;; Given an expression FORM, compile it and return an equivalent byte-code
2290 ;; expression (a call to the function byte-code).
2291 (defun byte-compile-top-level (form &optional for-effect output-type
)
2292 ;; OUTPUT-TYPE advises about how form is expected to be used:
2293 ;; 'eval or nil -> a single form,
2294 ;; 'progn or t -> a list of forms,
2295 ;; 'lambda -> body of a lambda,
2296 ;; 'file -> used at file-level.
2297 (let ((byte-compile-constants nil
)
2298 (byte-compile-variables nil
)
2299 (byte-compile-tag-number 0)
2300 (byte-compile-depth 0)
2301 (byte-compile-maxdepth 0)
2302 (byte-compile-output nil
))
2303 (if (memq byte-optimize
'(t source
))
2304 (setq form
(byte-optimize-form form for-effect
)))
2305 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2306 (setq form
(nth 1 form
)))
2307 (if (and (eq 'byte-code
(car-safe form
))
2308 (not (memq byte-optimize
'(t byte
)))
2309 (stringp (nth 1 form
)) (vectorp (nth 2 form
))
2310 (natnump (nth 3 form
)))
2312 (byte-compile-form form for-effect
)
2313 (byte-compile-out-toplevel for-effect output-type
))))
2315 (defun byte-compile-out-toplevel (&optional for-effect output-type
)
2317 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2318 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2319 (setq byte-compile-output
(cdr byte-compile-output
))
2320 (byte-compile-push-constant
2321 ;; Push any constant - preferably one which already is used, and
2322 ;; a number or symbol - ie not some big sequence. The return value
2323 ;; isn't returned, but it would be a shame if some textually large
2324 ;; constant was not optimized away because we chose to return it.
2325 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2326 (let ((tmp (reverse byte-compile-constants
)))
2327 (while (and tmp
(not (or (symbolp (car (car tmp
)))
2328 (numberp (car (car tmp
))))))
2329 (setq tmp
(cdr tmp
)))
2330 (car (car tmp
)))))))
2331 (byte-compile-out 'byte-return
0)
2332 (setq byte-compile-output
(nreverse byte-compile-output
))
2333 (if (memq byte-optimize
'(t byte
))
2334 (setq byte-compile-output
2335 (byte-optimize-lapcode byte-compile-output for-effect
)))
2337 ;; Decompile trivial functions:
2338 ;; only constants and variables, or a single funcall except in lambdas.
2339 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2340 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2341 ;; Note that even (quote foo) must be parsed just as any subr by the
2342 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2343 ;; What to leave uncompiled:
2344 ;; lambda -> never. we used to leave it uncompiled if the body was
2345 ;; a single atom, but that causes confusion if the docstring
2346 ;; uses the (file . pos) syntax. Besides, now that we have
2347 ;; the Lisp_Compiled type, the compiled form is faster.
2348 ;; eval -> atom, quote or (function atom atom atom)
2349 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2350 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2352 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2355 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2356 ((or (eq output-type
'lambda
)
2357 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2358 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2359 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2361 (setq rest
(nreverse
2362 (cdr (memq tmp
(reverse byte-compile-output
)))))
2364 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2365 (setq tmp
(car (cdr (car rest
))))
2366 (if (if (eq (car (car rest
)) 'byte-constant
)
2369 (not (byte-compile-const-symbol-p tmp
)))))
2371 (setq body
(cons (list 'quote tmp
) body
)))
2372 (setq body
(cons tmp body
))))
2374 ;; Allow a funcall if at most one atom follows it.
2375 (null (nthcdr 3 rest
))
2376 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2377 (or (null (cdr rest
))
2378 (and (memq output-type
'(file progn t
))
2380 (eq (car (nth 1 rest
)) 'byte-discard
)
2381 (progn (setq rest
(cdr rest
)) t
))))
2382 (setq maycall nil
) ; Only allow one real function call.
2383 (setq body
(nreverse body
))
2385 (if (and (eq tmp
'funcall
)
2386 (eq (car-safe (car body
)) 'quote
))
2387 (cons (nth 1 (car body
)) (cdr body
))
2389 (or (eq output-type
'file
)
2390 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2391 (setq rest
(cdr rest
)))
2393 (let ((byte-compile-vector (byte-compile-constants-vector)))
2394 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2395 byte-compile-vector byte-compile-maxdepth
)))
2396 ;; it's a trivial function
2397 ((cdr body
) (cons 'progn
(nreverse body
)))
2400 ;; Given BODY, compile it and return a new body.
2401 (defun byte-compile-top-level-body (body &optional for-effect
)
2402 (setq body
(byte-compile-top-level (cons 'progn body
) for-effect t
))
2403 (cond ((eq (car-safe body
) 'progn
)
2408 ;; This is the recursive entry point for compiling each subform of an
2410 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2411 ;; before terminating (ie no value will be left on the stack).
2412 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2413 ;; which does not leave a value on the stack, and then set for-effect to nil
2414 ;; (to prevent byte-compile-form from outputting the byte-discard).
2415 ;; If a handler wants to call another handler, it should do so via
2416 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2417 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2419 (defun byte-compile-form (form &optional for-effect
)
2420 (setq form
(macroexpand form byte-compile-macro-environment
))
2421 (cond ((not (consp form
))
2422 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2423 (byte-compile-constant form
))
2424 ((and for-effect byte-compile-delete-errors
)
2425 (setq for-effect nil
))
2426 (t (byte-compile-variable-ref 'byte-varref form
))))
2427 ((symbolp (car form
))
2428 (let* ((fn (car form
))
2429 (handler (get fn
'byte-compile
)))
2430 (if (byte-compile-const-symbol-p fn
)
2431 (byte-compile-warn "%s called as a function" fn
))
2433 (or (not (byte-compile-version-cond
2434 byte-compile-compatibility
))
2435 (not (get (get fn
'byte-opcode
) 'emacs19-opcode
))))
2436 (funcall handler form
)
2437 (if (memq 'callargs byte-compile-warnings
)
2438 (byte-compile-callargs-warn form
))
2439 (byte-compile-normal-call form
))))
2440 ((and (or (byte-code-function-p (car form
))
2441 (eq (car-safe (car form
)) 'lambda
))
2442 ;; if the form comes out the same way it went in, that's
2443 ;; because it was malformed, and we couldn't unfold it.
2444 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
2445 (byte-compile-form form for-effect
)
2446 (setq for-effect nil
))
2447 ((byte-compile-normal-call form
)))
2449 (byte-compile-discard)))
2451 (defun byte-compile-normal-call (form)
2452 (if byte-compile-generate-call-tree
2453 (byte-compile-annotate-call-tree form
))
2454 (byte-compile-push-constant (car form
))
2455 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
2456 (byte-compile-out 'byte-call
(length (cdr form
))))
2458 (defun byte-compile-variable-ref (base-op var
)
2459 (if (or (not (symbolp var
)) (byte-compile-const-symbol-p var
))
2460 (byte-compile-warn (if (eq base-op
'byte-varbind
)
2461 "attempt to let-bind %s %s"
2462 "variable reference to %s %s")
2463 (if (symbolp var
) "constant" "nonvariable")
2464 (prin1-to-string var
))
2465 (if (and (get var
'byte-obsolete-variable
)
2466 (memq 'obsolete byte-compile-warnings
))
2467 (let* ((ob (get var
'byte-obsolete-variable
))
2469 (byte-compile-warn "%s is an obsolete variable%s; %s" var
2470 (if when
(concat " since " when
) "")
2471 (if (stringp (car ob
))
2473 (format "use %s instead." (car ob
))))))
2474 (if (memq 'free-vars byte-compile-warnings
)
2475 (if (eq base-op
'byte-varbind
)
2476 (setq byte-compile-bound-variables
2477 (cons var byte-compile-bound-variables
))
2479 (memq var byte-compile-bound-variables
)
2480 (if (eq base-op
'byte-varset
)
2481 (or (memq var byte-compile-free-assignments
)
2483 (byte-compile-warn "assignment to free variable %s" var
)
2484 (setq byte-compile-free-assignments
2485 (cons var byte-compile-free-assignments
))))
2486 (or (memq var byte-compile-free-references
)
2488 (byte-compile-warn "reference to free variable %s" var
)
2489 (setq byte-compile-free-references
2490 (cons var byte-compile-free-references
)))))))))
2491 (let ((tmp (assq var byte-compile-variables
)))
2493 (setq tmp
(list var
)
2494 byte-compile-variables
(cons tmp byte-compile-variables
)))
2495 (byte-compile-out base-op tmp
)))
2497 (defmacro byte-compile-get-constant
(const)
2498 `(or (if (stringp ,const
)
2499 (assoc ,const byte-compile-constants
)
2500 (assq ,const byte-compile-constants
))
2501 (car (setq byte-compile-constants
2502 (cons (list ,const
) byte-compile-constants
)))))
2504 ;; Use this when the value of a form is a constant. This obeys for-effect.
2505 (defun byte-compile-constant (const)
2507 (setq for-effect nil
)
2508 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
2510 ;; Use this for a constant that is not the value of its containing form.
2511 ;; This ignores for-effect.
2512 (defun byte-compile-push-constant (const)
2513 (let ((for-effect nil
))
2514 (inline (byte-compile-constant const
))))
2517 ;; Compile those primitive ordinary functions
2518 ;; which have special byte codes just for speed.
2520 (defmacro byte-defop-compiler
(function &optional compile-handler
)
2521 ;; add a compiler-form for FUNCTION.
2522 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2523 ;; the opcode to be used. If function is a list, the first element
2524 ;; is the function and the second element is the bytecode-symbol.
2525 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2526 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2527 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2529 (if (symbolp function
)
2530 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
2531 (setq opcode
(car (cdr function
))
2532 function
(car function
)))
2534 (list 'put
(list 'quote function
) ''byte-compile
2536 (or (cdr (assq compile-handler
2537 '((0 . byte-compile-no-args
)
2538 (1 . byte-compile-one-arg
)
2539 (2 . byte-compile-two-args
)
2540 (3 . byte-compile-three-args
)
2541 (0-1 . byte-compile-zero-or-one-arg
)
2542 (1-2 . byte-compile-one-or-two-args
)
2543 (2-3 . byte-compile-two-or-three-args
)
2546 (intern (concat "byte-compile-"
2547 (symbol-name function
))))))))
2550 (list 'put
(list 'quote function
)
2551 ''byte-opcode
(list 'quote opcode
))
2552 (list 'put
(list 'quote opcode
)
2553 ''byte-opcode-invert
(list 'quote function
)))
2556 (defmacro byte-defop-compiler19
(function &optional compile-handler
)
2557 ;; Just like byte-defop-compiler, but defines an opcode that will only
2558 ;; be used when byte-compile-compatibility is false.
2559 (if (and (byte-compile-single-version)
2560 byte-compile-compatibility
)
2561 ;; #### instead of doing nothing, this should do some remprops,
2562 ;; #### to protect against the case where a single-version compiler
2563 ;; #### is loaded into a world that has contained a multi-version one.
2568 (or (car (cdr-safe function
))
2569 (intern (concat "byte-"
2570 (symbol-name (or (car-safe function
) function
))))))
2572 (list 'byte-defop-compiler function compile-handler
))))
2574 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
2575 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
2578 (put 'byte-call
'byte-opcode-invert
'funcall
)
2579 (put 'byte-list1
'byte-opcode-invert
'list
)
2580 (put 'byte-list2
'byte-opcode-invert
'list
)
2581 (put 'byte-list3
'byte-opcode-invert
'list
)
2582 (put 'byte-list4
'byte-opcode-invert
'list
)
2583 (put 'byte-listN
'byte-opcode-invert
'list
)
2584 (put 'byte-concat2
'byte-opcode-invert
'concat
)
2585 (put 'byte-concat3
'byte-opcode-invert
'concat
)
2586 (put 'byte-concat4
'byte-opcode-invert
'concat
)
2587 (put 'byte-concatN
'byte-opcode-invert
'concat
)
2588 (put 'byte-insertN
'byte-opcode-invert
'insert
)
2590 (byte-defop-compiler (dot byte-point
) 0)
2591 (byte-defop-compiler (dot-max byte-point-max
) 0)
2592 (byte-defop-compiler (dot-min byte-point-min
) 0)
2593 (byte-defop-compiler point
0)
2594 ;;(byte-defop-compiler mark 0) ;; obsolete
2595 (byte-defop-compiler point-max
0)
2596 (byte-defop-compiler point-min
0)
2597 (byte-defop-compiler following-char
0)
2598 (byte-defop-compiler preceding-char
0)
2599 (byte-defop-compiler current-column
0)
2600 (byte-defop-compiler eolp
0)
2601 (byte-defop-compiler eobp
0)
2602 (byte-defop-compiler bolp
0)
2603 (byte-defop-compiler bobp
0)
2604 (byte-defop-compiler current-buffer
0)
2605 ;;(byte-defop-compiler read-char 0) ;; obsolete
2606 (byte-defop-compiler interactive-p
0)
2607 (byte-defop-compiler19 widen
0)
2608 (byte-defop-compiler19 end-of-line
0-
1)
2609 (byte-defop-compiler19 forward-char
0-
1)
2610 (byte-defop-compiler19 forward-line
0-
1)
2611 (byte-defop-compiler symbolp
1)
2612 (byte-defop-compiler consp
1)
2613 (byte-defop-compiler stringp
1)
2614 (byte-defop-compiler listp
1)
2615 (byte-defop-compiler not
1)
2616 (byte-defop-compiler (null byte-not
) 1)
2617 (byte-defop-compiler car
1)
2618 (byte-defop-compiler cdr
1)
2619 (byte-defop-compiler length
1)
2620 (byte-defop-compiler symbol-value
1)
2621 (byte-defop-compiler symbol-function
1)
2622 (byte-defop-compiler (1+ byte-add1
) 1)
2623 (byte-defop-compiler (1- byte-sub1
) 1)
2624 (byte-defop-compiler goto-char
1)
2625 (byte-defop-compiler char-after
0-
1)
2626 (byte-defop-compiler set-buffer
1)
2627 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2628 (byte-defop-compiler19 forward-word
1)
2629 (byte-defop-compiler19 char-syntax
1)
2630 (byte-defop-compiler19 nreverse
1)
2631 (byte-defop-compiler19 car-safe
1)
2632 (byte-defop-compiler19 cdr-safe
1)
2633 (byte-defop-compiler19 numberp
1)
2634 (byte-defop-compiler19 integerp
1)
2635 (byte-defop-compiler19 skip-chars-forward
1-
2)
2636 (byte-defop-compiler19 skip-chars-backward
1-
2)
2637 (byte-defop-compiler eq
2)
2638 (byte-defop-compiler memq
2)
2639 (byte-defop-compiler cons
2)
2640 (byte-defop-compiler aref
2)
2641 (byte-defop-compiler set
2)
2642 (byte-defop-compiler (= byte-eqlsign
) 2)
2643 (byte-defop-compiler (< byte-lss
) 2)
2644 (byte-defop-compiler (> byte-gtr
) 2)
2645 (byte-defop-compiler (<= byte-leq
) 2)
2646 (byte-defop-compiler (>= byte-geq
) 2)
2647 (byte-defop-compiler get
2)
2648 (byte-defop-compiler nth
2)
2649 (byte-defop-compiler substring
2-
3)
2650 (byte-defop-compiler19 (move-marker byte-set-marker
) 2-
3)
2651 (byte-defop-compiler19 set-marker
2-
3)
2652 (byte-defop-compiler19 match-beginning
1)
2653 (byte-defop-compiler19 match-end
1)
2654 (byte-defop-compiler19 upcase
1)
2655 (byte-defop-compiler19 downcase
1)
2656 (byte-defop-compiler19 string
= 2)
2657 (byte-defop-compiler19 string
< 2)
2658 (byte-defop-compiler19 (string-equal byte-string
=) 2)
2659 (byte-defop-compiler19 (string-lessp byte-string
<) 2)
2660 (byte-defop-compiler19 equal
2)
2661 (byte-defop-compiler19 nthcdr
2)
2662 (byte-defop-compiler19 elt
2)
2663 (byte-defop-compiler19 member
2)
2664 (byte-defop-compiler19 assq
2)
2665 (byte-defop-compiler19 (rplaca byte-setcar
) 2)
2666 (byte-defop-compiler19 (rplacd byte-setcdr
) 2)
2667 (byte-defop-compiler19 setcar
2)
2668 (byte-defop-compiler19 setcdr
2)
2669 (byte-defop-compiler19 buffer-substring
2)
2670 (byte-defop-compiler19 delete-region
2)
2671 (byte-defop-compiler19 narrow-to-region
2)
2672 (byte-defop-compiler19 (% byte-rem
) 2)
2673 (byte-defop-compiler aset
3)
2675 (byte-defop-compiler max byte-compile-associative
)
2676 (byte-defop-compiler min byte-compile-associative
)
2677 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
2678 (byte-defop-compiler19 (* byte-mult
) byte-compile-associative
)
2680 ;;####(byte-defop-compiler19 move-to-column 1)
2681 (byte-defop-compiler-1 interactive byte-compile-noop
)
2684 (defun byte-compile-subr-wrong-args (form n
)
2685 (byte-compile-warn "%s called with %d arg%s, but requires %s"
2686 (car form
) (length (cdr form
))
2687 (if (= 1 (length (cdr form
))) "" "s") n
)
2688 ;; get run-time wrong-number-of-args error.
2689 (byte-compile-normal-call form
))
2691 (defun byte-compile-no-args (form)
2692 (if (not (= (length form
) 1))
2693 (byte-compile-subr-wrong-args form
"none")
2694 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2696 (defun byte-compile-one-arg (form)
2697 (if (not (= (length form
) 2))
2698 (byte-compile-subr-wrong-args form
1)
2699 (byte-compile-form (car (cdr form
))) ;; Push the argument
2700 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2702 (defun byte-compile-two-args (form)
2703 (if (not (= (length form
) 3))
2704 (byte-compile-subr-wrong-args form
2)
2705 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2706 (byte-compile-form (nth 2 form
))
2707 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2709 (defun byte-compile-three-args (form)
2710 (if (not (= (length form
) 4))
2711 (byte-compile-subr-wrong-args form
3)
2712 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2713 (byte-compile-form (nth 2 form
))
2714 (byte-compile-form (nth 3 form
))
2715 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2717 (defun byte-compile-zero-or-one-arg (form)
2718 (let ((len (length form
)))
2719 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
2720 ((= len
2) (byte-compile-one-arg form
))
2721 (t (byte-compile-subr-wrong-args form
"0-1")))))
2723 (defun byte-compile-one-or-two-args (form)
2724 (let ((len (length form
)))
2725 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
2726 ((= len
3) (byte-compile-two-args form
))
2727 (t (byte-compile-subr-wrong-args form
"1-2")))))
2729 (defun byte-compile-two-or-three-args (form)
2730 (let ((len (length form
)))
2731 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
2732 ((= len
4) (byte-compile-three-args form
))
2733 (t (byte-compile-subr-wrong-args form
"2-3")))))
2735 (defun byte-compile-noop (form)
2736 (byte-compile-constant nil
))
2738 (defun byte-compile-discard ()
2739 (byte-compile-out 'byte-discard
0))
2742 ;; Compile a function that accepts one or more args and is right-associative.
2743 ;; We do it by left-associativity so that the operations
2744 ;; are done in the same order as in interpreted code.
2745 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
2746 ;; in order to convert markers to numbers, and trigger expected errors.
2747 (defun byte-compile-associative (form)
2749 (let ((opcode (get (car form
) 'byte-opcode
))
2750 (args (copy-sequence (cdr form
))))
2751 (byte-compile-form (car args
))
2752 (setq args
(cdr args
))
2753 (or args
(setq args
'(0)
2754 opcode
(get '+ 'byte-opcode
)))
2756 (byte-compile-form (car args
))
2757 (byte-compile-out opcode
0)
2758 (setq args
(cdr args
))))
2759 (byte-compile-constant (eval form
))))
2762 ;; more complicated compiler macros
2764 (byte-defop-compiler list
)
2765 (byte-defop-compiler concat
)
2766 (byte-defop-compiler fset
)
2767 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
2768 (byte-defop-compiler indent-to
)
2769 (byte-defop-compiler insert
)
2770 (byte-defop-compiler-1 function byte-compile-function-form
)
2771 (byte-defop-compiler-1 - byte-compile-minus
)
2772 (byte-defop-compiler19 (/ byte-quo
) byte-compile-quo
)
2773 (byte-defop-compiler19 nconc
)
2775 (defun byte-compile-list (form)
2776 (let ((count (length (cdr form
))))
2778 (byte-compile-constant nil
))
2780 (mapc 'byte-compile-form
(cdr form
))
2782 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
2783 ((and (< count
256) (not (byte-compile-version-cond
2784 byte-compile-compatibility
)))
2785 (mapc 'byte-compile-form
(cdr form
))
2786 (byte-compile-out 'byte-listN count
))
2787 (t (byte-compile-normal-call form
)))))
2789 (defun byte-compile-concat (form)
2790 (let ((count (length (cdr form
))))
2791 (cond ((and (< 1 count
) (< count
5))
2792 (mapc 'byte-compile-form
(cdr form
))
2794 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
2796 ;; Concat of one arg is not a no-op if arg is not a string.
2798 (byte-compile-form ""))
2799 ((and (< count
256) (not (byte-compile-version-cond
2800 byte-compile-compatibility
)))
2801 (mapc 'byte-compile-form
(cdr form
))
2802 (byte-compile-out 'byte-concatN count
))
2803 ((byte-compile-normal-call form
)))))
2805 (defun byte-compile-minus (form)
2806 (if (null (setq form
(cdr form
)))
2807 (byte-compile-constant 0)
2808 (byte-compile-form (car form
))
2810 (while (setq form
(cdr form
))
2811 (byte-compile-form (car form
))
2812 (byte-compile-out 'byte-diff
0))
2813 (byte-compile-out 'byte-negate
0))))
2815 (defun byte-compile-quo (form)
2816 (let ((len (length form
)))
2818 (byte-compile-subr-wrong-args form
"2 or more"))
2820 (byte-compile-form (car (setq form
(cdr form
))))
2821 (while (setq form
(cdr form
))
2822 (byte-compile-form (car form
))
2823 (byte-compile-out 'byte-quo
0))))))
2825 (defun byte-compile-nconc (form)
2826 (let ((len (length form
)))
2828 (byte-compile-constant nil
))
2830 ;; nconc of one arg is a noop, even if that arg isn't a list.
2831 (byte-compile-form (nth 1 form
)))
2833 (byte-compile-form (car (setq form
(cdr form
))))
2834 (while (setq form
(cdr form
))
2835 (byte-compile-form (car form
))
2836 (byte-compile-out 'byte-nconc
0))))))
2838 (defun byte-compile-fset (form)
2839 ;; warn about forms like (fset 'foo '(lambda () ...))
2840 ;; (where the lambda expression is non-trivial...)
2841 (let ((fn (nth 2 form
))
2843 (if (and (eq (car-safe fn
) 'quote
)
2844 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
2846 (setq body
(cdr (cdr fn
)))
2847 (if (stringp (car body
)) (setq body
(cdr body
)))
2848 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
2849 (if (and (consp (car body
))
2850 (not (eq 'byte-code
(car (car body
)))))
2852 "A quoted lambda form is the second argument of fset. This is probably
2853 not what you want, as that lambda cannot be compiled. Consider using
2854 the syntax (function (lambda (...) ...)) instead.")))))
2855 (byte-compile-two-args form
))
2857 (defun byte-compile-funarg (form)
2858 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
2859 ;; for cases where it's guaranteed that first arg will be used as a lambda.
2860 (byte-compile-normal-call
2861 (let ((fn (nth 1 form
)))
2862 (if (and (eq (car-safe fn
) 'quote
)
2863 (eq (car-safe (nth 1 fn
)) 'lambda
))
2865 (cons (cons 'function
(cdr fn
))
2869 (defun byte-compile-funarg-2 (form)
2870 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
2871 ;; for cases where it's guaranteed that second arg will be used as a lambda.
2872 (byte-compile-normal-call
2873 (let ((fn (nth 2 form
)))
2874 (if (and (eq (car-safe fn
) 'quote
)
2875 (eq (car-safe (nth 1 fn
)) 'lambda
))
2878 (cons (cons 'function
(cdr fn
))
2879 (cdr (cdr (cdr form
))))))
2882 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
2883 ;; Otherwise it will be incompatible with the interpreter,
2884 ;; and (funcall (function foo)) will lose with autoloads.
2886 (defun byte-compile-function-form (form)
2887 (byte-compile-constant
2888 (cond ((symbolp (nth 1 form
))
2890 ;; If we're not allowed to use #[] syntax, then output a form like
2891 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
2892 ;; In this situation, calling make-byte-code at run-time will usually
2893 ;; be less efficient than processing a call to byte-code.
2894 ((byte-compile-version-cond byte-compile-compatibility
)
2895 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form
))))
2896 ((byte-compile-lambda (nth 1 form
))))))
2898 (defun byte-compile-indent-to (form)
2899 (let ((len (length form
)))
2901 (byte-compile-form (car (cdr form
)))
2902 (byte-compile-out 'byte-indent-to
0))
2904 ;; no opcode for 2-arg case.
2905 (byte-compile-normal-call form
))
2907 (byte-compile-subr-wrong-args form
"1-2")))))
2909 (defun byte-compile-insert (form)
2910 (cond ((null (cdr form
))
2911 (byte-compile-constant nil
))
2912 ((and (not (byte-compile-version-cond
2913 byte-compile-compatibility
))
2914 (<= (length form
) 256))
2915 (mapc 'byte-compile-form
(cdr form
))
2916 (if (cdr (cdr form
))
2917 (byte-compile-out 'byte-insertN
(length (cdr form
)))
2918 (byte-compile-out 'byte-insert
0)))
2919 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
2920 (byte-compile-normal-call form
))
2921 ;; We can split it; there is no function call after inserting 1st arg.
2923 (while (setq form
(cdr form
))
2924 (byte-compile-form (car form
))
2925 (byte-compile-out 'byte-insert
0)
2927 (byte-compile-discard))))))
2930 (byte-defop-compiler-1 setq
)
2931 (byte-defop-compiler-1 setq-default
)
2932 (byte-defop-compiler-1 quote
)
2933 (byte-defop-compiler-1 quote-form
)
2935 (defun byte-compile-setq (form)
2936 (let ((args (cdr form
)))
2939 (byte-compile-form (car (cdr args
)))
2940 (or for-effect
(cdr (cdr args
))
2941 (byte-compile-out 'byte-dup
0))
2942 (byte-compile-variable-ref 'byte-varset
(car args
))
2943 (setq args
(cdr (cdr args
))))
2944 ;; (setq), with no arguments.
2945 (byte-compile-form nil for-effect
))
2946 (setq for-effect nil
)))
2948 (defun byte-compile-setq-default (form)
2949 (let ((args (cdr form
))
2953 (cons (list 'set-default
(list 'quote
(car args
)) (car (cdr args
)))
2955 (setq args
(cdr (cdr args
))))
2956 (byte-compile-form (cons 'progn
(nreverse setters
)))))
2958 (defun byte-compile-quote (form)
2959 (byte-compile-constant (car (cdr form
))))
2961 (defun byte-compile-quote-form (form)
2962 (byte-compile-constant (byte-compile-top-level (nth 1 form
))))
2965 ;;; control structures
2967 (defun byte-compile-body (body &optional for-effect
)
2969 (byte-compile-form (car body
) t
)
2970 (setq body
(cdr body
)))
2971 (byte-compile-form (car body
) for-effect
))
2973 (defsubst byte-compile-body-do-effect
(body)
2974 (byte-compile-body body for-effect
)
2975 (setq for-effect nil
))
2977 (defsubst byte-compile-form-do-effect
(form)
2978 (byte-compile-form form for-effect
)
2979 (setq for-effect nil
))
2981 (byte-defop-compiler-1 inline byte-compile-progn
)
2982 (byte-defop-compiler-1 progn
)
2983 (byte-defop-compiler-1 prog1
)
2984 (byte-defop-compiler-1 prog2
)
2985 (byte-defop-compiler-1 if
)
2986 (byte-defop-compiler-1 cond
)
2987 (byte-defop-compiler-1 and
)
2988 (byte-defop-compiler-1 or
)
2989 (byte-defop-compiler-1 while
)
2990 (byte-defop-compiler-1 funcall
)
2991 (byte-defop-compiler-1 apply byte-compile-funarg
)
2992 (byte-defop-compiler-1 mapcar byte-compile-funarg
)
2993 (byte-defop-compiler-1 mapatoms byte-compile-funarg
)
2994 (byte-defop-compiler-1 mapconcat byte-compile-funarg
)
2995 (byte-defop-compiler-1 mapc byte-compile-funarg
)
2996 (byte-defop-compiler-1 sort byte-compile-funarg-2
)
2997 (byte-defop-compiler-1 let
)
2998 (byte-defop-compiler-1 let
*)
3000 (defun byte-compile-progn (form)
3001 (byte-compile-body-do-effect (cdr form
)))
3003 (defun byte-compile-prog1 (form)
3004 (byte-compile-form-do-effect (car (cdr form
)))
3005 (byte-compile-body (cdr (cdr form
)) t
))
3007 (defun byte-compile-prog2 (form)
3008 (byte-compile-form (nth 1 form
) t
)
3009 (byte-compile-form-do-effect (nth 2 form
))
3010 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3012 (defmacro byte-compile-goto-if
(cond discard tag
)
3015 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3016 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3019 (defun byte-compile-if (form)
3020 (byte-compile-form (car (cdr form
)))
3021 (if (null (nthcdr 3 form
))
3023 (let ((donetag (byte-compile-make-tag)))
3024 (byte-compile-goto-if nil for-effect donetag
)
3025 (byte-compile-form (nth 2 form
) for-effect
)
3026 (byte-compile-out-tag donetag
))
3027 (let ((donetag (byte-compile-make-tag)) (elsetag (byte-compile-make-tag)))
3028 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3029 (byte-compile-form (nth 2 form
) for-effect
)
3030 (byte-compile-goto 'byte-goto donetag
)
3031 (byte-compile-out-tag elsetag
)
3032 (byte-compile-body (cdr (cdr (cdr form
))) for-effect
)
3033 (byte-compile-out-tag donetag
)))
3034 (setq for-effect nil
))
3036 (defun byte-compile-cond (clauses)
3037 (let ((donetag (byte-compile-make-tag))
3039 (while (setq clauses
(cdr clauses
))
3040 (setq clause
(car clauses
))
3041 (cond ((or (eq (car clause
) t
)
3042 (and (eq (car-safe (car clause
)) 'quote
)
3043 (car-safe (cdr-safe (car clause
)))))
3044 ;; Unconditional clause
3045 (setq clause
(cons t clause
)
3048 (byte-compile-form (car clause
))
3049 (if (null (cdr clause
))
3050 ;; First clause is a singleton.
3051 (byte-compile-goto-if t for-effect donetag
)
3052 (setq nexttag
(byte-compile-make-tag))
3053 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3054 (byte-compile-body (cdr clause
) for-effect
)
3055 (byte-compile-goto 'byte-goto donetag
)
3056 (byte-compile-out-tag nexttag
)))))
3058 (and (cdr clause
) (not (eq (car clause
) t
))
3059 (progn (byte-compile-form (car clause
))
3060 (byte-compile-goto-if nil for-effect donetag
)
3061 (setq clause
(cdr clause
))))
3062 (byte-compile-body-do-effect clause
)
3063 (byte-compile-out-tag donetag
)))
3065 (defun byte-compile-and (form)
3066 (let ((failtag (byte-compile-make-tag))
3069 (byte-compile-form-do-effect t
)
3071 (byte-compile-form (car args
))
3072 (byte-compile-goto-if nil for-effect failtag
)
3073 (setq args
(cdr args
)))
3074 (byte-compile-form-do-effect (car args
))
3075 (byte-compile-out-tag failtag
))))
3077 (defun byte-compile-or (form)
3078 (let ((wintag (byte-compile-make-tag))
3081 (byte-compile-form-do-effect nil
)
3083 (byte-compile-form (car args
))
3084 (byte-compile-goto-if t for-effect wintag
)
3085 (setq args
(cdr args
)))
3086 (byte-compile-form-do-effect (car args
))
3087 (byte-compile-out-tag wintag
))))
3089 (defun byte-compile-while (form)
3090 (let ((endtag (byte-compile-make-tag))
3091 (looptag (byte-compile-make-tag)))
3092 (byte-compile-out-tag looptag
)
3093 (byte-compile-form (car (cdr form
)))
3094 (byte-compile-goto-if nil for-effect endtag
)
3095 (byte-compile-body (cdr (cdr form
)) t
)
3096 (byte-compile-goto 'byte-goto looptag
)
3097 (byte-compile-out-tag endtag
)
3098 (setq for-effect nil
)))
3100 (defun byte-compile-funcall (form)
3101 (mapc 'byte-compile-form
(cdr form
))
3102 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3105 (defun byte-compile-let (form)
3106 ;; First compute the binding values in the old scope.
3107 (let ((varlist (car (cdr form
))))
3109 (if (consp (car varlist
))
3110 (byte-compile-form (car (cdr (car varlist
))))
3111 (byte-compile-push-constant nil
))
3112 (setq varlist
(cdr varlist
))))
3113 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3114 (varlist (reverse (car (cdr form
)))))
3116 (byte-compile-variable-ref 'byte-varbind
(if (consp (car varlist
))
3119 (setq varlist
(cdr varlist
)))
3120 (byte-compile-body-do-effect (cdr (cdr form
)))
3121 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3123 (defun byte-compile-let* (form)
3124 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3125 (varlist (copy-sequence (car (cdr form
)))))
3127 (if (atom (car varlist
))
3128 (byte-compile-push-constant nil
)
3129 (byte-compile-form (car (cdr (car varlist
))))
3130 (setcar varlist
(car (car varlist
))))
3131 (byte-compile-variable-ref 'byte-varbind
(car varlist
))
3132 (setq varlist
(cdr varlist
)))
3133 (byte-compile-body-do-effect (cdr (cdr form
)))
3134 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3137 (byte-defop-compiler-1 /= byte-compile-negated
)
3138 (byte-defop-compiler-1 atom byte-compile-negated
)
3139 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3141 (put '/= 'byte-compile-negated-op
'=)
3142 (put 'atom
'byte-compile-negated-op
'consp
)
3143 (put 'nlistp
'byte-compile-negated-op
'listp
)
3145 (defun byte-compile-negated (form)
3146 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3148 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3149 (defun byte-compile-negation-optimizer (form)
3150 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3152 (cons (or (get (car form
) 'byte-compile-negated-op
)
3154 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3158 ;;; other tricky macro-like special-forms
3160 (byte-defop-compiler-1 catch
)
3161 (byte-defop-compiler-1 unwind-protect
)
3162 (byte-defop-compiler-1 condition-case
)
3163 (byte-defop-compiler-1 save-excursion
)
3164 (byte-defop-compiler-1 save-current-buffer
)
3165 (byte-defop-compiler-1 save-restriction
)
3166 (byte-defop-compiler-1 save-window-excursion
)
3167 (byte-defop-compiler-1 with-output-to-temp-buffer
)
3168 (byte-defop-compiler-1 track-mouse
)
3170 (defun byte-compile-catch (form)
3171 (byte-compile-form (car (cdr form
)))
3172 (byte-compile-push-constant
3173 (byte-compile-top-level (cons 'progn
(cdr (cdr form
))) for-effect
))
3174 (byte-compile-out 'byte-catch
0))
3176 (defun byte-compile-unwind-protect (form)
3177 (byte-compile-push-constant
3178 (byte-compile-top-level-body (cdr (cdr form
)) t
))
3179 (byte-compile-out 'byte-unwind-protect
0)
3180 (byte-compile-form-do-effect (car (cdr form
)))
3181 (byte-compile-out 'byte-unbind
1))
3183 (defun byte-compile-track-mouse (form)
3190 (byte-compile-top-level-body (cdr form
))))))))
3192 (defun byte-compile-condition-case (form)
3193 (let* ((var (nth 1 form
))
3194 (byte-compile-bound-variables
3195 (if var
(cons var byte-compile-bound-variables
)
3196 byte-compile-bound-variables
)))
3199 "%s is not a variable-name or nil (in condition-case)" var
))
3200 (byte-compile-push-constant var
)
3201 (byte-compile-push-constant (byte-compile-top-level
3202 (nth 2 form
) for-effect
))
3203 (let ((clauses (cdr (cdr (cdr form
))))
3206 (let* ((clause (car clauses
))
3207 (condition (car clause
)))
3208 (cond ((not (or (symbolp condition
)
3209 (and (listp condition
)
3210 (let ((syms condition
) (ok t
))
3212 (if (not (symbolp (car syms
)))
3214 (setq syms
(cdr syms
)))
3217 "%s is not a condition name or list of such (in condition-case)"
3218 (prin1-to-string condition
)))
3219 ;; ((not (or (eq condition 't)
3220 ;; (and (stringp (get condition 'error-message))
3221 ;; (consp (get condition 'error-conditions)))))
3222 ;; (byte-compile-warn
3223 ;; "%s is not a known condition name (in condition-case)"
3226 (setq compiled-clauses
3227 (cons (cons condition
3228 (byte-compile-top-level-body
3229 (cdr clause
) for-effect
))
3231 (setq clauses
(cdr clauses
)))
3232 (byte-compile-push-constant (nreverse compiled-clauses
)))
3233 (byte-compile-out 'byte-condition-case
0)))
3236 (defun byte-compile-save-excursion (form)
3237 (byte-compile-out 'byte-save-excursion
0)
3238 (byte-compile-body-do-effect (cdr form
))
3239 (byte-compile-out 'byte-unbind
1))
3241 (defun byte-compile-save-restriction (form)
3242 (byte-compile-out 'byte-save-restriction
0)
3243 (byte-compile-body-do-effect (cdr form
))
3244 (byte-compile-out 'byte-unbind
1))
3246 (defun byte-compile-save-current-buffer (form)
3247 (byte-compile-out 'byte-save-current-buffer
0)
3248 (byte-compile-body-do-effect (cdr form
))
3249 (byte-compile-out 'byte-unbind
1))
3251 (defun byte-compile-save-window-excursion (form)
3252 (byte-compile-push-constant
3253 (byte-compile-top-level-body (cdr form
) for-effect
))
3254 (byte-compile-out 'byte-save-window-excursion
0))
3256 (defun byte-compile-with-output-to-temp-buffer (form)
3257 (byte-compile-form (car (cdr form
)))
3258 (byte-compile-out 'byte-temp-output-buffer-setup
0)
3259 (byte-compile-body (cdr (cdr form
)))
3260 (byte-compile-out 'byte-temp-output-buffer-show
0))
3263 ;;; top-level forms elsewhere
3265 (byte-defop-compiler-1 defun
)
3266 (byte-defop-compiler-1 defmacro
)
3267 (byte-defop-compiler-1 defvar
)
3268 (byte-defop-compiler-1 defconst byte-compile-defvar
)
3269 (byte-defop-compiler-1 autoload
)
3270 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
3271 (byte-defop-compiler-1 defalias
)
3273 (defun byte-compile-defun (form)
3274 ;; This is not used for file-level defuns with doc strings.
3275 (unless (symbolp (car form
))
3276 (error "defun name must be a symbol, not %s" (car form
)))
3277 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3278 (list 'fset
(list 'quote
(nth 1 form
))
3279 (byte-compile-byte-code-maker
3280 (byte-compile-lambda (cons 'lambda
(cdr (cdr form
)))))))
3281 (byte-compile-discard)
3282 (byte-compile-constant (nth 1 form
)))
3284 (defun byte-compile-defmacro (form)
3285 ;; This is not used for file-level defmacros with doc strings.
3286 (byte-compile-body-do-effect
3287 (list (list 'fset
(list 'quote
(nth 1 form
))
3288 (let ((code (byte-compile-byte-code-maker
3289 (byte-compile-lambda
3290 (cons 'lambda
(cdr (cdr form
)))))))
3291 (if (eq (car-safe code
) 'make-byte-code
)
3292 (list 'cons
''macro code
)
3293 (list 'quote
(cons 'macro
(eval code
))))))
3294 (list 'quote
(nth 1 form
)))))
3296 (defun byte-compile-defvar (form)
3297 ;; This is not used for file-level defvar/consts with doc strings.
3298 (let ((fun (nth 0 form
))
3300 (value (nth 2 form
))
3301 (string (nth 3 form
)))
3302 (when (> (length form
) 4)
3304 "%s %s called with %d arguments, but accepts only %s"
3305 fun var
(length (cdr form
)) 3))
3306 (when (memq 'free-vars byte-compile-warnings
)
3307 (setq byte-compile-bound-variables
3308 (cons var byte-compile-bound-variables
)))
3309 (byte-compile-body-do-effect
3311 ;; Put the defined variable in this library's load-history entry
3312 ;; just as a real defvar would, but only in top-level forms.
3313 (when (and (cddr form
) (null byte-compile-current-form
))
3314 `(push ',var current-load-list
))
3315 (when (> (length form
) 3)
3316 (when (and string
(not (stringp string
)))
3317 (byte-compile-warn "third arg to %s %s is not a string: %s"
3319 `(put ',var
'variable-documentation
,string
))
3320 (if (cddr form
) ; `value' provided
3321 (if (eq fun
'defconst
)
3322 ;; `defconst' sets `var' unconditionally.
3323 (let ((tmp (make-symbol "defconst-tmp-var")))
3324 `(let ((,tmp
,value
))
3325 (eval '(defconst ,var
,tmp
))))
3326 ;; `defvar' sets `var' only when unbound.
3327 `(if (not (boundp ',var
)) (setq ,var
,value
))))
3330 (defun byte-compile-autoload (form)
3331 (and (byte-compile-constp (nth 1 form
))
3332 (byte-compile-constp (nth 5 form
))
3333 (eval (nth 5 form
)) ; macro-p
3334 (not (fboundp (eval (nth 1 form
))))
3336 "The compiler ignores `autoload' except at top level. You should
3337 probably put the autoload of the macro `%s' at top-level."
3338 (eval (nth 1 form
))))
3339 (byte-compile-normal-call form
))
3341 ;; Lambdas in valid places are handled as special cases by various code.
3342 ;; The ones that remain are errors.
3343 (defun byte-compile-lambda-form (form)
3344 (error "`lambda' used as function name is invalid"))
3346 ;; Compile normally, but deal with warnings for the function being defined.
3347 (defun byte-compile-defalias (form)
3348 (if (and (consp (cdr form
)) (consp (nth 1 form
))
3349 (eq (car (nth 1 form
)) 'quote
)
3350 (consp (cdr (nth 1 form
)))
3351 (symbolp (nth 1 (nth 1 form
)))
3352 (consp (nthcdr 2 form
))
3353 (consp (nth 2 form
))
3354 (eq (car (nth 2 form
)) 'quote
)
3355 (consp (cdr (nth 2 form
)))
3356 (symbolp (nth 1 (nth 2 form
))))
3358 (byte-compile-defalias-warn (nth 1 (nth 1 form
))
3359 (nth 1 (nth 2 form
)))
3360 (setq byte-compile-function-environment
3361 (cons (cons (nth 1 (nth 1 form
))
3362 (nth 1 (nth 2 form
)))
3363 byte-compile-function-environment
))))
3364 (byte-compile-normal-call form
))
3366 ;; Turn off warnings about prior calls to the function being defalias'd.
3367 ;; This could be smarter and compare those calls with
3368 ;; the function it is being aliased to.
3369 (defun byte-compile-defalias-warn (new alias
)
3370 (let ((calls (assq new byte-compile-unresolved-functions
)))
3372 (setq byte-compile-unresolved-functions
3373 (delq calls byte-compile-unresolved-functions
)))))
3377 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3378 ;; optimization to have the 'TAG as a part of the tag.
3379 ;; Tags will be (TAG . (tag-number . stack-depth)).
3380 (defun byte-compile-make-tag ()
3381 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
3384 (defun byte-compile-out-tag (tag)
3385 (setq byte-compile-output
(cons tag byte-compile-output
))
3388 ;; ## remove this someday
3389 (and byte-compile-depth
3390 (not (= (cdr (cdr tag
)) byte-compile-depth
))
3391 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
3392 (setq byte-compile-depth
(cdr (cdr tag
))))
3393 (setcdr (cdr tag
) byte-compile-depth
)))
3395 (defun byte-compile-goto (opcode tag
)
3396 (setq byte-compile-output
(cons (cons opcode tag
) byte-compile-output
))
3397 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
3398 (1- byte-compile-depth
)
3399 byte-compile-depth
))
3400 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
3401 (1- byte-compile-depth
))))
3403 (defun byte-compile-out (opcode offset
)
3404 (setq byte-compile-output
(cons (cons opcode offset
) byte-compile-output
))
3405 (cond ((eq opcode
'byte-call
)
3406 (setq byte-compile-depth
(- byte-compile-depth offset
)))
3407 ((eq opcode
'byte-return
)
3408 ;; This is actually an unnecessary case, because there should be
3409 ;; no more opcodes behind byte-return.
3410 (setq byte-compile-depth nil
))
3412 (setq byte-compile-depth
(+ byte-compile-depth
3413 (or (aref byte-stack
+-info
3414 (symbol-value opcode
))
3416 byte-compile-maxdepth
(max byte-compile-depth
3417 byte-compile-maxdepth
))))
3418 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3424 (defun byte-compile-annotate-call-tree (form)
3426 ;; annotate the current call
3427 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
3428 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
3430 (cons byte-compile-current-form
(nth 1 entry
))))
3431 (setq byte-compile-call-tree
3432 (cons (list (car form
) (list byte-compile-current-form
) nil
)
3433 byte-compile-call-tree
)))
3434 ;; annotate the current function
3435 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
3436 (or (memq (car form
) (nth 2 entry
)) ;called
3437 (setcar (cdr (cdr entry
))
3438 (cons (car form
) (nth 2 entry
))))
3439 (setq byte-compile-call-tree
3440 (cons (list byte-compile-current-form nil
(list (car form
)))
3441 byte-compile-call-tree
)))
3444 ;; Renamed from byte-compile-report-call-tree
3445 ;; to avoid interfering with completion of byte-compile-file.
3447 (defun display-call-tree (&optional filename
)
3448 "Display a call graph of a specified file.
3449 This lists which functions have been called, what functions called
3450 them, and what functions they call. The list includes all functions
3451 whose definitions have been compiled in this Emacs session, as well as
3452 all functions called by those functions.
3454 The call graph does not include macros, inline functions, or
3455 primitives that the byte-code interpreter knows about directly \(eq,
3458 The call tree also lists those functions which are not known to be called
3459 \(that is, to which no calls have been compiled\), and which cannot be
3460 invoked interactively."
3462 (message "Generating call tree...")
3463 (with-output-to-temp-buffer "*Call-Tree*"
3464 (set-buffer "*Call-Tree*")
3466 (message "Generating call tree... (sorting on %s)"
3467 byte-compile-call-tree-sort
)
3468 (insert "Call tree for "
3469 (cond ((null byte-compile-current-file
) (or filename
"???"))
3470 ((stringp byte-compile-current-file
)
3471 byte-compile-current-file
)
3472 (t (buffer-name byte-compile-current-file
)))
3474 (prin1-to-string byte-compile-call-tree-sort
)
3476 (if byte-compile-call-tree-sort
3477 (setq byte-compile-call-tree
3478 (sort byte-compile-call-tree
3479 (cond ((eq byte-compile-call-tree-sort
'callers
)
3480 (function (lambda (x y
) (< (length (nth 1 x
))
3481 (length (nth 1 y
))))))
3482 ((eq byte-compile-call-tree-sort
'calls
)
3483 (function (lambda (x y
) (< (length (nth 2 x
))
3484 (length (nth 2 y
))))))
3485 ((eq byte-compile-call-tree-sort
'calls
+callers
)
3486 (function (lambda (x y
) (< (+ (length (nth 1 x
))
3488 (+ (length (nth 1 y
))
3489 (length (nth 2 y
)))))))
3490 ((eq byte-compile-call-tree-sort
'name
)
3491 (function (lambda (x y
) (string< (car x
)
3493 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3494 byte-compile-call-tree-sort
))))))
3495 (message "Generating call tree...")
3496 (let ((rest byte-compile-call-tree
)
3497 (b (current-buffer))
3501 (prin1 (car (car rest
)) b
)
3502 (setq callers
(nth 1 (car rest
))
3503 calls
(nth 2 (car rest
)))
3505 (cond ((not (fboundp (setq f
(car (car rest
)))))
3507 " <top level>";; shouldn't insert nil then, actually -sk
3509 ((subrp (setq f
(symbol-function f
)))
3512 (format " ==> %s" f
))
3513 ((byte-code-function-p f
)
3514 "<compiled function>")
3516 "<malformed function>")
3517 ((eq 'macro
(car f
))
3518 (if (or (byte-code-function-p (cdr f
))
3519 (assq 'byte-code
(cdr (cdr (cdr f
)))))
3522 ((assq 'byte-code
(cdr (cdr f
)))
3523 "<compiled lambda>")
3524 ((eq 'lambda
(car f
))
3527 (format " (%d callers + %d calls = %d)"
3528 ;; Does the optimizer eliminate common subexpressions?-sk
3531 (+ (length callers
) (length calls
)))
3535 (insert " called by:\n")
3537 (insert " " (if (car callers
)
3538 (mapconcat 'symbol-name callers
", ")
3540 (let ((fill-prefix " "))
3541 (fill-region-as-paragraph p
(point)))))
3544 (insert " calls:\n")
3546 (insert " " (mapconcat 'symbol-name calls
", "))
3547 (let ((fill-prefix " "))
3548 (fill-region-as-paragraph p
(point)))))
3550 (setq rest
(cdr rest
)))
3552 (message "Generating call tree...(finding uncalled functions...)")
3553 (setq rest byte-compile-call-tree
)
3554 (let ((uncalled nil
))
3556 (or (nth 1 (car rest
))
3557 (null (setq f
(car (car rest
))))
3558 (byte-compile-fdefinition f t
)
3559 (commandp (byte-compile-fdefinition f nil
))
3560 (setq uncalled
(cons f uncalled
)))
3561 (setq rest
(cdr rest
)))
3563 (let ((fill-prefix " "))
3564 (insert "Noninteractive functions not known to be called:\n ")
3566 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
3567 (fill-region-as-paragraph p
(point)))))
3569 (message "Generating call tree...done.")
3574 (defun batch-byte-compile-if-not-done ()
3575 "Like `byte-compile-file' but doesn't recompile if already up to date.
3576 Use this from the command line, with `-batch';
3577 it won't work in an interactive Emacs."
3578 (batch-byte-compile t
))
3580 ;;; by crl@newton.purdue.edu
3581 ;;; Only works noninteractively.
3583 (defun batch-byte-compile (&optional noforce
)
3584 "Run `byte-compile-file' on the files remaining on the command line.
3585 Use this from the command line, with `-batch';
3586 it won't work in an interactive Emacs.
3587 Each file is processed even if an error occurred previously.
3588 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
3589 If NOFORCE is non-nil, don't recompile a file that seems to be
3590 already up-to-date."
3591 ;; command-line-args-left is what is left of the command line (from startup.el)
3592 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3593 (if (not noninteractive
)
3594 (error "`batch-byte-compile' is to be used only with -batch"))
3596 (while command-line-args-left
3597 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
3598 ;; Directory as argument.
3599 (let ((files (directory-files (car command-line-args-left
)))
3601 (dolist (file files
)
3602 (if (and (string-match emacs-lisp-file-regexp file
)
3603 (not (auto-save-file-name-p file
))
3604 (setq source
(expand-file-name file
3605 (car command-line-args-left
)))
3606 (setq dest
(byte-compile-dest-file source
))
3607 (file-exists-p dest
)
3608 (file-newer-than-file-p source dest
))
3609 (if (null (batch-byte-compile-file source
))
3611 ;; Specific file argument
3612 (if (or (not noforce
)
3613 (let* ((source (car command-line-args-left
))
3614 (dest (byte-compile-dest-file source
)))
3615 (or (not (file-exists-p dest
))
3616 (file-newer-than-file-p source dest
))))
3617 (if (null (batch-byte-compile-file (car command-line-args-left
)))
3619 (setq command-line-args-left
(cdr command-line-args-left
)))
3620 (kill-emacs (if error
1 0))))
3622 (defun batch-byte-compile-file (file)
3624 (byte-compile-file file
)
3626 (message (if (cdr err
)
3627 ">>Error occurred processing %s: %s (%s)"
3628 ">>Error occurred processing %s: %s")
3630 (get (car err
) 'error-message
)
3631 (prin1-to-string (cdr err
)))
3635 (defun batch-byte-recompile-directory ()
3636 "Runs `byte-recompile-directory' on the dirs remaining on the command line.
3637 Must be used only with `-batch', and kills Emacs on completion.
3638 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'."
3639 ;; command-line-args-left is what is left of the command line (startup.el)
3640 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3641 (if (not noninteractive
)
3642 (error "batch-byte-recompile-directory is to be used only with -batch"))
3643 (or command-line-args-left
3644 (setq command-line-args-left
'(".")))
3645 (while command-line-args-left
3646 (byte-recompile-directory (car command-line-args-left
) 0)
3647 (setq command-line-args-left
(cdr command-line-args-left
)))
3651 (make-obsolete 'dot
'point
"before 19.15")
3652 (make-obsolete 'dot-max
'point-max
"before 19.15")
3653 (make-obsolete 'dot-min
'point-min
"before 19.15")
3654 (make-obsolete 'dot-marker
'point-marker
"before 19.15")
3656 (make-obsolete 'buffer-flush-undo
'buffer-disable-undo
"before 19.15")
3657 (make-obsolete 'baud-rate
"use the baud-rate variable instead" "before 19.15")
3658 (make-obsolete 'compiled-function-p
'byte-code-function-p
"before 19.15")
3659 (make-obsolete 'define-function
'defalias
"20.1")
3660 (make-obsolete-variable 'auto-fill-hook
'auto-fill-function
"before 19.15")
3661 (make-obsolete-variable 'blink-paren-hook
'blink-paren-function
"before 19.15")
3662 (make-obsolete-variable 'lisp-indent-hook
'lisp-indent-function
"before 19.15")
3663 (make-obsolete-variable 'inhibit-local-variables
3664 "use enable-local-variables (with the reversed sense)."
3666 (make-obsolete-variable 'unread-command-char
3667 "use unread-command-events instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1."
3669 (make-obsolete-variable 'unread-command-event
3670 "use unread-command-events; which is a list of events rather than a single event."
3672 (make-obsolete-variable 'suspend-hooks
'suspend-hook
"before 19.15")
3673 (make-obsolete-variable 'comment-indent-hook
'comment-indent-function
"before 19.15")
3674 (make-obsolete-variable 'meta-flag
"Use the set-input-mode function instead." "before 19.34")
3675 (make-obsolete-variable 'executing-macro
'executing-kbd-macro
"before 19.34")
3676 (make-obsolete-variable 'before-change-function
3677 "use before-change-functions; which is a list of functions rather than a single function."
3679 (make-obsolete-variable 'after-change-function
3680 "use after-change-functions; which is a list of functions rather than a single function."
3682 (make-obsolete-variable 'font-lock-doc-string-face
'font-lock-string-face
"before 19.34")
3683 (make-obsolete-variable 'post-command-idle-hook
3684 "use timers instead, with `run-with-idle-timer'." "before 19.34")
3685 (make-obsolete-variable 'post-command-idle-delay
3686 "use timers instead, with `run-with-idle-timer'." "before 19.34")
3688 (provide 'byte-compile
)
3692 ;;; report metering (see the hacks in bytecode.c)
3694 (defun byte-compile-report-ops ()
3695 (defvar byte-code-meter
)
3696 (with-output-to-temp-buffer "*Meter*"
3697 (set-buffer "*Meter*")
3698 (let ((i 0) n op off
)
3700 (setq n
(aref (aref byte-code-meter
0) i
)
3702 (if t
;(not (zerop n))
3706 (cond ((< op byte-nth
)
3707 (setq off
(logand op
7))
3708 (setq op
(logand op
248)))
3709 ((>= op byte-constant
)
3710 (setq off
(- op byte-constant
)
3712 (setq op
(aref byte-code-vector op
))
3713 (insert (format "%-4d" i
))
3714 (insert (symbol-name op
))
3715 (if off
(insert " [" (int-to-string off
) "]"))
3717 (insert (int-to-string n
) "\n")))
3720 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
3721 ;; itself, compile some of its most used recursive functions (at load time).
3724 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
3725 (assq 'byte-code
(symbol-function 'byte-compile-form
))
3726 (let ((byte-optimize nil
) ; do it fast
3727 (byte-compile-warnings nil
))
3729 (or noninteractive
(message "compiling %s..." x
))
3731 (or noninteractive
(message "compiling %s...done" x
)))
3732 '(byte-compile-normal-call
3735 ;; Inserted some more than necessary, to speed it up.
3736 byte-compile-top-level
3737 byte-compile-out-toplevel
3738 byte-compile-constant
3739 byte-compile-variable-ref
))))
3742 (run-hooks 'bytecomp-load-hook
)
3744 ;;; bytecomp.el ends here