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.117 $")
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 nil
278 "*If non-nil, the optimizer may delete forms that may signal an error.
279 This includes variable references and calls to functions such as `car'."
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 cl-functions
)
331 "The list of warning types used when `byte-compile-warnings' is t.")
332 (defcustom byte-compile-warnings t
333 "*List of warnings that the byte-compiler should issue (t for all).
335 Elements of the list may be be:
337 free-vars references to variables not in the current lexical scope.
338 unresolved calls to unknown functions.
339 callargs lambda calls with args that don't match the definition.
340 redefine function cell redefined from a macro to a lambda or vice
341 versa, or redefined to take a different number of arguments.
342 obsolete obsolete variables and functions.
343 noruntime functions that may not be defined at runtime (typically
344 defined only under `eval-when-compile').
345 cl-functions calls to runtime functions from the CL package (as
346 distinguished from macros and aliases)."
348 :type
`(choice (const :tag
"All" t
)
349 (set :menu-tag
"Some"
350 (const free-vars
) (const unresolved
)
351 (const callargs
) (const redefine
)
352 (const obsolete
) (const noruntime
) (const cl-functions
))))
354 (defcustom byte-compile-generate-call-tree nil
355 "*Non-nil means collect call-graph information when compiling.
356 This records functions were called and from where.
357 If the value is t, compilation displays the call graph when it finishes.
358 If the value is neither t nor nil, compilation asks you whether to display
361 The call tree only lists functions called, not macros used. Those functions
362 which the byte-code interpreter knows about directly (eq, cons, etc.) are
365 The call tree also lists those functions which are not known to be called
366 \(that is, to which no calls have been compiled). Functions which can be
367 invoked interactively are excluded from this list."
369 :type
'(choice (const :tag
"Yes" t
) (const :tag
"No" nil
)
370 (other :tag
"Ask" lambda
)))
372 (defvar byte-compile-call-tree nil
"Alist of functions and their call tree.
373 Each element looks like
375 \(FUNCTION CALLERS CALLS\)
377 where CALLERS is a list of functions that call FUNCTION, and CALLS
378 is a list of functions for which calls were generated while compiling
381 (defcustom byte-compile-call-tree-sort
'name
382 "*If non-nil, sort the call tree.
383 The values `name', `callers', `calls', `calls+callers'
384 specify different fields to sort on."
386 :type
'(choice (const name
) (const callers
) (const calls
)
387 (const calls
+callers
) (const nil
)))
389 (defvar byte-compile-debug nil
)
391 ;; (defvar byte-compile-overwrite-file t
392 ;; "If nil, old .elc files are deleted before the new is saved, and .elc
393 ;; files will have the same modes as the corresponding .el file. Otherwise,
394 ;; existing .elc files will simply be overwritten, and the existing modes
395 ;; will not be changed. If this variable is nil, then an .elc file which
396 ;; is a symbolic link will be turned into a normal file, instead of the file
397 ;; which the link points to being overwritten.")
399 (defvar byte-compile-constants nil
400 "List of all constants encountered during compilation of this form.")
401 (defvar byte-compile-variables nil
402 "List of all variables encountered during compilation of this form.")
403 (defvar byte-compile-bound-variables nil
404 "List of variables bound in the context of the current form.
405 This list lives partly on the stack.")
406 (defvar byte-compile-free-references
)
407 (defvar byte-compile-free-assignments
)
409 (defvar byte-compiler-error-flag
)
411 (defconst byte-compile-initial-macro-environment
413 ;; (byte-compiler-options . (lambda (&rest forms)
414 ;; (apply 'byte-compiler-options-handler forms)))
415 (eval-when-compile .
(lambda (&rest body
)
417 (byte-compile-eval (byte-compile-top-level
418 (cons 'progn body
))))))
419 (eval-and-compile .
(lambda (&rest body
)
420 (byte-compile-eval-before-compile (cons 'progn body
))
421 (cons 'progn body
))))
422 "The default macro-environment passed to macroexpand by the compiler.
423 Placing a macro here will cause a macro to have different semantics when
424 expanded by the compiler as when expanded by the interpreter.")
426 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
427 "Alist of macros defined in the file being compiled.
428 Each element looks like (MACRONAME . DEFINITION). It is
429 \(MACRONAME . nil) when a macro is redefined as a function.")
431 (defvar byte-compile-function-environment nil
432 "Alist of functions defined in the file being compiled.
433 This is so we can inline them when necessary.
434 Each element looks like (FUNCTIONNAME . DEFINITION). It is
435 \(FUNCTIONNAME . nil) when a function is redefined as a macro.")
437 (defvar byte-compile-unresolved-functions nil
438 "Alist of undefined functions to which calls have been compiled.
439 Used for warnings when the function is not known to be defined or is later
440 defined with incorrect args.")
442 (defvar byte-compile-tag-number
0)
443 (defvar byte-compile-output nil
444 "Alist describing contents to put in byte code string.
445 Each element is (INDEX . VALUE)")
446 (defvar byte-compile-depth
0 "Current depth of execution stack.")
447 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
450 ;;; The byte codes; this information is duplicated in bytecomp.c
452 (defvar byte-code-vector nil
453 "An array containing byte-code names indexed by byte-code values.")
455 (defvar byte-stack
+-info nil
456 "An array with the stack adjustment for each byte-code.")
458 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
459 ;; This is a speed-hack for building the byte-code-vector at compile-time.
460 ;; We fill in the vector at macroexpand-time, and then after the last call
461 ;; to byte-defop, we write the vector out as a constant instead of writing
462 ;; out a bunch of calls to aset.
463 ;; Actually, we don't fill in the vector itself, because that could make
464 ;; it problematic to compile big changes to this compiler; we store the
465 ;; values on its plist, and remove them later in -extrude.
466 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
467 (put 'byte-code-vector
'tmp-compile-time-value
468 (make-vector 256 nil
))))
469 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
470 (put 'byte-stack
+-info
'tmp-compile-time-value
471 (make-vector 256 nil
)))))
472 (aset v1 opcode opname
)
473 (aset v2 opcode stack-adjust
))
475 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
476 (list 'defconst opname opcode
)))
478 (defmacro byte-extrude-byte-code-vectors
()
479 (prog1 (list 'setq
'byte-code-vector
480 (get 'byte-code-vector
'tmp-compile-time-value
)
482 (get 'byte-stack
+-info
'tmp-compile-time-value
))
483 (put 'byte-code-vector
'tmp-compile-time-value nil
)
484 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
489 ;; These opcodes are special in that they pack their argument into the
492 (byte-defop 8 1 byte-varref
"for variable reference")
493 (byte-defop 16 -
1 byte-varset
"for setting a variable")
494 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
495 (byte-defop 32 0 byte-call
"for calling a function")
496 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
497 ;; codes 8-47 are consumed by the preceding opcodes
501 (byte-defop 56 -
1 byte-nth
)
502 (byte-defop 57 0 byte-symbolp
)
503 (byte-defop 58 0 byte-consp
)
504 (byte-defop 59 0 byte-stringp
)
505 (byte-defop 60 0 byte-listp
)
506 (byte-defop 61 -
1 byte-eq
)
507 (byte-defop 62 -
1 byte-memq
)
508 (byte-defop 63 0 byte-not
)
509 (byte-defop 64 0 byte-car
)
510 (byte-defop 65 0 byte-cdr
)
511 (byte-defop 66 -
1 byte-cons
)
512 (byte-defop 67 0 byte-list1
)
513 (byte-defop 68 -
1 byte-list2
)
514 (byte-defop 69 -
2 byte-list3
)
515 (byte-defop 70 -
3 byte-list4
)
516 (byte-defop 71 0 byte-length
)
517 (byte-defop 72 -
1 byte-aref
)
518 (byte-defop 73 -
2 byte-aset
)
519 (byte-defop 74 0 byte-symbol-value
)
520 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
521 (byte-defop 76 -
1 byte-set
)
522 (byte-defop 77 -
1 byte-fset
) ; this was commented out
523 (byte-defop 78 -
1 byte-get
)
524 (byte-defop 79 -
2 byte-substring
)
525 (byte-defop 80 -
1 byte-concat2
)
526 (byte-defop 81 -
2 byte-concat3
)
527 (byte-defop 82 -
3 byte-concat4
)
528 (byte-defop 83 0 byte-sub1
)
529 (byte-defop 84 0 byte-add1
)
530 (byte-defop 85 -
1 byte-eqlsign
)
531 (byte-defop 86 -
1 byte-gtr
)
532 (byte-defop 87 -
1 byte-lss
)
533 (byte-defop 88 -
1 byte-leq
)
534 (byte-defop 89 -
1 byte-geq
)
535 (byte-defop 90 -
1 byte-diff
)
536 (byte-defop 91 0 byte-negate
)
537 (byte-defop 92 -
1 byte-plus
)
538 (byte-defop 93 -
1 byte-max
)
539 (byte-defop 94 -
1 byte-min
)
540 (byte-defop 95 -
1 byte-mult
) ; v19 only
541 (byte-defop 96 1 byte-point
)
542 (byte-defop 98 0 byte-goto-char
)
543 (byte-defop 99 0 byte-insert
)
544 (byte-defop 100 1 byte-point-max
)
545 (byte-defop 101 1 byte-point-min
)
546 (byte-defop 102 0 byte-char-after
)
547 (byte-defop 103 1 byte-following-char
)
548 (byte-defop 104 1 byte-preceding-char
)
549 (byte-defop 105 1 byte-current-column
)
550 (byte-defop 106 0 byte-indent-to
)
551 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
552 (byte-defop 108 1 byte-eolp
)
553 (byte-defop 109 1 byte-eobp
)
554 (byte-defop 110 1 byte-bolp
)
555 (byte-defop 111 1 byte-bobp
)
556 (byte-defop 112 1 byte-current-buffer
)
557 (byte-defop 113 0 byte-set-buffer
)
558 (byte-defop 114 0 byte-save-current-buffer
559 "To make a binding to record the current buffer")
560 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
561 (byte-defop 116 1 byte-interactive-p
)
563 ;; These ops are new to v19
564 (byte-defop 117 0 byte-forward-char
)
565 (byte-defop 118 0 byte-forward-word
)
566 (byte-defop 119 -
1 byte-skip-chars-forward
)
567 (byte-defop 120 -
1 byte-skip-chars-backward
)
568 (byte-defop 121 0 byte-forward-line
)
569 (byte-defop 122 0 byte-char-syntax
)
570 (byte-defop 123 -
1 byte-buffer-substring
)
571 (byte-defop 124 -
1 byte-delete-region
)
572 (byte-defop 125 -
1 byte-narrow-to-region
)
573 (byte-defop 126 1 byte-widen
)
574 (byte-defop 127 0 byte-end-of-line
)
578 ;; These store their argument in the next two bytes
579 (byte-defop 129 1 byte-constant2
580 "for reference to a constant with vector index >= byte-constant-limit")
581 (byte-defop 130 0 byte-goto
"for unconditional jump")
582 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
583 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
584 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
585 "to examine top-of-stack, jump and don't pop it if it's nil,
587 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
588 "to examine top-of-stack, jump and don't pop it if it's non nil,
591 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
592 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
593 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
595 (byte-defop 138 0 byte-save-excursion
596 "to make a binding to record the buffer, point and mark")
597 (byte-defop 139 0 byte-save-window-excursion
598 "to make a binding to record entire window configuration")
599 (byte-defop 140 0 byte-save-restriction
600 "to make a binding to record the current buffer clipping restrictions")
601 (byte-defop 141 -
1 byte-catch
602 "for catch. Takes, on stack, the tag and an expression for the body")
603 (byte-defop 142 -
1 byte-unwind-protect
604 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
606 ;; For condition-case. Takes, on stack, the variable to bind,
607 ;; an expression for the body, and a list of clauses.
608 (byte-defop 143 -
2 byte-condition-case
)
610 ;; For entry to with-output-to-temp-buffer.
611 ;; Takes, on stack, the buffer name.
612 ;; Binds standard-output and does some other things.
613 ;; Returns with temp buffer on the stack in place of buffer name.
614 (byte-defop 144 0 byte-temp-output-buffer-setup
)
616 ;; For exit from with-output-to-temp-buffer.
617 ;; Expects the temp buffer on the stack underneath value to return.
618 ;; Pops them both, then pushes the value back on.
619 ;; Unbinds standard-output and makes the temp buffer visible.
620 (byte-defop 145 -
1 byte-temp-output-buffer-show
)
622 ;; these ops are new to v19
624 ;; To unbind back to the beginning of this frame.
625 ;; Not used yet, but will be needed for tail-recursion elimination.
626 (byte-defop 146 0 byte-unbind-all
)
628 ;; these ops are new to v19
629 (byte-defop 147 -
2 byte-set-marker
)
630 (byte-defop 148 0 byte-match-beginning
)
631 (byte-defop 149 0 byte-match-end
)
632 (byte-defop 150 0 byte-upcase
)
633 (byte-defop 151 0 byte-downcase
)
634 (byte-defop 152 -
1 byte-string
=)
635 (byte-defop 153 -
1 byte-string
<)
636 (byte-defop 154 -
1 byte-equal
)
637 (byte-defop 155 -
1 byte-nthcdr
)
638 (byte-defop 156 -
1 byte-elt
)
639 (byte-defop 157 -
1 byte-member
)
640 (byte-defop 158 -
1 byte-assq
)
641 (byte-defop 159 0 byte-nreverse
)
642 (byte-defop 160 -
1 byte-setcar
)
643 (byte-defop 161 -
1 byte-setcdr
)
644 (byte-defop 162 0 byte-car-safe
)
645 (byte-defop 163 0 byte-cdr-safe
)
646 (byte-defop 164 -
1 byte-nconc
)
647 (byte-defop 165 -
1 byte-quo
)
648 (byte-defop 166 -
1 byte-rem
)
649 (byte-defop 167 0 byte-numberp
)
650 (byte-defop 168 0 byte-integerp
)
653 (byte-defop 175 nil byte-listN
)
654 (byte-defop 176 nil byte-concatN
)
655 (byte-defop 177 nil byte-insertN
)
659 (byte-defop 192 1 byte-constant
"for reference to a constant")
660 ;; codes 193-255 are consumed by byte-constant.
661 (defconst byte-constant-limit
64
662 "Exclusive maximum index usable in the `byte-constant' opcode.")
664 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
665 byte-goto-if-nil-else-pop
666 byte-goto-if-not-nil-else-pop
)
667 "List of byte-codes whose offset is a pc.")
669 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
671 (byte-extrude-byte-code-vectors)
673 ;;; lapcode generator
675 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
676 ;; source -> bytecode, because it's a lot easier to make optimizations
677 ;; on lapcode than on bytecode.
679 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
680 ;; where instruction is a symbol naming a byte-code instruction,
681 ;; and parameter is an argument to that instruction, if any.
683 ;; The instruction can be the pseudo-op TAG, which means that this position
684 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
685 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
686 ;; parameter for some goto op.
688 ;; If the operation is varbind, varref, varset or push-constant, then the
689 ;; parameter is (variable/constant . index_in_constant_vector).
691 ;; First, the source code is macroexpanded and optimized in various ways.
692 ;; Then the resultant code is compiled into lapcode. Another set of
693 ;; optimizations are then run over the lapcode. Then the variables and
694 ;; constants referenced by the lapcode are collected and placed in the
695 ;; constants-vector. (This happens now so that variables referenced by dead
696 ;; code don't consume space.) And finally, the lapcode is transformed into
697 ;; compacted byte-code.
699 ;; A distinction is made between variables and constants because the variable-
700 ;; referencing instructions are more sensitive to the variables being near the
701 ;; front of the constants-vector than the constant-referencing instructions.
702 ;; Also, this lets us notice references to free variables.
704 (defun byte-compile-lapcode (lap)
705 "Turns lapcode into bytecode. The lapcode is destroyed."
706 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
707 (let ((pc 0) ; Program counter
708 op off
; Operation & offset
709 (bytes '()) ; Put the output bytes here
710 (patchlist nil
) ; List of tags and goto's to patch
713 (setq op
(car (car lap
))
715 (cond ((not (symbolp op
))
716 (error "Non-symbolic opcode `%s'" op
))
719 (setq patchlist
(cons off patchlist
)))
720 ((memq op byte-goto-ops
)
722 (setq bytes
(cons (cons pc
(cdr off
))
724 (cons (symbol-value op
) bytes
))))
725 (setq patchlist
(cons bytes patchlist
)))
728 (cond ((cond ((consp off
)
729 ;; Variable or constant reference
731 (eq op
'byte-constant
)))
732 (cond ((< off byte-constant-limit
)
734 (cons (+ byte-constant off
) bytes
))
738 (cons (logand off
255)
739 (cons byte-constant2 bytes
))))))
740 ((<= byte-listN
(symbol-value op
))
742 (cons off
(cons (symbol-value op
) bytes
)))
745 (cons (+ (symbol-value op
) off
) bytes
))
748 (cons off
(cons (+ (symbol-value op
) 6) bytes
)))
752 (cons (logand off
255)
753 (cons (+ (symbol-value op
) 7)
755 (setq lap
(cdr lap
)))
756 ;;(if (not (= pc (length bytes)))
757 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
758 ;; Patch PC into jumps
761 (setq bytes
(car patchlist
))
762 (cond ((atom (car bytes
))) ; Tag
764 (setq pc
(car (cdr (car bytes
)))) ; Pick PC from tag
765 (setcar (cdr bytes
) (logand pc
255))
766 (setcar bytes
(lsh pc -
8))))
767 (setq patchlist
(cdr patchlist
))))
768 (concat (nreverse bytes
))))
771 ;;; compile-time evaluation
773 (defun byte-compile-eval (form)
774 "Eval FORM and mark the functions defined therein.
775 Each function's symbol gets marked with the `byte-compile-noruntime' property."
776 (let ((hist-orig load-history
)
777 (hist-nil-orig current-load-list
))
779 (when (memq 'noruntime byte-compile-warnings
)
780 (let ((hist-new load-history
)
781 (hist-nil-new current-load-list
))
782 ;; Go through load-history, look for newly loaded files
783 ;; and mark all the functions defined therein.
784 (while (and hist-new
(not (eq hist-new hist-orig
)))
785 (let ((xs (pop hist-new
)))
786 ;; Make sure the file was not already loaded before.
787 (unless (assoc (car xs
) hist-orig
)
790 ((symbolp s
) (put s
'byte-compile-noruntime t
))
791 ((and (consp s
) (eq 'autoload
(car s
)))
792 (put (cdr s
) 'byte-compile-noruntime t
)))))))
793 ;; Go through current-load-list for the locally defined funs.
794 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
795 (let ((s (pop hist-nil-new
)))
797 (put s
'byte-compile-noruntime t
)))))))))
799 (defun byte-compile-eval-before-compile (form)
800 "Evaluate FORM for `eval-and-compile'."
801 (let ((hist-nil-orig current-load-list
))
803 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
804 (let ((tem current-load-list
))
805 (while (not (eq tem hist-nil-orig
))
806 (when (equal (car tem
) '(require . cl
))
807 (setq byte-compile-warnings
808 (remq 'cl-functions byte-compile-warnings
)))
809 (setq tem
(cdr tem
)))))))
811 ;;; byte compiler messages
813 (defvar byte-compile-current-form nil
)
814 (defvar byte-compile-dest-file nil
)
815 (defvar byte-compile-current-file nil
)
816 (defvar byte-compile-current-buffer nil
)
818 ;; Log something that isn't a warning.
819 (defmacro byte-compile-log
(format-string &rest args
)
822 '(memq byte-optimize-log
'(t source
))
823 (list 'let
'((print-escape-newlines t
)
826 (list 'byte-compile-log-1
831 (if (symbolp x
) (list 'prin1-to-string x
) x
))
834 ;; Log something that isn't a warning.
835 (defun byte-compile-log-1 (string)
837 (byte-goto-log-buffer)
838 (goto-char (point-max))
839 (byte-compile-warning-prefix nil nil
)
840 (cond (noninteractive
841 (message " %s" string
))
843 (insert (format "%s\n" string
))))))
845 (defvar byte-compile-read-position nil
846 "Character position we began the last `read' from.")
847 (defvar byte-compile-last-position nil
848 "Last known character position in the input.")
850 ;; copied from gnus-util.el
851 (defsubst byte-compile-delete-first
(elt list
)
852 (if (eq (car list
) elt
)
855 (while (and (cdr list
)
856 (not (eq (cadr list
) elt
)))
857 (setq list
(cdr list
)))
859 (setcdr list
(cddr list
)))
862 ;; The purpose of this function is to iterate through the
863 ;; `read-symbol-positions-list'. Each time we process, say, a
864 ;; function definition (`defun') we remove `defun' from
865 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
866 ;; to that symbol's character position. Similarly, if we encounter a
867 ;; variable reference, like in (1+ foo), we remove `foo' from the
868 ;; list. If our current position is after the symbol's position, we
869 ;; assume we've already passed that point, and look for the next
870 ;; occurrence of the symbol.
871 ;; So your're probably asking yourself: Isn't this function a
872 ;; gross hack? And the answer, of course, would be yes.
873 (defun byte-compile-set-symbol-position (sym &optional allow-previous
)
874 (when byte-compile-read-position
877 (setq last byte-compile-last-position
878 entry
(assq sym read-symbol-positions-list
))
880 (setq byte-compile-last-position
881 (+ byte-compile-read-position
(cdr entry
))
882 read-symbol-positions-list
883 (byte-compile-delete-first
884 entry read-symbol-positions-list
)))
885 (or (and allow-previous
(not (= last byte-compile-last-position
)))
886 (> last byte-compile-last-position
)))))))
888 (defvar byte-compile-last-warned-form nil
)
889 (defvar byte-compile-last-logged-file nil
)
891 (defun byte-goto-log-buffer ()
892 (set-buffer (get-buffer-create "*Compile-Log*"))
893 (unless (eq major-mode
'compilation-mode
)
896 ;; This is used as warning-prefix for the compiler.
897 ;; It is always called with the warnings buffer current.
898 (defun byte-compile-warning-prefix (level entry
)
899 (let* ((dir default-directory
)
900 (file (cond ((stringp byte-compile-current-file
)
901 (format "%s:" (file-relative-name byte-compile-current-file dir
)))
902 ((bufferp byte-compile-current-file
)
904 (buffer-name byte-compile-current-file
)))
906 (pos (if (and byte-compile-current-file
907 (integerp byte-compile-read-position
))
908 (with-current-buffer byte-compile-current-buffer
909 (format "%d:%d:" (count-lines (point-min)
910 byte-compile-last-position
)
912 (goto-char byte-compile-last-position
)
913 (1+ (current-column)))))
915 (form (if (eq byte-compile-current-form
:end
) "end of data"
916 (or byte-compile-current-form
"toplevel form"))))
917 (when (or (and byte-compile-current-file
918 (not (equal byte-compile-current-file
919 byte-compile-last-logged-file
)))
920 (and byte-compile-last-warned-form
921 (not (eq byte-compile-current-form
922 byte-compile-last-warned-form
))))
923 (insert (format "\nIn %s:\n" form
)))
925 (insert (format "%s%s" file pos
))))
926 (setq byte-compile-last-logged-file byte-compile-current-file
927 byte-compile-last-warned-form byte-compile-current-form
)
930 ;; This no-op function is used as the value of warning-series
931 ;; to tell inner calls to displaying-byte-compile-warnings
932 ;; not to bind warning-series.
933 (defun byte-compile-warning-series (&rest ignore
)
936 ;; Log the start of a file in *Compile-Log*, and mark it as done.
937 ;; Return the position of the start of the page in the log buffer.
938 ;; But do nothing in batch mode.
939 (defun byte-compile-log-file ()
940 (and (not (equal byte-compile-current-file byte-compile-last-logged-file
))
943 (byte-goto-log-buffer)
944 (goto-char (point-max))
945 (let* ((dir (and byte-compile-current-file
946 (file-name-directory byte-compile-current-file
)))
947 (was-same (equal default-directory dir
))
951 (insert (format "Leaving directory `%s'\n" default-directory
))))
954 (setq pt
(point-marker))
955 (if byte-compile-current-file
956 (insert "\f\nCompiling "
957 (if (stringp byte-compile-current-file
)
958 (concat "file " byte-compile-current-file
)
959 (concat "buffer " (buffer-name byte-compile-current-file
)))
960 " at " (current-time-string) "\n")
961 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
963 (setq default-directory dir
)
965 (insert (format "Entering directory `%s'\n" default-directory
))))
966 (setq byte-compile-last-logged-file byte-compile-current-file
)
969 ;; Log a message STRING in *Compile-Log*.
970 ;; Also log the current function and file if not already done.
971 (defun byte-compile-log-warning (string &optional fill level
)
972 (let ((warning-prefix-function 'byte-compile-warning-prefix
)
973 (warning-group-format "")
974 (warning-fill-prefix (if fill
" ")))
975 (display-warning 'bytecomp string level
"*Compile-Log*")))
977 (defun byte-compile-warn (format &rest args
)
978 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
979 (setq format
(apply 'format format args
))
980 (if byte-compile-error-on-warn
981 (error "%s" format
) ; byte-compile-file catches and logs it
982 (byte-compile-log-warning format t
:warning
)))
984 (defun byte-compile-report-error (error-info)
985 "Report Lisp error in compilation. ERROR-INFO is the error data."
986 (setq byte-compiler-error-flag t
)
987 (byte-compile-log-warning
988 (error-message-string error-info
)
991 ;;; Used by make-obsolete.
992 (defun byte-compile-obsolete (form)
993 (let* ((new (get (car form
) 'byte-obsolete-info
))
994 (handler (nth 1 new
))
996 (byte-compile-set-symbol-position (car form
))
997 (if (memq 'obsolete byte-compile-warnings
)
998 (byte-compile-warn "%s is an obsolete function%s; %s" (car form
)
999 (if when
(concat " since " when
) "")
1000 (if (stringp (car new
))
1002 (format "use %s instead." (car new
)))))
1003 (funcall (or handler
'byte-compile-normal-call
) form
)))
1007 ;; (defvar byte-compiler-valid-options
1008 ;; '((optimize byte-optimize (t nil source byte) val)
1009 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1010 ;; (eq val 'emacs18))
1011 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1012 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1013 ;; (verbose byte-compile-verbose (t nil) val)
1014 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1017 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1018 ;; #### This should print a warning if the user tries to change something
1019 ;; than can't be changed because the running compiler doesn't support it.
1021 ;; ((byte-compile-single-version)
1022 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1023 ;; (list (byte-compile-version-cond
1024 ;; byte-compile-generate-emacs19-bytecodes)))
1025 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1026 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1027 ;; '(emacs18) '(emacs19)))))
1029 ;; (defun byte-compiler-options-handler (&rest args)
1030 ;; (let (key val desc choices)
1032 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1033 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1034 ;; (setq key (car (car args))
1035 ;; val (car (cdr (car args)))
1036 ;; desc (assq key byte-compiler-valid-options))
1038 ;; (error "Unknown byte-compiler option `%s'" key))
1039 ;; (setq choices (nth 2 desc))
1040 ;; (if (consp (car choices))
1043 ;; (ret (and (memq (car val) '(+ -))
1044 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1046 ;; (symbol-value (nth 1 desc)))))))
1047 ;; (setq choices (car choices))
1049 ;; (setq this (car val))
1050 ;; (cond ((memq this choices)
1051 ;; (setq ret (funcall handler this ret)))
1052 ;; ((eq this '+) (setq handler 'cons))
1053 ;; ((eq this '-) (setq handler 'delq))
1054 ;; ((error "`%s' only accepts %s" key choices)))
1055 ;; (setq val (cdr val)))
1056 ;; (set (nth 1 desc) ret))
1057 ;; (or (memq val choices)
1058 ;; (error "`%s' must be one of `%s'" key choices))
1059 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1060 ;; (setq args (cdr args)))
1063 ;;; sanity-checking arglists
1065 (defun byte-compile-fdefinition (name macro-p
)
1066 (let* ((list (if macro-p
1067 byte-compile-macro-environment
1068 byte-compile-function-environment
))
1069 (env (cdr (assq name list
))))
1072 (while (and (symbolp fn
)
1074 (or (symbolp (symbol-function fn
))
1075 (consp (symbol-function fn
))
1077 (byte-code-function-p (symbol-function fn
)))))
1078 (setq fn
(symbol-function fn
)))
1079 (if (and (not macro-p
) (byte-code-function-p fn
))
1082 (if (eq 'macro
(car fn
))
1086 (if (eq 'autoload
(car fn
))
1090 (defun byte-compile-arglist-signature (arglist)
1095 (cond ((eq (car arglist
) '&optional
)
1096 (or opts
(setq opts
0)))
1097 ((eq (car arglist
) '&rest
)
1103 (setq opts
(1+ opts
))
1104 (setq args
(1+ args
)))))
1105 (setq arglist
(cdr arglist
)))
1106 (cons args
(if restp nil
(if opts
(+ args opts
) args
)))))
1109 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1111 (> (car new
) (car old
)) ; requires more args now
1112 (and (null (cdr old
)) ; took rest-args, doesn't any more
1114 (and (cdr new
) (cdr old
) ; can't take as many args now
1115 (< (cdr new
) (cdr old
)))
1118 (defun byte-compile-arglist-signature-string (signature)
1119 (cond ((null (cdr signature
))
1120 (format "%d+" (car signature
)))
1121 ((= (car signature
) (cdr signature
))
1122 (format "%d" (car signature
)))
1123 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1126 ;; Warn if the form is calling a function with the wrong number of arguments.
1127 (defun byte-compile-callargs-warn (form)
1128 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1129 (byte-compile-fdefinition (car form
) t
)))
1131 (byte-compile-arglist-signature
1132 (if (eq 'lambda
(car-safe def
))
1134 (if (byte-code-function-p def
)
1137 (if (and (fboundp (car form
))
1138 (subrp (symbol-function (car form
))))
1139 (subr-arity (symbol-function (car form
))))))
1140 (ncall (length (cdr form
))))
1141 ;; Check many or unevalled from subr-arity.
1142 (if (and (cdr-safe sig
)
1143 (not (numberp (cdr sig
))))
1146 (when (or (< ncall
(car sig
))
1147 (and (cdr sig
) (> ncall
(cdr sig
))))
1148 (byte-compile-set-symbol-position (car form
))
1150 "%s called with %d argument%s, but %s %s"
1152 (if (= 1 ncall
) "" "s")
1153 (if (< ncall
(car sig
))
1156 (byte-compile-arglist-signature-string sig
))))
1157 ;; Check to see if the function will be available at runtime
1158 ;; and/or remember its arity if it's unknown.
1159 (or (and (or sig
(fboundp (car form
))) ; might be a subr or autoload.
1160 (not (get (car form
) 'byte-compile-noruntime
)))
1161 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1163 ;; It's a currently-undefined function.
1164 ;; Remember number of args in call.
1165 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1166 (n (length (cdr form
))))
1168 (or (memq n
(cdr cons
))
1169 (setcdr cons
(cons n
(cdr cons
))))
1170 (setq byte-compile-unresolved-functions
1171 (cons (list (car form
) n
)
1172 byte-compile-unresolved-functions
)))))))
1174 ;; Warn if the function or macro is being redefined with a different
1175 ;; number of arguments.
1176 (defun byte-compile-arglist-warn (form macrop
)
1177 (let ((old (byte-compile-fdefinition (nth 1 form
) macrop
)))
1179 (let ((sig1 (byte-compile-arglist-signature
1180 (if (eq 'lambda
(car-safe old
))
1182 (if (byte-code-function-p old
)
1185 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1186 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1187 (byte-compile-set-symbol-position (nth 1 form
))
1189 "%s %s used to take %s %s, now takes %s"
1190 (if (eq (car form
) 'defun
) "function" "macro")
1192 (byte-compile-arglist-signature-string sig1
)
1193 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1194 (byte-compile-arglist-signature-string sig2
))))
1195 ;; This is the first definition. See if previous calls are compatible.
1196 (let ((calls (assq (nth 1 form
) byte-compile-unresolved-functions
))
1200 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1201 nums
(sort (copy-sequence (cdr calls
)) (function <))
1203 max
(car (nreverse nums
)))
1204 (when (or (< min
(car sig
))
1205 (and (cdr sig
) (> max
(cdr sig
))))
1206 (byte-compile-set-symbol-position (nth 1 form
))
1208 "%s being defined to take %s%s, but was previously called with %s"
1210 (byte-compile-arglist-signature-string sig
)
1211 (if (equal sig
'(1 .
1)) " arg" " args")
1212 (byte-compile-arglist-signature-string (cons min max
))))
1214 (setq byte-compile-unresolved-functions
1215 (delq calls byte-compile-unresolved-functions
)))))
1218 (defvar byte-compile-cl-functions nil
1219 "List of functions defined in CL.")
1221 (defun byte-compile-find-cl-functions ()
1222 (unless byte-compile-cl-functions
1223 (dolist (elt load-history
)
1224 (when (and (stringp (car elt
))
1225 (string-match "^cl\\>" (car elt
)))
1226 (setq byte-compile-cl-functions
1227 (append byte-compile-cl-functions
1229 (let ((tail byte-compile-cl-functions
))
1231 (if (and (consp (car tail
))
1232 (eq (car (car tail
)) 'autoload
))
1233 (setcar tail
(cdr (car tail
))))
1234 (setq tail
(cdr tail
))))))
1236 (defun byte-compile-cl-warn (form)
1237 "Warn if FORM is a call of a function from the CL package."
1238 (let ((func (car-safe form
)))
1239 (if (and byte-compile-cl-functions
1240 (memq func byte-compile-cl-functions
)
1241 ;; Aliases which won't have been expended at this point.
1242 ;; These aren't all aliases of subrs, so not trivial to
1243 ;; avoid hardwiring the list.
1245 '(cl-block-wrapper cl-block-throw
1246 multiple-value-call nth-value
1247 copy-seq first second rest endp cl-member
1248 ;; These would sometimes be warned about
1249 ;; but such warnings are never useful,
1250 ;; so don't warn about them.
1251 macroexpand cl-macroexpand-all cl-compiling-file
))))
1252 (byte-compile-warn "Function `%s' from cl package called at runtime"
1256 (defun byte-compile-print-syms (str1 strn syms
)
1258 (byte-compile-set-symbol-position (car syms
) t
))
1259 (cond ((and (cdr syms
) (not noninteractive
))
1264 (setq s
(symbol-name (pop syms
))
1265 L
(+ L
(length s
) 2))
1266 (if (< L
(1- fill-column
))
1267 (setq str
(concat str
" " s
(and syms
",")))
1268 (setq str
(concat str
"\n " s
(and syms
","))
1269 L
(+ (length s
) 4))))
1270 (byte-compile-warn "%s" str
)))
1272 (byte-compile-warn "%s %s"
1274 (mapconcat #'symbol-name syms
", ")))
1277 (byte-compile-warn str1
(car syms
)))))
1279 ;; If we have compiled any calls to functions which are not known to be
1280 ;; defined, issue a warning enumerating them.
1281 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1282 (defun byte-compile-warn-about-unresolved-functions ()
1283 (when (memq 'unresolved byte-compile-warnings
)
1284 (let ((byte-compile-current-form :end
)
1287 ;; Separate the functions that will not be available at runtime
1288 ;; from the truly unresolved ones.
1289 (dolist (f byte-compile-unresolved-functions
)
1291 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1292 ;; Complain about the no-run-time functions
1293 (byte-compile-print-syms
1294 "the function `%s' might not be defined at runtime."
1295 "the following functions might not be defined at runtime:"
1297 ;; Complain about the unresolved functions
1298 (byte-compile-print-syms
1299 "the function `%s' is not known to be defined."
1300 "the following functions are not known to be defined:"
1305 (defsubst byte-compile-const-symbol-p
(symbol)
1306 (or (memq symbol
'(nil t
))
1309 (defmacro byte-compile-constp
(form)
1310 "Return non-nil if FORM is a constant."
1311 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1312 ((not (symbolp ,form
)))
1313 ((byte-compile-const-symbol-p ,form
))))
1315 (defmacro byte-compile-close-variables
(&rest body
)
1318 ;; Close over these variables to encapsulate the
1319 ;; compilation state
1321 (byte-compile-macro-environment
1322 ;; Copy it because the compiler may patch into the
1323 ;; macroenvironment.
1324 (copy-alist byte-compile-initial-macro-environment
))
1325 (byte-compile-function-environment nil
)
1326 (byte-compile-bound-variables nil
)
1327 (byte-compile-free-references nil
)
1328 (byte-compile-free-assignments nil
)
1330 ;; Close over these variables so that `byte-compiler-options'
1331 ;; can change them on a per-file basis.
1333 (byte-compile-verbose byte-compile-verbose
)
1334 (byte-optimize byte-optimize
)
1335 (byte-compile-compatibility byte-compile-compatibility
)
1336 (byte-compile-dynamic byte-compile-dynamic
)
1337 (byte-compile-dynamic-docstrings
1338 byte-compile-dynamic-docstrings
)
1339 ;; (byte-compile-generate-emacs19-bytecodes
1340 ;; byte-compile-generate-emacs19-bytecodes)
1341 (byte-compile-warnings (if (eq byte-compile-warnings t
)
1342 byte-compile-warning-types
1343 byte-compile-warnings
))
1347 (defmacro displaying-byte-compile-warnings
(&rest body
)
1348 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body
))
1349 (warning-series-started
1350 (and (markerp warning-series
)
1351 (eq (marker-buffer warning-series
)
1352 (get-buffer "*Compile-Log*")))))
1353 (byte-compile-find-cl-functions)
1354 (if (or (eq warning-series
'byte-compile-warning-series
)
1355 warning-series-started
)
1356 ;; warning-series does come from compilation,
1357 ;; so don't bind it, but maybe do set it.
1359 ;; Log the file name. Record position of that text.
1360 (setq tem
(byte-compile-log-file))
1361 (unless warning-series-started
1362 (setq warning-series
(or tem
'byte-compile-warning-series
)))
1363 (if byte-compile-debug
1364 (funcall --displaying-byte-compile-warnings-fn
)
1365 (condition-case error-info
1366 (funcall --displaying-byte-compile-warnings-fn
)
1367 (error (byte-compile-report-error error-info
)))))
1368 ;; warning-series does not come from compilation, so bind it.
1369 (let ((warning-series
1370 ;; Log the file name. Record position of that text.
1371 (or (byte-compile-log-file) 'byte-compile-warning-series
)))
1372 (if byte-compile-debug
1373 (funcall --displaying-byte-compile-warnings-fn
)
1374 (condition-case error-info
1375 (funcall --displaying-byte-compile-warnings-fn
)
1376 (error (byte-compile-report-error error-info
))))))))
1379 (defun byte-force-recompile (directory)
1380 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1381 Files in subdirectories of DIRECTORY are processed also."
1382 (interactive "DByte force recompile (directory): ")
1383 (byte-recompile-directory directory nil t
))
1386 (defun byte-recompile-directory (directory &optional arg force
)
1387 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1388 This is if a `.elc' file exists but is older than the `.el' file.
1389 Files in subdirectories of DIRECTORY are processed also.
1391 If the `.elc' file does not exist, normally this function *does not*
1392 compile the corresponding `.el' file. However,
1393 if ARG (the prefix argument) is 0, that means do compile all those files.
1394 A nonzero ARG means ask the user, for each such `.el' file,
1395 whether to compile it.
1397 A nonzero ARG also means ask about each subdirectory before scanning it.
1399 If the third argument FORCE is non-nil,
1400 recompile every `.el' file that already has a `.elc' file."
1401 (interactive "DByte recompile directory: \nP")
1403 (setq arg
(prefix-numeric-value arg
)))
1407 (force-mode-line-update))
1408 (save-current-buffer
1409 (byte-goto-log-buffer)
1410 (setq default-directory directory
)
1411 (let ((directories (list (expand-file-name directory
)))
1412 (default-directory default-directory
)
1418 (displaying-byte-compile-warnings
1420 (setq directory
(car directories
))
1421 (message "Checking %s..." directory
)
1422 (let ((files (directory-files directory
))
1424 (dolist (file files
)
1425 (setq source
(expand-file-name file directory
))
1426 (if (and (not (member file
'("." ".." "RCS" "CVS")))
1427 (file-directory-p source
)
1428 (not (file-symlink-p source
)))
1429 ;; This file is a subdirectory. Handle them differently.
1430 (when (or (null arg
)
1432 (y-or-n-p (concat "Check " source
"? ")))
1434 (nconc directories
(list source
))))
1435 ;; It is an ordinary file. Decide whether to compile it.
1436 (if (and (string-match emacs-lisp-file-regexp source
)
1437 (file-readable-p source
)
1438 (not (auto-save-file-name-p source
))
1439 (setq dest
(byte-compile-dest-file source
))
1440 (if (file-exists-p dest
)
1441 ;; File was already compiled.
1442 (or force
(file-newer-than-file-p source dest
))
1443 ;; No compiled file exists yet.
1446 (y-or-n-p (concat "Compile " source
"? "))))))
1447 (progn (if (and noninteractive
(not byte-compile-verbose
))
1448 (message "Compiling %s..." source
))
1449 (let ((res (byte-compile-file source
)))
1450 (cond ((eq res
'no-byte-compile
)
1451 (setq skip-count
(1+ skip-count
)))
1453 (setq file-count
(1+ file-count
)))
1455 (setq fail-count
(1+ fail-count
)))))
1457 (message "Checking %s..." directory
))
1458 (if (not (eq last-dir directory
))
1459 (setq last-dir directory
1460 dir-count
(1+ dir-count
)))
1462 (setq directories
(cdr directories
))))
1463 (message "Done (Total of %d file%s compiled%s%s%s)"
1464 file-count
(if (= file-count
1) "" "s")
1465 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1466 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1467 (if (> dir-count
1) (format " in %d directories" dir-count
) "")))))
1469 (defvar no-byte-compile nil
1470 "Non-nil to prevent byte-compiling of emacs-lisp code.
1471 This is normally set in local file variables at the end of the elisp file:
1473 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1476 (defun byte-compile-file (filename &optional load
)
1477 "Compile a file of Lisp code named FILENAME into a file of byte code.
1478 The output file's name is made by appending `c' to the end of FILENAME.
1479 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1480 The value is non-nil if there were no errors, nil if errors."
1481 ;; (interactive "fByte compile file: \nP")
1483 (let ((file buffer-file-name
)
1487 (eq (cdr (assq 'major-mode
(buffer-local-variables)))
1489 (setq file-name
(file-name-nondirectory file
)
1490 file-dir
(file-name-directory file
)))
1491 (list (read-file-name (if current-prefix-arg
1492 "Byte compile and load file: "
1493 "Byte compile file: ")
1494 file-dir file-name nil
)
1495 current-prefix-arg
)))
1496 ;; Expand now so we get the current buffer's defaults
1497 (setq filename
(expand-file-name filename
))
1499 ;; If we're compiling a file that's in a buffer and is modified, offer
1500 ;; to save it first.
1502 (let ((b (get-file-buffer (expand-file-name filename
))))
1503 (if (and b
(buffer-modified-p b
)
1504 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1505 (save-excursion (set-buffer b
) (save-buffer)))))
1507 ;; Force logging of the file name for each file compiled.
1508 (setq byte-compile-last-logged-file nil
)
1509 (let ((byte-compile-current-file filename
)
1510 (set-auto-coding-for-load t
)
1511 target-file input-buffer output-buffer
1512 byte-compile-dest-file
)
1513 (setq target-file
(byte-compile-dest-file filename
))
1514 (setq byte-compile-dest-file target-file
)
1516 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1517 (set-buffer input-buffer
)
1519 (setq buffer-file-coding-system nil
)
1520 ;; Always compile an Emacs Lisp file as multibyte
1521 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1522 (set-buffer-multibyte t
)
1523 (insert-file-contents filename
)
1524 ;; Mimic the way after-insert-file-set-buffer-file-coding-system
1525 ;; can make the buffer unibyte when visiting this file.
1526 (when (or (eq last-coding-system-used
'no-conversion
)
1527 (eq (coding-system-type last-coding-system-used
) 5))
1528 ;; For coding systems no-conversion and raw-text...,
1529 ;; edit the buffer as unibyte.
1530 (set-buffer-multibyte nil
))
1531 ;; Run hooks including the uncompression hook.
1532 ;; If they change the file name, then change it for the output also.
1533 (let ((buffer-file-name filename
)
1534 (default-major-mode 'emacs-lisp-mode
)
1535 (enable-local-eval nil
))
1537 (setq filename buffer-file-name
))
1538 ;; Set the default directory, in case an eval-when-compile uses it.
1539 (setq default-directory
(file-name-directory filename
)))
1540 ;; Check if the file's local variables explicitly specify not to
1541 ;; compile this file.
1542 (if (with-current-buffer input-buffer no-byte-compile
)
1544 (message "%s not compiled because of `no-byte-compile: %s'"
1545 (file-relative-name filename
)
1546 (with-current-buffer input-buffer no-byte-compile
))
1547 (if (file-exists-p target-file
)
1548 (condition-case nil
(delete-file target-file
) (error nil
)))
1549 ;; We successfully didn't compile this file.
1551 (when byte-compile-verbose
1552 (message "Compiling %s..." filename
))
1553 (setq byte-compiler-error-flag nil
)
1554 ;; It is important that input-buffer not be current at this call,
1555 ;; so that the value of point set in input-buffer
1556 ;; within byte-compile-from-buffer lingers in that buffer.
1558 (save-current-buffer
1559 (byte-compile-from-buffer input-buffer filename
)))
1560 (if byte-compiler-error-flag
1562 (when byte-compile-verbose
1563 (message "Compiling %s...done" filename
))
1564 (kill-buffer input-buffer
)
1565 (with-current-buffer output-buffer
1566 (goto-char (point-max))
1567 (insert "\n") ; aaah, unix.
1568 (let ((vms-stmlf-recfm t
))
1569 (if (file-writable-p target-file
)
1570 ;; We must disable any code conversion here.
1571 (let ((coding-system-for-write 'no-conversion
))
1572 (if (memq system-type
'(ms-dos 'windows-nt
))
1573 (setq buffer-file-type t
))
1574 (when (file-exists-p target-file
)
1575 ;; Remove the target before writing it, so that any
1576 ;; hard-links continue to point to the old file (this makes
1577 ;; it possible for installed files to share disk space with
1578 ;; the build tree, without causing problems when emacs-lisp
1579 ;; files in the build tree are recompiled).
1580 (delete-file target-file
))
1581 (write-region (point-min) (point-max) target-file
))
1582 ;; This is just to give a better error message than write-region
1584 (list "Opening output file"
1585 (if (file-exists-p target-file
)
1586 "cannot overwrite file"
1587 "directory not writable or nonexistent")
1589 (kill-buffer (current-buffer)))
1590 (if (and byte-compile-generate-call-tree
1591 (or (eq t byte-compile-generate-call-tree
)
1592 (y-or-n-p (format "Report call tree for %s? " filename
))))
1594 (display-call-tree filename
)))
1599 ;;(defun byte-compile-and-load-file (&optional filename)
1600 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1601 ;;and then load it. The output file's name is made by appending \"c\" to
1602 ;;the end of FILENAME."
1604 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1605 ;; (byte-compile-file filename t)
1606 ;; (let ((current-prefix-arg '(4)))
1607 ;; (call-interactively 'byte-compile-file))))
1609 ;;(defun byte-compile-buffer (&optional buffer)
1610 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1611 ;; (interactive "bByte compile buffer: ")
1612 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1613 ;; (message "Compiling %s..." (buffer-name buffer))
1614 ;; (let* ((filename (or (buffer-file-name buffer)
1615 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1616 ;; (byte-compile-current-file buffer))
1617 ;; (byte-compile-from-buffer buffer nil))
1618 ;; (message "Compiling %s...done" (buffer-name buffer))
1621 ;;; compiling a single function
1623 (defun compile-defun (&optional arg
)
1624 "Compile and evaluate the current top-level form.
1625 Print the result in the minibuffer.
1626 With argument, insert value in current buffer after the form."
1630 (beginning-of-defun)
1631 (let* ((byte-compile-current-file nil
)
1632 (byte-compile-current-buffer (current-buffer))
1633 (byte-compile-read-position (point))
1634 (byte-compile-last-position byte-compile-read-position
)
1635 (byte-compile-last-warned-form 'nothing
)
1637 (let ((read-with-symbol-positions (current-buffer))
1638 (read-symbol-positions-list nil
))
1639 (displaying-byte-compile-warnings
1640 (byte-compile-sexp (read (current-buffer))))))))
1642 (message "Compiling from buffer... done.")
1643 (prin1 value
(current-buffer))
1645 ((message "%s" (prin1-to-string value
)))))))
1648 (defun byte-compile-from-buffer (inbuffer &optional filename
)
1649 ;; Filename is used for the loading-into-Emacs-18 error message.
1651 (byte-compile-current-buffer inbuffer
)
1652 (byte-compile-read-position nil
)
1653 (byte-compile-last-position nil
)
1654 ;; Prevent truncation of flonums and lists as we read and print them
1655 (float-output-format nil
)
1656 (case-fold-search nil
)
1659 ;; Prevent edebug from interfering when we compile
1660 ;; and put the output into a file.
1661 ;; (edebug-all-defs nil)
1662 ;; (edebug-all-forms nil)
1663 ;; Simulate entry to byte-compile-top-level
1664 (byte-compile-constants nil
)
1665 (byte-compile-variables nil
)
1666 (byte-compile-tag-number 0)
1667 (byte-compile-depth 0)
1668 (byte-compile-maxdepth 0)
1669 (byte-compile-output nil
)
1670 ;; This allows us to get the positions of symbols read; it's
1671 ;; new in Emacs 21.4.
1672 (read-with-symbol-positions inbuffer
)
1673 (read-symbol-positions-list nil
)
1674 ;; #### This is bound in b-c-close-variables.
1675 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1676 ;; byte-compile-warning-types
1677 ;; byte-compile-warnings))
1679 (byte-compile-close-variables
1682 (set-buffer (get-buffer-create " *Compiler Output*")))
1683 (set-buffer-multibyte t
)
1685 ;; (emacs-lisp-mode)
1686 (setq case-fold-search nil
)
1687 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1688 ;; write files containing binary information specially.
1689 ;; Under most circumstances, such files will be in binary
1690 ;; overwrite mode, so those OS's use that flag to guess how
1691 ;; they should write their data. Advise them that .elc files
1692 ;; need to be written carefully.
1693 (setq overwrite-mode
'overwrite-mode-binary
))
1694 (displaying-byte-compile-warnings
1695 (and filename
(byte-compile-insert-header filename inbuffer outbuffer
))
1697 (set-buffer inbuffer
)
1700 ;; Compile the forms from the input buffer.
1702 (while (progn (skip-chars-forward " \t\n\^l")
1706 (setq byte-compile-read-position
(point)
1707 byte-compile-last-position byte-compile-read-position
)
1708 (let ((form (read inbuffer
)))
1709 (byte-compile-file-form form
)))
1710 ;; Compile pending forms at end of file.
1711 (byte-compile-flush-pending)
1712 (byte-compile-warn-about-unresolved-functions)
1713 ;; Should we always do this? When calling multiple files, it
1714 ;; would be useful to delay this warning until all have
1716 (setq byte-compile-unresolved-functions nil
))
1717 ;; Fix up the header at the front of the output
1718 ;; if the buffer contains multibyte characters.
1719 (and filename
(byte-compile-fix-header filename inbuffer outbuffer
))))
1722 (defun byte-compile-fix-header (filename inbuffer outbuffer
)
1724 (set-buffer outbuffer
)
1725 ;; See if the buffer has any multibyte characters.
1726 (when (< (point-max) (position-bytes (point-max)))
1727 (when (byte-compile-version-cond byte-compile-compatibility
)
1728 (error "Version-18 compatibility not valid with multibyte characters"))
1729 (goto-char (point-min))
1730 ;; Find the comment that describes the version test.
1731 (search-forward "\n;;; This file")
1733 (narrow-to-region (point) (point-max))
1734 ;; Find the line of ballast semicolons.
1735 (search-forward ";;;;;;;;;;")
1738 (narrow-to-region (point-min) (point))
1739 (let ((old-header-end (point))
1741 (goto-char (point-min))
1742 (delete-region (point) (progn (re-search-forward "^(")
1745 (insert ";;; This file contains multibyte non-ASCII characters\n"
1746 ";;; and therefore cannot be loaded into Emacs 19.\n")
1747 ;; Replace "19" or "19.29" with "20", twice.
1748 (re-search-forward "19\\(\\.[0-9]+\\)")
1749 (replace-match "20")
1750 (re-search-forward "19\\(\\.[0-9]+\\)")
1751 (replace-match "20")
1752 ;; Now compensate for the change in size,
1753 ;; to make sure all positions in the file remain valid.
1754 (setq delta
(- (point-max) old-header-end
))
1755 (goto-char (point-max))
1757 (delete-char delta
)))))
1759 (defun byte-compile-insert-header (filename inbuffer outbuffer
)
1760 (set-buffer inbuffer
)
1761 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
1762 (dynamic byte-compile-dynamic
))
1763 (set-buffer outbuffer
)
1765 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1766 ;; that is the file-format version number (18, 19 or 20) as a
1767 ;; byte, followed by some nulls. The primary motivation for doing
1768 ;; this is to get some binary characters up in the first line of
1769 ;; the file so that `diff' will simply say "Binary files differ"
1770 ;; instead of actually doing a diff of two .elc files. An extra
1771 ;; benefit is that you can add this to /etc/magic:
1773 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1774 ;; >4 byte x version %d
1778 (if (byte-compile-version-cond byte-compile-compatibility
) 18 20)
1781 (insert ";;; Compiled by "
1782 (or (and (boundp 'user-mail-address
) user-mail-address
)
1783 (concat (user-login-name) "@" (system-name)))
1785 (current-time-string) "\n;;; from file " filename
"\n")
1786 (insert ";;; in Emacs version " emacs-version
"\n")
1787 (insert ";;; with bytecomp version "
1788 (progn (string-match "[0-9.]+" byte-compile-version
)
1789 (match-string 0 byte-compile-version
))
1792 ((eq byte-optimize
'source
) "with source-level optimization only")
1793 ((eq byte-optimize
'byte
) "with byte-level optimization only")
1794 (byte-optimize "with all optimizations")
1795 (t "without optimization"))
1796 (if (byte-compile-version-cond byte-compile-compatibility
)
1797 "; compiled with Emacs 18 compatibility.\n"
1800 (insert ";;; Function definitions are lazy-loaded.\n"))
1801 (if (not (byte-compile-version-cond byte-compile-compatibility
))
1802 (let (intro-string minimum-version
)
1803 ;; Figure out which Emacs version to require,
1804 ;; and what comment to use to explain why.
1805 ;; Note that this fails to take account of whether
1806 ;; the buffer contains multibyte characters. We may have to
1807 ;; compensate at the end in byte-compile-fix-header.
1808 (if dynamic-docstrings
1810 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1811 minimum-version
"19.29")
1813 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1814 minimum-version
"19"))
1815 ;; Now insert the comment and the error check.
1819 ;; Have to check if emacs-version is bound so that this works
1820 ;; in files loaded early in loadup.el.
1821 "(if (and (boundp 'emacs-version)\n"
1822 ;; If there is a name at the end of emacs-version,
1823 ;; don't try to check the version number.
1824 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1825 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1826 (format "\t (string-lessp emacs-version \"%s\")))\n"
1829 ;; prin1-to-string is used to quote backslashes.
1830 (substring (prin1-to-string (file-name-nondirectory filename
))
1832 (format "' was compiled for Emacs %s or later\"))\n\n"
1834 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1835 ;; can delete them so as to keep the buffer positions
1836 ;; constant for the actual compiled code.
1837 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1838 ;; Here if we want Emacs 18 compatibility.
1839 (when dynamic-docstrings
1840 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1841 (when byte-compile-dynamic
1842 (error "Version-18 compatibility doesn't support dynamic byte code"))
1843 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1846 (defun byte-compile-output-file-form (form)
1847 ;; writes the given form to the output buffer, being careful of docstrings
1848 ;; in defun, defmacro, defvar, defconst, autoload and
1849 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1850 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1851 ;; it does not pay to first build the defalias in defmumble and then parse
1853 (if (and (memq (car-safe form
) '(defun defmacro defvar defconst autoload
1854 custom-declare-variable
))
1855 (stringp (nth 3 form
)))
1856 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
1858 '(autoload custom-declare-variable
)))
1859 (let ((print-escape-newlines t
)
1864 (princ "\n" outbuffer
)
1865 (prin1 form outbuffer
)
1868 (defun byte-compile-output-docform (preface name info form specindex quoted
)
1869 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1870 If PREFACE and NAME are non-nil, print them too,
1871 before INFO and the FORM but after the doc string itself.
1872 If SPECINDEX is non-nil, it is the index in FORM
1873 of the function bytecode string. In that case,
1874 we output that argument and the following argument (the constants vector)
1875 together, for lazy loading.
1876 QUOTED says that we have to put a quote before the
1877 list that represents a doc string reference.
1878 `autoload' and `custom-declare-variable' need that."
1879 ;; We need to examine byte-compile-dynamic-docstrings
1880 ;; in the input buffer (now current), not in the output buffer.
1881 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
1883 (prog1 (current-buffer)
1884 (set-buffer outbuffer
)
1887 ;; Insert the doc string, and make it a comment with #@LENGTH.
1888 (and (>= (nth 1 info
) 0)
1890 (not byte-compile-compatibility
)
1892 ;; Make the doc string start at beginning of line
1893 ;; for make-docfile's sake.
1896 (byte-compile-output-as-comment
1897 (nth (nth 1 info
) form
) nil
))
1898 (setq position
(- (position-bytes position
) (point-min) -
1))
1899 ;; If the doc string starts with * (a user variable),
1901 (if (and (stringp (nth (nth 1 info
) form
))
1902 (> (length (nth (nth 1 info
) form
)) 0)
1903 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
1904 (setq position
(- position
)))))
1909 (prin1 name outbuffer
)))
1911 (let ((print-escape-newlines t
)
1913 ;; For compatibility with code before print-circle,
1914 ;; use a cons cell to say that we want
1915 ;; print-gensym-alist not to be cleared
1916 ;; between calls to print functions.
1918 ;; print-gensym-alist was used before print-circle existed.
1920 (print-continuous-numbering t
)
1923 (prin1 (car form
) outbuffer
)
1924 (while (setq form
(cdr form
))
1925 (setq index
(1+ index
))
1927 (cond ((and (numberp specindex
) (= index specindex
)
1928 ;; Don't handle the definition dynamically
1929 ;; if it refers (or might refer)
1930 ;; to objects already output
1931 ;; (for instance, gensyms in the arg list).
1933 (dotimes (i (length print-number-table
))
1934 (if (aref print-number-table i
)
1937 ;; Output the byte code and constants specially
1938 ;; for lazy dynamic loading.
1940 (byte-compile-output-as-comment
1941 (cons (car form
) (nth 1 form
))
1943 (setq position
(- (position-bytes position
) (point-min) -
1))
1944 (princ (format "(#$ . %d) nil" position
) outbuffer
)
1945 (setq form
(cdr form
))
1946 (setq index
(1+ index
))))
1947 ((= index
(nth 1 info
))
1949 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
1952 (let ((print-escape-newlines nil
))
1953 (goto-char (prog1 (1+ (point))
1954 (prin1 (car form
) outbuffer
)))
1956 (goto-char (point-max)))))
1958 (prin1 (car form
) outbuffer
)))))
1959 (insert (nth 2 info
))))))
1962 (defun byte-compile-keep-pending (form &optional handler
)
1963 (if (memq byte-optimize
'(t source
))
1964 (setq form
(byte-optimize-form form t
)))
1966 (let ((for-effect t
))
1967 ;; To avoid consing up monstrously large forms at load time, we split
1968 ;; the output regularly.
1969 (and (memq (car-safe form
) '(fset defalias
))
1970 (nthcdr 300 byte-compile-output
)
1971 (byte-compile-flush-pending))
1972 (funcall handler form
)
1974 (byte-compile-discard)))
1975 (byte-compile-form form t
))
1978 (defun byte-compile-flush-pending ()
1979 (if byte-compile-output
1980 (let ((form (byte-compile-out-toplevel t
'file
)))
1981 (cond ((eq (car-safe form
) 'progn
)
1982 (mapc 'byte-compile-output-file-form
(cdr form
)))
1984 (byte-compile-output-file-form form
)))
1985 (setq byte-compile-constants nil
1986 byte-compile-variables nil
1987 byte-compile-depth
0
1988 byte-compile-maxdepth
0
1989 byte-compile-output nil
))))
1991 (defun byte-compile-file-form (form)
1992 (let ((byte-compile-current-form nil
) ; close over this for warnings.
1996 (byte-compile-keep-pending form
))
1997 ((and (symbolp (car form
))
1998 (setq handler
(get (car form
) 'byte-hunk-handler
)))
1999 (cond ((setq form
(funcall handler form
))
2000 (byte-compile-flush-pending)
2001 (byte-compile-output-file-form form
))))
2002 ((eq form
(setq form
(macroexpand form byte-compile-macro-environment
)))
2003 (byte-compile-keep-pending form
))
2005 (byte-compile-file-form form
)))))
2007 ;; Functions and variables with doc strings must be output separately,
2008 ;; so make-docfile can recognise them. Most other things can be output
2011 (put 'defsubst
'byte-hunk-handler
'byte-compile-file-form-defsubst
)
2012 (defun byte-compile-file-form-defsubst (form)
2013 (cond ((assq (nth 1 form
) byte-compile-unresolved-functions
)
2014 (setq byte-compile-current-form
(nth 1 form
))
2015 (byte-compile-warn "defsubst %s was used before it was defined"
2017 (byte-compile-file-form
2018 (macroexpand form byte-compile-macro-environment
))
2019 ;; Return nil so the form is not output twice.
2022 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
2023 (defun byte-compile-file-form-autoload (form)
2024 (and (let ((form form
))
2025 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
2026 (null form
)) ;Constants only
2027 (eval (nth 5 form
)) ;Macro
2028 (eval form
)) ;Define the autoload.
2029 ;; Avoid undefined function warnings for the autoload.
2030 (if (and (consp (nth 1 form
))
2031 (eq (car (nth 1 form
)) 'quote
)
2032 (consp (cdr (nth 1 form
)))
2033 (symbolp (nth 1 (nth 1 form
))))
2034 (add-to-list 'byte-compile-function-environment
2035 (cons (nth 1 (nth 1 form
))
2036 (cons 'autoload
(cdr (cdr form
))))))
2037 (if (stringp (nth 3 form
))
2039 ;; No doc string, so we can compile this as a normal form.
2040 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
2042 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2043 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2044 (defun byte-compile-file-form-defvar (form)
2045 (if (null (nth 3 form
))
2046 ;; Since there is no doc string, we can compile this as a normal form,
2047 ;; and not do a file-boundary.
2048 (byte-compile-keep-pending form
)
2049 (if (memq 'free-vars byte-compile-warnings
)
2050 (setq byte-compile-bound-variables
2051 (cons (nth 1 form
) byte-compile-bound-variables
)))
2052 (cond ((consp (nth 2 form
))
2053 (setq form
(copy-sequence form
))
2054 (setcar (cdr (cdr form
))
2055 (byte-compile-top-level (nth 2 form
) nil
'file
))))
2058 (put 'custom-declare-variable
'byte-hunk-handler
2059 'byte-compile-file-form-custom-declare-variable
)
2060 (defun byte-compile-file-form-custom-declare-variable (form)
2061 (if (memq 'free-vars byte-compile-warnings
)
2062 (setq byte-compile-bound-variables
2063 (cons (nth 1 (nth 1 form
)) byte-compile-bound-variables
)))
2066 (put 'require
'byte-hunk-handler
'byte-compile-file-form-eval-boundary
)
2067 (defun byte-compile-file-form-eval-boundary (form)
2068 (let ((old-load-list current-load-list
))
2070 ;; (require 'cl) turns off warnings for cl functions.
2071 (let ((tem current-load-list
))
2072 (while (not (eq tem old-load-list
))
2073 (when (equal (car tem
) '(require . cl
))
2074 (setq byte-compile-warnings
2075 (remq 'cl-functions byte-compile-warnings
)))
2076 (setq tem
(cdr tem
)))))
2077 (byte-compile-keep-pending form
'byte-compile-normal-call
))
2079 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
2080 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
2081 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
2082 (defun byte-compile-file-form-progn (form)
2083 (mapc 'byte-compile-file-form
(cdr form
))
2084 ;; Return nil so the forms are not output twice.
2087 ;; This handler is not necessary, but it makes the output from dont-compile
2088 ;; and similar macros cleaner.
2089 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
2090 (defun byte-compile-file-form-eval (form)
2091 (if (eq (car-safe (nth 1 form
)) 'quote
)
2092 (nth 1 (nth 1 form
))
2093 (byte-compile-keep-pending form
)))
2095 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
2096 (defun byte-compile-file-form-defun (form)
2097 (byte-compile-file-form-defmumble form nil
))
2099 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
2100 (defun byte-compile-file-form-defmacro (form)
2101 (byte-compile-file-form-defmumble form t
))
2103 (defun byte-compile-file-form-defmumble (form macrop
)
2104 (let* ((name (car (cdr form
)))
2105 (this-kind (if macrop
'byte-compile-macro-environment
2106 'byte-compile-function-environment
))
2107 (that-kind (if macrop
'byte-compile-function-environment
2108 'byte-compile-macro-environment
))
2109 (this-one (assq name
(symbol-value this-kind
)))
2110 (that-one (assq name
(symbol-value that-kind
)))
2111 (byte-compile-free-references nil
)
2112 (byte-compile-free-assignments nil
))
2113 (byte-compile-set-symbol-position name
)
2114 ;; When a function or macro is defined, add it to the call tree so that
2115 ;; we can tell when functions are not used.
2116 (if byte-compile-generate-call-tree
2117 (or (assq name byte-compile-call-tree
)
2118 (setq byte-compile-call-tree
2119 (cons (list name nil nil
) byte-compile-call-tree
))))
2121 (setq byte-compile-current-form name
) ; for warnings
2122 (if (memq 'redefine byte-compile-warnings
)
2123 (byte-compile-arglist-warn form macrop
))
2124 (if byte-compile-verbose
2125 (message "Compiling %s... (%s)" (or filename
"") (nth 1 form
)))
2127 (if (and (memq 'redefine byte-compile-warnings
)
2128 ;; don't warn when compiling the stubs in byte-run...
2129 (not (assq (nth 1 form
)
2130 byte-compile-initial-macro-environment
)))
2132 "%s defined multiple times, as both function and macro"
2134 (setcdr that-one nil
))
2136 (when (and (memq 'redefine byte-compile-warnings
)
2137 ;; hack: don't warn when compiling the magic internal
2138 ;; byte-compiler macros in byte-run.el...
2139 (not (assq (nth 1 form
)
2140 byte-compile-initial-macro-environment
)))
2141 (byte-compile-warn "%s %s defined multiple times in this file"
2142 (if macrop
"macro" "function")
2144 ((and (fboundp name
)
2145 (eq (car-safe (symbol-function name
))
2146 (if macrop
'lambda
'macro
)))
2147 (when (memq 'redefine byte-compile-warnings
)
2148 (byte-compile-warn "%s %s being redefined as a %s"
2149 (if macrop
"function" "macro")
2151 (if macrop
"macro" "function")))
2152 ;; shadow existing definition
2154 (cons (cons name nil
) (symbol-value this-kind
))))
2156 (let ((body (nthcdr 3 form
)))
2157 (when (and (stringp (car body
))
2158 (symbolp (car-safe (cdr-safe body
)))
2159 (car-safe (cdr-safe body
))
2160 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
2161 (byte-compile-set-symbol-position (nth 1 form
))
2162 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2165 ;; Generate code for declarations in macro definitions.
2166 ;; Remove declarations from the body of the macro definition.
2168 (let ((tail (nthcdr 2 form
)))
2169 (when (stringp (car (cdr tail
)))
2170 (setq tail
(cdr tail
)))
2171 (while (and (consp (car (cdr tail
)))
2172 (eq (car (car (cdr tail
))) 'declare
))
2173 (let ((declaration (car (cdr tail
))))
2174 (setcdr tail
(cdr (cdr tail
)))
2175 (princ `(if macro-declaration-function
2176 (funcall macro-declaration-function
2177 ',name
',declaration
))
2180 (let* ((new-one (byte-compile-lambda (cons 'lambda
(nthcdr 2 form
))))
2181 (code (byte-compile-byte-code-maker new-one
)))
2183 (setcdr this-one new-one
)
2185 (cons (cons name new-one
) (symbol-value this-kind
))))
2186 (if (and (stringp (nth 3 form
))
2187 (eq 'quote
(car-safe code
))
2188 (eq 'lambda
(car-safe (nth 1 code
))))
2190 (cons name
(cdr (nth 1 code
))))
2191 (byte-compile-flush-pending)
2192 (if (not (stringp (nth 3 form
)))
2193 ;; No doc string. Provide -1 as the "doc string index"
2194 ;; so that no element will be treated as a doc string.
2195 (byte-compile-output-docform
2196 (if (byte-compile-version-cond byte-compile-compatibility
)
2197 "\n(fset '" "\n(defalias '")
2200 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]")))
2201 ((eq (car code
) 'quote
)
2203 (if macrop
'(" '(macro " -
1 ")") '(" '(" -
1 ")")))
2204 ((if macrop
'(" (cons 'macro (" -
1 "))") '(" (" -
1 ")"))))
2206 (and (atom code
) byte-compile-dynamic
2209 ;; Output the form by hand, that's much simpler than having
2210 ;; b-c-output-file-form analyze the defalias.
2211 (byte-compile-output-docform
2212 (if (byte-compile-version-cond byte-compile-compatibility
)
2213 "\n(fset '" "\n(defalias '")
2216 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2217 ((eq (car code
) 'quote
)
2219 (if macrop
'(" '(macro " 2 ")") '(" '(" 2 ")")))
2220 ((if macrop
'(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2222 (and (atom code
) byte-compile-dynamic
2225 (princ ")" outbuffer
)
2228 ;; Print Lisp object EXP in the output file, inside a comment,
2229 ;; and return the file position it will have.
2230 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2231 (defun byte-compile-output-as-comment (exp quoted
)
2232 (let ((position (point)))
2234 (prog1 (current-buffer)
2235 (set-buffer outbuffer
)
2237 ;; Insert EXP, and make it a comment with #@LENGTH.
2240 (prin1 exp outbuffer
)
2241 (princ exp outbuffer
))
2242 (goto-char position
)
2243 ;; Quote certain special characters as needed.
2244 ;; get_doc_string in doc.c does the unquoting.
2245 (while (search-forward "\^A" nil t
)
2246 (replace-match "\^A\^A" t t
))
2247 (goto-char position
)
2248 (while (search-forward "\000" nil t
)
2249 (replace-match "\^A0" t t
))
2250 (goto-char position
)
2251 (while (search-forward "\037" nil t
)
2252 (replace-match "\^A_" t t
))
2253 (goto-char (point-max))
2255 (goto-char position
)
2256 (insert "#@" (format "%d" (- (position-bytes (point-max))
2257 (position-bytes position
))))
2259 ;; Save the file position of the object.
2260 ;; Note we should add 1 to skip the space
2261 ;; that we inserted before the actual doc string,
2262 ;; and subtract 1 to convert from an 1-origin Emacs position
2263 ;; to a file position; they cancel.
2264 (setq position
(point))
2265 (goto-char (point-max))))
2271 (defun byte-compile (form)
2272 "If FORM is a symbol, byte-compile its function definition.
2273 If FORM is a lambda or a macro, byte-compile it as a function."
2274 (displaying-byte-compile-warnings
2275 (byte-compile-close-variables
2276 (let* ((fun (if (symbolp form
)
2277 (and (fboundp form
) (symbol-function form
))
2279 (macro (eq (car-safe fun
) 'macro
)))
2281 (setq fun
(cdr fun
)))
2282 (cond ((eq (car-safe fun
) 'lambda
)
2284 (cons 'macro
(byte-compile-lambda fun
))
2285 (byte-compile-lambda fun
)))
2290 (defun byte-compile-sexp (sexp)
2291 "Compile and return SEXP."
2292 (displaying-byte-compile-warnings
2293 (byte-compile-close-variables
2294 (byte-compile-top-level sexp
))))
2296 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2297 (defun byte-compile-byte-code-maker (fun)
2299 ((byte-compile-version-cond byte-compile-compatibility
)
2300 ;; Return (quote (lambda ...)).
2301 (list 'quote
(byte-compile-byte-code-unmake fun
)))
2302 ;; ## atom is faster than compiled-func-p.
2303 ((atom fun
) ; compiled function.
2304 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2305 ;; would have produced a lambda.
2307 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2308 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2310 (if (and (setq tmp
(assq 'byte-code
(cdr-safe (cdr fun
))))
2311 (null (cdr (memq tmp fun
))))
2312 ;; Generate a make-byte-code call.
2313 (let* ((interactive (assq 'interactive
(cdr (cdr fun
)))))
2314 (nconc (list 'make-byte-code
2315 (list 'quote
(nth 1 fun
)) ;arglist
2319 (cond ((stringp (nth 2 fun
))
2320 (list (nth 2 fun
))) ;doc
2324 (list (if (or (null (nth 1 interactive
))
2325 (stringp (nth 1 interactive
)))
2327 ;; Interactive spec is a list or a variable
2328 ;; (if it is correct).
2329 (list 'quote
(nth 1 interactive
))))))))
2330 ;; a non-compiled function (probably trivial)
2331 (list 'quote fun
))))))
2333 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2334 (defun byte-compile-byte-code-unmake (function)
2335 (if (consp function
)
2336 function
;;It already is a lambda.
2337 (setq function
(append function nil
)) ; turn it into a list
2338 (nconc (list 'lambda
(nth 0 function
))
2339 (and (nth 4 function
) (list (nth 4 function
)))
2340 (if (nthcdr 5 function
)
2341 (list (cons 'interactive
(if (nth 5 function
)
2342 (nthcdr 5 function
)))))
2343 (list (list 'byte-code
2344 (nth 1 function
) (nth 2 function
)
2345 (nth 3 function
))))))
2348 (defun byte-compile-check-lambda-list (list)
2349 "Check lambda-list LIST for errors."
2352 (let ((arg (car list
)))
2354 (byte-compile-set-symbol-position arg
))
2355 (cond ((or (not (symbolp arg
))
2357 (memq arg
'(t nil
)))
2358 (error "Invalid lambda variable %s" arg
))
2361 (error "&rest without variable name"))
2363 (error "Garbage following &rest VAR in lambda-list")))
2364 ((eq arg
'&optional
)
2366 (error "Variable name missing after &optional")))
2368 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2371 (setq list
(cdr list
)))))
2374 ;; Byte-compile a lambda-expression and return a valid function.
2375 ;; The value is usually a compiled function but may be the original
2376 ;; lambda-expression.
2377 (defun byte-compile-lambda (fun)
2378 (unless (eq 'lambda
(car-safe fun
))
2379 (error "Not a lambda list: %S" fun
))
2380 (byte-compile-set-symbol-position 'lambda
)
2381 (byte-compile-check-lambda-list (nth 1 fun
))
2382 (let* ((arglist (nth 1 fun
))
2383 (byte-compile-bound-variables
2384 (nconc (and (memq 'free-vars byte-compile-warnings
)
2385 (delq '&rest
(delq '&optional
(copy-sequence arglist
))))
2386 byte-compile-bound-variables
))
2387 (body (cdr (cdr fun
)))
2388 (doc (if (stringp (car body
))
2390 ;; Discard the doc string
2391 ;; unless it is the last element of the body.
2393 (setq body
(cdr body
))))))
2394 (int (assq 'interactive body
)))
2396 (byte-compile-set-symbol-position 'interactive
)
2397 ;; Skip (interactive) if it is in front (the most usual location).
2398 (if (eq int
(car body
))
2399 (setq body
(cdr body
)))
2400 (cond ((consp (cdr int
))
2402 (byte-compile-warn "malformed interactive spec: %s"
2403 (prin1-to-string int
)))
2404 ;; If the interactive spec is a call to `list',
2405 ;; don't compile it, because `call-interactively'
2406 ;; looks at the args of `list'.
2407 (let ((form (nth 1 int
)))
2408 (while (memq (car-safe form
) '(let let
* progn save-excursion
))
2409 (while (consp (cdr form
))
2410 (setq form
(cdr form
)))
2411 (setq form
(car form
)))
2412 (or (eq (car-safe form
) 'list
)
2413 (setq int
(list 'interactive
2414 (byte-compile-top-level (nth 1 int
)))))))
2416 (byte-compile-warn "malformed interactive spec: %s"
2417 (prin1-to-string int
))))))
2418 (let ((compiled (byte-compile-top-level (cons 'progn body
) nil
'lambda
)))
2419 (if (and (eq 'byte-code
(car-safe compiled
))
2420 (not (byte-compile-version-cond
2421 byte-compile-compatibility
)))
2422 (apply 'make-byte-code
2423 (append (list arglist
)
2424 ;; byte-string, constants-vector, stack depth
2426 ;; optionally, the doc string.
2429 ;; optionally, the interactive spec.
2431 (list (nth 1 int
)))))
2433 (nconc (if int
(list int
))
2434 (cond ((eq (car-safe compiled
) 'progn
) (cdr compiled
))
2435 (compiled (list compiled
)))))
2436 (nconc (list 'lambda arglist
)
2437 (if (or doc
(stringp (car compiled
)))
2438 (cons doc
(cond (compiled)
2442 (defun byte-compile-constants-vector ()
2443 ;; Builds the constants-vector from the current variables and constants.
2444 ;; This modifies the constants from (const . nil) to (const . offset).
2445 ;; To keep the byte-codes to look up the vector as short as possible:
2446 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2447 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2448 ;; Next variables again, to get 2-byte codes for variable lookup.
2449 ;; The rest of the constants and variables need 3-byte byte-codes.
2451 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2452 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2454 (limits '(5 ; Use the 1-byte varref codes,
2455 63 ; 1-constlim ; 1-byte byte-constant codes,
2456 255 ; 2-byte varref codes,
2457 65535)) ; 3-byte codes for the rest.
2459 (while (or rest other
)
2460 (setq limit
(car limits
))
2461 (while (and rest
(not (eq i limit
)))
2462 (if (setq tmp
(assq (car (car rest
)) ret
))
2463 (setcdr (car rest
) (cdr tmp
))
2464 (setcdr (car rest
) (setq i
(1+ i
)))
2465 (setq ret
(cons (car rest
) ret
)))
2466 (setq rest
(cdr rest
)))
2467 (setq limits
(cdr limits
)
2469 (setq other rest
))))
2470 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2472 ;; Given an expression FORM, compile it and return an equivalent byte-code
2473 ;; expression (a call to the function byte-code).
2474 (defun byte-compile-top-level (form &optional for-effect output-type
)
2475 ;; OUTPUT-TYPE advises about how form is expected to be used:
2476 ;; 'eval or nil -> a single form,
2477 ;; 'progn or t -> a list of forms,
2478 ;; 'lambda -> body of a lambda,
2479 ;; 'file -> used at file-level.
2480 (let ((byte-compile-constants nil
)
2481 (byte-compile-variables nil
)
2482 (byte-compile-tag-number 0)
2483 (byte-compile-depth 0)
2484 (byte-compile-maxdepth 0)
2485 (byte-compile-output nil
))
2486 (if (memq byte-optimize
'(t source
))
2487 (setq form
(byte-optimize-form form for-effect
)))
2488 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2489 (setq form
(nth 1 form
)))
2490 (if (and (eq 'byte-code
(car-safe form
))
2491 (not (memq byte-optimize
'(t byte
)))
2492 (stringp (nth 1 form
)) (vectorp (nth 2 form
))
2493 (natnump (nth 3 form
)))
2495 (byte-compile-form form for-effect
)
2496 (byte-compile-out-toplevel for-effect output-type
))))
2498 (defun byte-compile-out-toplevel (&optional for-effect output-type
)
2500 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2501 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2502 (setq byte-compile-output
(cdr byte-compile-output
))
2503 (byte-compile-push-constant
2504 ;; Push any constant - preferably one which already is used, and
2505 ;; a number or symbol - ie not some big sequence. The return value
2506 ;; isn't returned, but it would be a shame if some textually large
2507 ;; constant was not optimized away because we chose to return it.
2508 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2509 (let ((tmp (reverse byte-compile-constants
)))
2510 (while (and tmp
(not (or (symbolp (caar tmp
))
2511 (numberp (caar tmp
)))))
2512 (setq tmp
(cdr tmp
)))
2514 (byte-compile-out 'byte-return
0)
2515 (setq byte-compile-output
(nreverse byte-compile-output
))
2516 (if (memq byte-optimize
'(t byte
))
2517 (setq byte-compile-output
2518 (byte-optimize-lapcode byte-compile-output for-effect
)))
2520 ;; Decompile trivial functions:
2521 ;; only constants and variables, or a single funcall except in lambdas.
2522 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2523 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2524 ;; Note that even (quote foo) must be parsed just as any subr by the
2525 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2526 ;; What to leave uncompiled:
2527 ;; lambda -> never. we used to leave it uncompiled if the body was
2528 ;; a single atom, but that causes confusion if the docstring
2529 ;; uses the (file . pos) syntax. Besides, now that we have
2530 ;; the Lisp_Compiled type, the compiled form is faster.
2531 ;; eval -> atom, quote or (function atom atom atom)
2532 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2533 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2535 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2538 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2539 ((or (eq output-type
'lambda
)
2540 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2541 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2542 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2544 (setq rest
(nreverse
2545 (cdr (memq tmp
(reverse byte-compile-output
)))))
2547 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2548 (setq tmp
(car (cdr (car rest
))))
2549 (if (if (eq (car (car rest
)) 'byte-constant
)
2552 (not (byte-compile-const-symbol-p tmp
)))))
2554 (setq body
(cons (list 'quote tmp
) body
)))
2555 (setq body
(cons tmp body
))))
2557 ;; Allow a funcall if at most one atom follows it.
2558 (null (nthcdr 3 rest
))
2559 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2560 (or (null (cdr rest
))
2561 (and (memq output-type
'(file progn t
))
2563 (eq (car (nth 1 rest
)) 'byte-discard
)
2564 (progn (setq rest
(cdr rest
)) t
))))
2565 (setq maycall nil
) ; Only allow one real function call.
2566 (setq body
(nreverse body
))
2568 (if (and (eq tmp
'funcall
)
2569 (eq (car-safe (car body
)) 'quote
))
2570 (cons (nth 1 (car body
)) (cdr body
))
2572 (or (eq output-type
'file
)
2573 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2574 (setq rest
(cdr rest
)))
2576 (let ((byte-compile-vector (byte-compile-constants-vector)))
2577 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2578 byte-compile-vector byte-compile-maxdepth
)))
2579 ;; it's a trivial function
2580 ((cdr body
) (cons 'progn
(nreverse body
)))
2583 ;; Given BODY, compile it and return a new body.
2584 (defun byte-compile-top-level-body (body &optional for-effect
)
2585 (setq body
(byte-compile-top-level (cons 'progn body
) for-effect t
))
2586 (cond ((eq (car-safe body
) 'progn
)
2591 ;; This is the recursive entry point for compiling each subform of an
2593 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2594 ;; before terminating (ie no value will be left on the stack).
2595 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2596 ;; which does not leave a value on the stack, and then set for-effect to nil
2597 ;; (to prevent byte-compile-form from outputting the byte-discard).
2598 ;; If a handler wants to call another handler, it should do so via
2599 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2600 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2602 (defun byte-compile-form (form &optional for-effect
)
2603 (setq form
(macroexpand form byte-compile-macro-environment
))
2604 (cond ((not (consp form
))
2605 (when (symbolp form
)
2606 (byte-compile-set-symbol-position form
))
2607 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2608 (byte-compile-constant form
))
2609 ((and for-effect byte-compile-delete-errors
)
2610 (setq for-effect nil
))
2611 (t (byte-compile-variable-ref 'byte-varref form
))))
2612 ((symbolp (car form
))
2613 (let* ((fn (car form
))
2614 (handler (get fn
'byte-compile
)))
2615 (byte-compile-set-symbol-position fn
)
2616 (when (byte-compile-const-symbol-p fn
)
2617 (byte-compile-warn "%s called as a function" fn
))
2619 (or (not (byte-compile-version-cond
2620 byte-compile-compatibility
))
2621 (not (get (get fn
'byte-opcode
) 'emacs19-opcode
))))
2622 (funcall handler form
)
2623 (if (memq 'callargs byte-compile-warnings
)
2624 (byte-compile-callargs-warn form
))
2625 (byte-compile-normal-call form
))
2626 (if (memq 'cl-functions byte-compile-warnings
)
2627 (byte-compile-cl-warn form
))))
2628 ((and (or (byte-code-function-p (car form
))
2629 (eq (car-safe (car form
)) 'lambda
))
2630 ;; if the form comes out the same way it went in, that's
2631 ;; because it was malformed, and we couldn't unfold it.
2632 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
2633 (byte-compile-form form for-effect
)
2634 (setq for-effect nil
))
2635 ((byte-compile-normal-call form
)))
2637 (byte-compile-discard)))
2639 (defun byte-compile-normal-call (form)
2640 (if byte-compile-generate-call-tree
2641 (byte-compile-annotate-call-tree form
))
2642 (byte-compile-push-constant (car form
))
2643 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
2644 (byte-compile-out 'byte-call
(length (cdr form
))))
2646 (defun byte-compile-variable-ref (base-op var
)
2648 (byte-compile-set-symbol-position var
))
2649 (if (or (not (symbolp var
)) (byte-compile-const-symbol-p var
))
2650 (byte-compile-warn (if (eq base-op
'byte-varbind
)
2651 "attempt to let-bind %s %s"
2652 "variable reference to %s %s")
2653 (if (symbolp var
) "constant" "nonvariable")
2654 (prin1-to-string var
))
2655 (if (and (get var
'byte-obsolete-variable
)
2656 (memq 'obsolete byte-compile-warnings
))
2657 (let* ((ob (get var
'byte-obsolete-variable
))
2659 (byte-compile-warn "%s is an obsolete variable%s; %s" var
2660 (if when
(concat " since " when
) "")
2661 (if (stringp (car ob
))
2663 (format "use %s instead." (car ob
))))))
2664 (if (memq 'free-vars byte-compile-warnings
)
2665 (if (eq base-op
'byte-varbind
)
2666 (setq byte-compile-bound-variables
2667 (cons var byte-compile-bound-variables
))
2669 (memq var byte-compile-bound-variables
)
2670 (if (eq base-op
'byte-varset
)
2671 (or (memq var byte-compile-free-assignments
)
2673 (byte-compile-warn "assignment to free variable %s" var
)
2674 (setq byte-compile-free-assignments
2675 (cons var byte-compile-free-assignments
))))
2676 (or (memq var byte-compile-free-references
)
2678 (byte-compile-warn "reference to free variable %s" var
)
2679 (setq byte-compile-free-references
2680 (cons var byte-compile-free-references
)))))))))
2681 (let ((tmp (assq var byte-compile-variables
)))
2683 (setq tmp
(list var
)
2684 byte-compile-variables
(cons tmp byte-compile-variables
)))
2685 (byte-compile-out base-op tmp
)))
2687 (defmacro byte-compile-get-constant
(const)
2688 `(or (if (stringp ,const
)
2689 (assoc ,const byte-compile-constants
)
2690 (assq ,const byte-compile-constants
))
2691 (car (setq byte-compile-constants
2692 (cons (list ,const
) byte-compile-constants
)))))
2694 ;; Use this when the value of a form is a constant. This obeys for-effect.
2695 (defun byte-compile-constant (const)
2697 (setq for-effect nil
)
2698 (when (symbolp const
)
2699 (byte-compile-set-symbol-position const
))
2700 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
2702 ;; Use this for a constant that is not the value of its containing form.
2703 ;; This ignores for-effect.
2704 (defun byte-compile-push-constant (const)
2705 (let ((for-effect nil
))
2706 (inline (byte-compile-constant const
))))
2709 ;; Compile those primitive ordinary functions
2710 ;; which have special byte codes just for speed.
2712 (defmacro byte-defop-compiler
(function &optional compile-handler
)
2713 ;; add a compiler-form for FUNCTION.
2714 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2715 ;; the opcode to be used. If function is a list, the first element
2716 ;; is the function and the second element is the bytecode-symbol.
2717 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2718 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2719 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2721 (if (symbolp function
)
2722 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
2723 (setq opcode
(car (cdr function
))
2724 function
(car function
)))
2726 (list 'put
(list 'quote function
) ''byte-compile
2728 (or (cdr (assq compile-handler
2729 '((0 . byte-compile-no-args
)
2730 (1 . byte-compile-one-arg
)
2731 (2 . byte-compile-two-args
)
2732 (3 . byte-compile-three-args
)
2733 (0-1 . byte-compile-zero-or-one-arg
)
2734 (1-2 . byte-compile-one-or-two-args
)
2735 (2-3 . byte-compile-two-or-three-args
)
2738 (intern (concat "byte-compile-"
2739 (symbol-name function
))))))))
2742 (list 'put
(list 'quote function
)
2743 ''byte-opcode
(list 'quote opcode
))
2744 (list 'put
(list 'quote opcode
)
2745 ''byte-opcode-invert
(list 'quote function
)))
2748 (defmacro byte-defop-compiler19
(function &optional compile-handler
)
2749 ;; Just like byte-defop-compiler, but defines an opcode that will only
2750 ;; be used when byte-compile-compatibility is false.
2751 (if (and (byte-compile-single-version)
2752 byte-compile-compatibility
)
2753 ;; #### instead of doing nothing, this should do some remprops,
2754 ;; #### to protect against the case where a single-version compiler
2755 ;; #### is loaded into a world that has contained a multi-version one.
2760 (or (car (cdr-safe function
))
2761 (intern (concat "byte-"
2762 (symbol-name (or (car-safe function
) function
))))))
2764 (list 'byte-defop-compiler function compile-handler
))))
2766 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
2767 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
2770 (put 'byte-call
'byte-opcode-invert
'funcall
)
2771 (put 'byte-list1
'byte-opcode-invert
'list
)
2772 (put 'byte-list2
'byte-opcode-invert
'list
)
2773 (put 'byte-list3
'byte-opcode-invert
'list
)
2774 (put 'byte-list4
'byte-opcode-invert
'list
)
2775 (put 'byte-listN
'byte-opcode-invert
'list
)
2776 (put 'byte-concat2
'byte-opcode-invert
'concat
)
2777 (put 'byte-concat3
'byte-opcode-invert
'concat
)
2778 (put 'byte-concat4
'byte-opcode-invert
'concat
)
2779 (put 'byte-concatN
'byte-opcode-invert
'concat
)
2780 (put 'byte-insertN
'byte-opcode-invert
'insert
)
2782 (byte-defop-compiler (dot byte-point
) 0)
2783 (byte-defop-compiler (dot-max byte-point-max
) 0)
2784 (byte-defop-compiler (dot-min byte-point-min
) 0)
2785 (byte-defop-compiler point
0)
2786 ;;(byte-defop-compiler mark 0) ;; obsolete
2787 (byte-defop-compiler point-max
0)
2788 (byte-defop-compiler point-min
0)
2789 (byte-defop-compiler following-char
0)
2790 (byte-defop-compiler preceding-char
0)
2791 (byte-defop-compiler current-column
0)
2792 (byte-defop-compiler eolp
0)
2793 (byte-defop-compiler eobp
0)
2794 (byte-defop-compiler bolp
0)
2795 (byte-defop-compiler bobp
0)
2796 (byte-defop-compiler current-buffer
0)
2797 ;;(byte-defop-compiler read-char 0) ;; obsolete
2798 (byte-defop-compiler interactive-p
0)
2799 (byte-defop-compiler19 widen
0)
2800 (byte-defop-compiler19 end-of-line
0-
1)
2801 (byte-defop-compiler19 forward-char
0-
1)
2802 (byte-defop-compiler19 forward-line
0-
1)
2803 (byte-defop-compiler symbolp
1)
2804 (byte-defop-compiler consp
1)
2805 (byte-defop-compiler stringp
1)
2806 (byte-defop-compiler listp
1)
2807 (byte-defop-compiler not
1)
2808 (byte-defop-compiler (null byte-not
) 1)
2809 (byte-defop-compiler car
1)
2810 (byte-defop-compiler cdr
1)
2811 (byte-defop-compiler length
1)
2812 (byte-defop-compiler symbol-value
1)
2813 (byte-defop-compiler symbol-function
1)
2814 (byte-defop-compiler (1+ byte-add1
) 1)
2815 (byte-defop-compiler (1- byte-sub1
) 1)
2816 (byte-defop-compiler goto-char
1)
2817 (byte-defop-compiler char-after
0-
1)
2818 (byte-defop-compiler set-buffer
1)
2819 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2820 (byte-defop-compiler19 forward-word
1)
2821 (byte-defop-compiler19 char-syntax
1)
2822 (byte-defop-compiler19 nreverse
1)
2823 (byte-defop-compiler19 car-safe
1)
2824 (byte-defop-compiler19 cdr-safe
1)
2825 (byte-defop-compiler19 numberp
1)
2826 (byte-defop-compiler19 integerp
1)
2827 (byte-defop-compiler19 skip-chars-forward
1-
2)
2828 (byte-defop-compiler19 skip-chars-backward
1-
2)
2829 (byte-defop-compiler eq
2)
2830 (byte-defop-compiler memq
2)
2831 (byte-defop-compiler cons
2)
2832 (byte-defop-compiler aref
2)
2833 (byte-defop-compiler set
2)
2834 (byte-defop-compiler (= byte-eqlsign
) 2)
2835 (byte-defop-compiler (< byte-lss
) 2)
2836 (byte-defop-compiler (> byte-gtr
) 2)
2837 (byte-defop-compiler (<= byte-leq
) 2)
2838 (byte-defop-compiler (>= byte-geq
) 2)
2839 (byte-defop-compiler get
2)
2840 (byte-defop-compiler nth
2)
2841 (byte-defop-compiler substring
2-
3)
2842 (byte-defop-compiler19 (move-marker byte-set-marker
) 2-
3)
2843 (byte-defop-compiler19 set-marker
2-
3)
2844 (byte-defop-compiler19 match-beginning
1)
2845 (byte-defop-compiler19 match-end
1)
2846 (byte-defop-compiler19 upcase
1)
2847 (byte-defop-compiler19 downcase
1)
2848 (byte-defop-compiler19 string
= 2)
2849 (byte-defop-compiler19 string
< 2)
2850 (byte-defop-compiler19 (string-equal byte-string
=) 2)
2851 (byte-defop-compiler19 (string-lessp byte-string
<) 2)
2852 (byte-defop-compiler19 equal
2)
2853 (byte-defop-compiler19 nthcdr
2)
2854 (byte-defop-compiler19 elt
2)
2855 (byte-defop-compiler19 member
2)
2856 (byte-defop-compiler19 assq
2)
2857 (byte-defop-compiler19 (rplaca byte-setcar
) 2)
2858 (byte-defop-compiler19 (rplacd byte-setcdr
) 2)
2859 (byte-defop-compiler19 setcar
2)
2860 (byte-defop-compiler19 setcdr
2)
2861 (byte-defop-compiler19 buffer-substring
2)
2862 (byte-defop-compiler19 delete-region
2)
2863 (byte-defop-compiler19 narrow-to-region
2)
2864 (byte-defop-compiler19 (% byte-rem
) 2)
2865 (byte-defop-compiler aset
3)
2867 (byte-defop-compiler max byte-compile-associative
)
2868 (byte-defop-compiler min byte-compile-associative
)
2869 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
2870 (byte-defop-compiler19 (* byte-mult
) byte-compile-associative
)
2872 ;;####(byte-defop-compiler19 move-to-column 1)
2873 (byte-defop-compiler-1 interactive byte-compile-noop
)
2876 (defun byte-compile-subr-wrong-args (form n
)
2877 (byte-compile-set-symbol-position (car form
))
2878 (byte-compile-warn "%s called with %d arg%s, but requires %s"
2879 (car form
) (length (cdr form
))
2880 (if (= 1 (length (cdr form
))) "" "s") n
)
2881 ;; get run-time wrong-number-of-args error.
2882 (byte-compile-normal-call form
))
2884 (defun byte-compile-no-args (form)
2885 (if (not (= (length form
) 1))
2886 (byte-compile-subr-wrong-args form
"none")
2887 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2889 (defun byte-compile-one-arg (form)
2890 (if (not (= (length form
) 2))
2891 (byte-compile-subr-wrong-args form
1)
2892 (byte-compile-form (car (cdr form
))) ;; Push the argument
2893 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2895 (defun byte-compile-two-args (form)
2896 (if (not (= (length form
) 3))
2897 (byte-compile-subr-wrong-args form
2)
2898 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2899 (byte-compile-form (nth 2 form
))
2900 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2902 (defun byte-compile-three-args (form)
2903 (if (not (= (length form
) 4))
2904 (byte-compile-subr-wrong-args form
3)
2905 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2906 (byte-compile-form (nth 2 form
))
2907 (byte-compile-form (nth 3 form
))
2908 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2910 (defun byte-compile-zero-or-one-arg (form)
2911 (let ((len (length form
)))
2912 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
2913 ((= len
2) (byte-compile-one-arg form
))
2914 (t (byte-compile-subr-wrong-args form
"0-1")))))
2916 (defun byte-compile-one-or-two-args (form)
2917 (let ((len (length form
)))
2918 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
2919 ((= len
3) (byte-compile-two-args form
))
2920 (t (byte-compile-subr-wrong-args form
"1-2")))))
2922 (defun byte-compile-two-or-three-args (form)
2923 (let ((len (length form
)))
2924 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
2925 ((= len
4) (byte-compile-three-args form
))
2926 (t (byte-compile-subr-wrong-args form
"2-3")))))
2928 (defun byte-compile-noop (form)
2929 (byte-compile-constant nil
))
2931 (defun byte-compile-discard ()
2932 (byte-compile-out 'byte-discard
0))
2935 ;; Compile a function that accepts one or more args and is right-associative.
2936 ;; We do it by left-associativity so that the operations
2937 ;; are done in the same order as in interpreted code.
2938 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
2939 ;; in order to convert markers to numbers, and trigger expected errors.
2940 (defun byte-compile-associative (form)
2942 (let ((opcode (get (car form
) 'byte-opcode
))
2943 (args (copy-sequence (cdr form
))))
2944 (byte-compile-form (car args
))
2945 (setq args
(cdr args
))
2946 (or args
(setq args
'(0)
2947 opcode
(get '+ 'byte-opcode
)))
2949 (byte-compile-form (car args
))
2950 (byte-compile-out opcode
0)
2951 (setq args
(cdr args
))))
2952 (byte-compile-constant (eval form
))))
2955 ;; more complicated compiler macros
2957 (byte-defop-compiler list
)
2958 (byte-defop-compiler concat
)
2959 (byte-defop-compiler fset
)
2960 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
2961 (byte-defop-compiler indent-to
)
2962 (byte-defop-compiler insert
)
2963 (byte-defop-compiler-1 function byte-compile-function-form
)
2964 (byte-defop-compiler-1 - byte-compile-minus
)
2965 (byte-defop-compiler19 (/ byte-quo
) byte-compile-quo
)
2966 (byte-defop-compiler19 nconc
)
2968 (defun byte-compile-list (form)
2969 (let ((count (length (cdr form
))))
2971 (byte-compile-constant nil
))
2973 (mapc 'byte-compile-form
(cdr form
))
2975 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
2976 ((and (< count
256) (not (byte-compile-version-cond
2977 byte-compile-compatibility
)))
2978 (mapc 'byte-compile-form
(cdr form
))
2979 (byte-compile-out 'byte-listN count
))
2980 (t (byte-compile-normal-call form
)))))
2982 (defun byte-compile-concat (form)
2983 (let ((count (length (cdr form
))))
2984 (cond ((and (< 1 count
) (< count
5))
2985 (mapc 'byte-compile-form
(cdr form
))
2987 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
2989 ;; Concat of one arg is not a no-op if arg is not a string.
2991 (byte-compile-form ""))
2992 ((and (< count
256) (not (byte-compile-version-cond
2993 byte-compile-compatibility
)))
2994 (mapc 'byte-compile-form
(cdr form
))
2995 (byte-compile-out 'byte-concatN count
))
2996 ((byte-compile-normal-call form
)))))
2998 (defun byte-compile-minus (form)
2999 (if (null (setq form
(cdr form
)))
3000 (byte-compile-constant 0)
3001 (byte-compile-form (car form
))
3003 (while (setq form
(cdr form
))
3004 (byte-compile-form (car form
))
3005 (byte-compile-out 'byte-diff
0))
3006 (byte-compile-out 'byte-negate
0))))
3008 (defun byte-compile-quo (form)
3009 (let ((len (length form
)))
3011 (byte-compile-subr-wrong-args form
"2 or more"))
3013 (byte-compile-form (car (setq form
(cdr form
))))
3014 (while (setq form
(cdr form
))
3015 (byte-compile-form (car form
))
3016 (byte-compile-out 'byte-quo
0))))))
3018 (defun byte-compile-nconc (form)
3019 (let ((len (length form
)))
3021 (byte-compile-constant nil
))
3023 ;; nconc of one arg is a noop, even if that arg isn't a list.
3024 (byte-compile-form (nth 1 form
)))
3026 (byte-compile-form (car (setq form
(cdr form
))))
3027 (while (setq form
(cdr form
))
3028 (byte-compile-form (car form
))
3029 (byte-compile-out 'byte-nconc
0))))))
3031 (defun byte-compile-fset (form)
3032 ;; warn about forms like (fset 'foo '(lambda () ...))
3033 ;; (where the lambda expression is non-trivial...)
3034 (let ((fn (nth 2 form
))
3036 (if (and (eq (car-safe fn
) 'quote
)
3037 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
3039 (setq body
(cdr (cdr fn
)))
3040 (if (stringp (car body
)) (setq body
(cdr body
)))
3041 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
3042 (if (and (consp (car body
))
3043 (not (eq 'byte-code
(car (car body
)))))
3045 "A quoted lambda form is the second argument of fset. This is probably
3046 not what you want, as that lambda cannot be compiled. Consider using
3047 the syntax (function (lambda (...) ...)) instead.")))))
3048 (byte-compile-two-args form
))
3050 (defun byte-compile-funarg (form)
3051 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3052 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3053 (byte-compile-normal-call
3054 (let ((fn (nth 1 form
)))
3055 (if (and (eq (car-safe fn
) 'quote
)
3056 (eq (car-safe (nth 1 fn
)) 'lambda
))
3058 (cons (cons 'function
(cdr fn
))
3062 (defun byte-compile-funarg-2 (form)
3063 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3064 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3065 (byte-compile-normal-call
3066 (let ((fn (nth 2 form
)))
3067 (if (and (eq (car-safe fn
) 'quote
)
3068 (eq (car-safe (nth 1 fn
)) 'lambda
))
3071 (cons (cons 'function
(cdr fn
))
3072 (cdr (cdr (cdr form
))))))
3075 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3076 ;; Otherwise it will be incompatible with the interpreter,
3077 ;; and (funcall (function foo)) will lose with autoloads.
3079 (defun byte-compile-function-form (form)
3080 (byte-compile-constant
3081 (cond ((symbolp (nth 1 form
))
3083 ;; If we're not allowed to use #[] syntax, then output a form like
3084 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3085 ;; In this situation, calling make-byte-code at run-time will usually
3086 ;; be less efficient than processing a call to byte-code.
3087 ((byte-compile-version-cond byte-compile-compatibility
)
3088 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form
))))
3089 ((byte-compile-lambda (nth 1 form
))))))
3091 (defun byte-compile-indent-to (form)
3092 (let ((len (length form
)))
3094 (byte-compile-form (car (cdr form
)))
3095 (byte-compile-out 'byte-indent-to
0))
3097 ;; no opcode for 2-arg case.
3098 (byte-compile-normal-call form
))
3100 (byte-compile-subr-wrong-args form
"1-2")))))
3102 (defun byte-compile-insert (form)
3103 (cond ((null (cdr form
))
3104 (byte-compile-constant nil
))
3105 ((and (not (byte-compile-version-cond
3106 byte-compile-compatibility
))
3107 (<= (length form
) 256))
3108 (mapc 'byte-compile-form
(cdr form
))
3109 (if (cdr (cdr form
))
3110 (byte-compile-out 'byte-insertN
(length (cdr form
)))
3111 (byte-compile-out 'byte-insert
0)))
3112 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
3113 (byte-compile-normal-call form
))
3114 ;; We can split it; there is no function call after inserting 1st arg.
3116 (while (setq form
(cdr form
))
3117 (byte-compile-form (car form
))
3118 (byte-compile-out 'byte-insert
0)
3120 (byte-compile-discard))))))
3123 (byte-defop-compiler-1 setq
)
3124 (byte-defop-compiler-1 setq-default
)
3125 (byte-defop-compiler-1 quote
)
3126 (byte-defop-compiler-1 quote-form
)
3128 (defun byte-compile-setq (form)
3129 (let ((args (cdr form
)))
3132 (byte-compile-form (car (cdr args
)))
3133 (or for-effect
(cdr (cdr args
))
3134 (byte-compile-out 'byte-dup
0))
3135 (byte-compile-variable-ref 'byte-varset
(car args
))
3136 (setq args
(cdr (cdr args
))))
3137 ;; (setq), with no arguments.
3138 (byte-compile-form nil for-effect
))
3139 (setq for-effect nil
)))
3141 (defun byte-compile-setq-default (form)
3142 (let ((args (cdr form
))
3146 (cons (list 'set-default
(list 'quote
(car args
)) (car (cdr args
)))
3148 (setq args
(cdr (cdr args
))))
3149 (byte-compile-form (cons 'progn
(nreverse setters
)))))
3151 (defun byte-compile-quote (form)
3152 (byte-compile-constant (car (cdr form
))))
3154 (defun byte-compile-quote-form (form)
3155 (byte-compile-constant (byte-compile-top-level (nth 1 form
))))
3158 ;;; control structures
3160 (defun byte-compile-body (body &optional for-effect
)
3162 (byte-compile-form (car body
) t
)
3163 (setq body
(cdr body
)))
3164 (byte-compile-form (car body
) for-effect
))
3166 (defsubst byte-compile-body-do-effect
(body)
3167 (byte-compile-body body for-effect
)
3168 (setq for-effect nil
))
3170 (defsubst byte-compile-form-do-effect
(form)
3171 (byte-compile-form form for-effect
)
3172 (setq for-effect nil
))
3174 (byte-defop-compiler-1 inline byte-compile-progn
)
3175 (byte-defop-compiler-1 progn
)
3176 (byte-defop-compiler-1 prog1
)
3177 (byte-defop-compiler-1 prog2
)
3178 (byte-defop-compiler-1 if
)
3179 (byte-defop-compiler-1 cond
)
3180 (byte-defop-compiler-1 and
)
3181 (byte-defop-compiler-1 or
)
3182 (byte-defop-compiler-1 while
)
3183 (byte-defop-compiler-1 funcall
)
3184 (byte-defop-compiler-1 apply byte-compile-funarg
)
3185 (byte-defop-compiler-1 mapcar byte-compile-funarg
)
3186 (byte-defop-compiler-1 mapatoms byte-compile-funarg
)
3187 (byte-defop-compiler-1 mapconcat byte-compile-funarg
)
3188 (byte-defop-compiler-1 mapc byte-compile-funarg
)
3189 (byte-defop-compiler-1 maphash byte-compile-funarg
)
3190 (byte-defop-compiler-1 map-char-table byte-compile-funarg
)
3191 (byte-defop-compiler-1 sort byte-compile-funarg-2
)
3192 (byte-defop-compiler-1 let
)
3193 (byte-defop-compiler-1 let
*)
3195 (defun byte-compile-progn (form)
3196 (byte-compile-body-do-effect (cdr form
)))
3198 (defun byte-compile-prog1 (form)
3199 (byte-compile-form-do-effect (car (cdr form
)))
3200 (byte-compile-body (cdr (cdr form
)) t
))
3202 (defun byte-compile-prog2 (form)
3203 (byte-compile-form (nth 1 form
) t
)
3204 (byte-compile-form-do-effect (nth 2 form
))
3205 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3207 (defmacro byte-compile-goto-if
(cond discard tag
)
3210 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3211 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3214 (defun byte-compile-if (form)
3215 (byte-compile-form (car (cdr form
)))
3216 (if (null (nthcdr 3 form
))
3218 (let ((donetag (byte-compile-make-tag)))
3219 (byte-compile-goto-if nil for-effect donetag
)
3220 (byte-compile-form (nth 2 form
) for-effect
)
3221 (byte-compile-out-tag donetag
))
3222 (let ((donetag (byte-compile-make-tag)) (elsetag (byte-compile-make-tag)))
3223 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3224 (byte-compile-form (nth 2 form
) for-effect
)
3225 (byte-compile-goto 'byte-goto donetag
)
3226 (byte-compile-out-tag elsetag
)
3227 (byte-compile-body (cdr (cdr (cdr form
))) for-effect
)
3228 (byte-compile-out-tag donetag
)))
3229 (setq for-effect nil
))
3231 (defun byte-compile-cond (clauses)
3232 (let ((donetag (byte-compile-make-tag))
3234 (while (setq clauses
(cdr clauses
))
3235 (setq clause
(car clauses
))
3236 (cond ((or (eq (car clause
) t
)
3237 (and (eq (car-safe (car clause
)) 'quote
)
3238 (car-safe (cdr-safe (car clause
)))))
3239 ;; Unconditional clause
3240 (setq clause
(cons t clause
)
3243 (byte-compile-form (car clause
))
3244 (if (null (cdr clause
))
3245 ;; First clause is a singleton.
3246 (byte-compile-goto-if t for-effect donetag
)
3247 (setq nexttag
(byte-compile-make-tag))
3248 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3249 (byte-compile-body (cdr clause
) for-effect
)
3250 (byte-compile-goto 'byte-goto donetag
)
3251 (byte-compile-out-tag nexttag
)))))
3253 (and (cdr clause
) (not (eq (car clause
) t
))
3254 (progn (byte-compile-form (car clause
))
3255 (byte-compile-goto-if nil for-effect donetag
)
3256 (setq clause
(cdr clause
))))
3257 (byte-compile-body-do-effect clause
)
3258 (byte-compile-out-tag donetag
)))
3260 (defun byte-compile-and (form)
3261 (let ((failtag (byte-compile-make-tag))
3264 (byte-compile-form-do-effect t
)
3266 (byte-compile-form (car args
))
3267 (byte-compile-goto-if nil for-effect failtag
)
3268 (setq args
(cdr args
)))
3269 (byte-compile-form-do-effect (car args
))
3270 (byte-compile-out-tag failtag
))))
3272 (defun byte-compile-or (form)
3273 (let ((wintag (byte-compile-make-tag))
3276 (byte-compile-form-do-effect nil
)
3278 (byte-compile-form (car args
))
3279 (byte-compile-goto-if t for-effect wintag
)
3280 (setq args
(cdr args
)))
3281 (byte-compile-form-do-effect (car args
))
3282 (byte-compile-out-tag wintag
))))
3284 (defun byte-compile-while (form)
3285 (let ((endtag (byte-compile-make-tag))
3286 (looptag (byte-compile-make-tag)))
3287 (byte-compile-out-tag looptag
)
3288 (byte-compile-form (car (cdr form
)))
3289 (byte-compile-goto-if nil for-effect endtag
)
3290 (byte-compile-body (cdr (cdr form
)) t
)
3291 (byte-compile-goto 'byte-goto looptag
)
3292 (byte-compile-out-tag endtag
)
3293 (setq for-effect nil
)))
3295 (defun byte-compile-funcall (form)
3296 (mapc 'byte-compile-form
(cdr form
))
3297 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3300 (defun byte-compile-let (form)
3301 ;; First compute the binding values in the old scope.
3302 (let ((varlist (car (cdr form
))))
3304 (if (consp (car varlist
))
3305 (byte-compile-form (car (cdr (car varlist
))))
3306 (byte-compile-push-constant nil
))
3307 (setq varlist
(cdr varlist
))))
3308 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3309 (varlist (reverse (car (cdr form
)))))
3311 (byte-compile-variable-ref 'byte-varbind
(if (consp (car varlist
))
3314 (setq varlist
(cdr varlist
)))
3315 (byte-compile-body-do-effect (cdr (cdr form
)))
3316 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3318 (defun byte-compile-let* (form)
3319 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3320 (varlist (copy-sequence (car (cdr form
)))))
3322 (if (atom (car varlist
))
3323 (byte-compile-push-constant nil
)
3324 (byte-compile-form (car (cdr (car varlist
))))
3325 (setcar varlist
(car (car varlist
))))
3326 (byte-compile-variable-ref 'byte-varbind
(car varlist
))
3327 (setq varlist
(cdr varlist
)))
3328 (byte-compile-body-do-effect (cdr (cdr form
)))
3329 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3332 (byte-defop-compiler-1 /= byte-compile-negated
)
3333 (byte-defop-compiler-1 atom byte-compile-negated
)
3334 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3336 (put '/= 'byte-compile-negated-op
'=)
3337 (put 'atom
'byte-compile-negated-op
'consp
)
3338 (put 'nlistp
'byte-compile-negated-op
'listp
)
3340 (defun byte-compile-negated (form)
3341 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3343 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3344 (defun byte-compile-negation-optimizer (form)
3345 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3346 (byte-compile-set-symbol-position (car form
))
3348 (cons (or (get (car form
) 'byte-compile-negated-op
)
3350 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3354 ;;; other tricky macro-like special-forms
3356 (byte-defop-compiler-1 catch
)
3357 (byte-defop-compiler-1 unwind-protect
)
3358 (byte-defop-compiler-1 condition-case
)
3359 (byte-defop-compiler-1 save-excursion
)
3360 (byte-defop-compiler-1 save-current-buffer
)
3361 (byte-defop-compiler-1 save-restriction
)
3362 (byte-defop-compiler-1 save-window-excursion
)
3363 (byte-defop-compiler-1 with-output-to-temp-buffer
)
3364 (byte-defop-compiler-1 track-mouse
)
3366 (defun byte-compile-catch (form)
3367 (byte-compile-form (car (cdr form
)))
3368 (byte-compile-push-constant
3369 (byte-compile-top-level (cons 'progn
(cdr (cdr form
))) for-effect
))
3370 (byte-compile-out 'byte-catch
0))
3372 (defun byte-compile-unwind-protect (form)
3373 (byte-compile-push-constant
3374 (byte-compile-top-level-body (cdr (cdr form
)) t
))
3375 (byte-compile-out 'byte-unwind-protect
0)
3376 (byte-compile-form-do-effect (car (cdr form
)))
3377 (byte-compile-out 'byte-unbind
1))
3379 (defun byte-compile-track-mouse (form)
3386 (byte-compile-top-level-body (cdr form
))))))))
3388 (defun byte-compile-condition-case (form)
3389 (let* ((var (nth 1 form
))
3390 (byte-compile-bound-variables
3391 (if var
(cons var byte-compile-bound-variables
)
3392 byte-compile-bound-variables
)))
3393 (byte-compile-set-symbol-position 'condition-case
)
3394 (unless (symbolp var
)
3396 "%s is not a variable-name or nil (in condition-case)" var
))
3397 (byte-compile-push-constant var
)
3398 (byte-compile-push-constant (byte-compile-top-level
3399 (nth 2 form
) for-effect
))
3400 (let ((clauses (cdr (cdr (cdr form
))))
3403 (let* ((clause (car clauses
))
3404 (condition (car clause
)))
3405 (cond ((not (or (symbolp condition
)
3406 (and (listp condition
)
3407 (let ((syms condition
) (ok t
))
3409 (if (not (symbolp (car syms
)))
3411 (setq syms
(cdr syms
)))
3414 "%s is not a condition name or list of such (in condition-case)"
3415 (prin1-to-string condition
)))
3416 ;; ((not (or (eq condition 't)
3417 ;; (and (stringp (get condition 'error-message))
3418 ;; (consp (get condition 'error-conditions)))))
3419 ;; (byte-compile-warn
3420 ;; "%s is not a known condition name (in condition-case)"
3423 (setq compiled-clauses
3424 (cons (cons condition
3425 (byte-compile-top-level-body
3426 (cdr clause
) for-effect
))
3428 (setq clauses
(cdr clauses
)))
3429 (byte-compile-push-constant (nreverse compiled-clauses
)))
3430 (byte-compile-out 'byte-condition-case
0)))
3433 (defun byte-compile-save-excursion (form)
3434 (byte-compile-out 'byte-save-excursion
0)
3435 (byte-compile-body-do-effect (cdr form
))
3436 (byte-compile-out 'byte-unbind
1))
3438 (defun byte-compile-save-restriction (form)
3439 (byte-compile-out 'byte-save-restriction
0)
3440 (byte-compile-body-do-effect (cdr form
))
3441 (byte-compile-out 'byte-unbind
1))
3443 (defun byte-compile-save-current-buffer (form)
3444 (byte-compile-out 'byte-save-current-buffer
0)
3445 (byte-compile-body-do-effect (cdr form
))
3446 (byte-compile-out 'byte-unbind
1))
3448 (defun byte-compile-save-window-excursion (form)
3449 (byte-compile-push-constant
3450 (byte-compile-top-level-body (cdr form
) for-effect
))
3451 (byte-compile-out 'byte-save-window-excursion
0))
3453 (defun byte-compile-with-output-to-temp-buffer (form)
3454 (byte-compile-form (car (cdr form
)))
3455 (byte-compile-out 'byte-temp-output-buffer-setup
0)
3456 (byte-compile-body (cdr (cdr form
)))
3457 (byte-compile-out 'byte-temp-output-buffer-show
0))
3460 ;;; top-level forms elsewhere
3462 (byte-defop-compiler-1 defun
)
3463 (byte-defop-compiler-1 defmacro
)
3464 (byte-defop-compiler-1 defvar
)
3465 (byte-defop-compiler-1 defconst byte-compile-defvar
)
3466 (byte-defop-compiler-1 autoload
)
3467 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
3468 (byte-defop-compiler-1 defalias
)
3470 (defun byte-compile-defun (form)
3471 ;; This is not used for file-level defuns with doc strings.
3472 (if (symbolp (car form
))
3473 (byte-compile-set-symbol-position (car form
))
3474 (byte-compile-set-symbol-position 'defun
)
3475 (error "defun name must be a symbol, not %s" (car form
)))
3476 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3477 (list 'fset
(list 'quote
(nth 1 form
))
3478 (byte-compile-byte-code-maker
3479 (byte-compile-lambda (cons 'lambda
(cdr (cdr form
)))))))
3480 (byte-compile-discard)
3481 (byte-compile-constant (nth 1 form
)))
3483 (defun byte-compile-defmacro (form)
3484 ;; This is not used for file-level defmacros with doc strings.
3485 (byte-compile-body-do-effect
3486 (list (list 'fset
(list 'quote
(nth 1 form
))
3487 (let ((code (byte-compile-byte-code-maker
3488 (byte-compile-lambda
3489 (cons 'lambda
(cdr (cdr form
)))))))
3490 (if (eq (car-safe code
) 'make-byte-code
)
3491 (list 'cons
''macro code
)
3492 (list 'quote
(cons 'macro
(eval code
))))))
3493 (list 'quote
(nth 1 form
)))))
3495 (defun byte-compile-defvar (form)
3496 ;; This is not used for file-level defvar/consts with doc strings.
3497 (let ((fun (nth 0 form
))
3499 (value (nth 2 form
))
3500 (string (nth 3 form
)))
3501 (byte-compile-set-symbol-position fun
)
3502 (when (> (length form
) 4)
3504 "%s %s called with %d arguments, but accepts only %s"
3505 fun var
(length (cdr form
)) 3))
3506 (when (memq 'free-vars byte-compile-warnings
)
3507 (setq byte-compile-bound-variables
3508 (cons var byte-compile-bound-variables
)))
3509 (byte-compile-body-do-effect
3511 ;; Put the defined variable in this library's load-history entry
3512 ;; just as a real defvar would, but only in top-level forms.
3513 (when (and (cddr form
) (null byte-compile-current-form
))
3514 `(push ',var current-load-list
))
3515 (when (> (length form
) 3)
3516 (when (and string
(not (stringp string
)))
3517 (byte-compile-warn "third arg to %s %s is not a string: %s"
3519 `(put ',var
'variable-documentation
,string
))
3520 (if (cddr form
) ; `value' provided
3521 (if (eq fun
'defconst
)
3522 ;; `defconst' sets `var' unconditionally.
3523 (let ((tmp (make-symbol "defconst-tmp-var")))
3524 `(let ((,tmp
,value
))
3525 (eval '(defconst ,var
,tmp
))))
3526 ;; `defvar' sets `var' only when unbound.
3527 `(if (not (boundp ',var
)) (setq ,var
,value
))))
3530 (defun byte-compile-autoload (form)
3531 (byte-compile-set-symbol-position 'autoload
)
3532 (and (byte-compile-constp (nth 1 form
))
3533 (byte-compile-constp (nth 5 form
))
3534 (eval (nth 5 form
)) ; macro-p
3535 (not (fboundp (eval (nth 1 form
))))
3537 "The compiler ignores `autoload' except at top level. You should
3538 probably put the autoload of the macro `%s' at top-level."
3539 (eval (nth 1 form
))))
3540 (byte-compile-normal-call form
))
3542 ;; Lambdas in valid places are handled as special cases by various code.
3543 ;; The ones that remain are errors.
3544 (defun byte-compile-lambda-form (form)
3545 (byte-compile-set-symbol-position 'lambda
)
3546 (error "`lambda' used as function name is invalid"))
3548 ;; Compile normally, but deal with warnings for the function being defined.
3549 (defun byte-compile-defalias (form)
3550 (if (and (consp (cdr form
)) (consp (nth 1 form
))
3551 (eq (car (nth 1 form
)) 'quote
)
3552 (consp (cdr (nth 1 form
)))
3553 (symbolp (nth 1 (nth 1 form
)))
3554 (consp (nthcdr 2 form
))
3555 (consp (nth 2 form
))
3556 (eq (car (nth 2 form
)) 'quote
)
3557 (consp (cdr (nth 2 form
)))
3558 (symbolp (nth 1 (nth 2 form
))))
3560 (byte-compile-defalias-warn (nth 1 (nth 1 form
))
3561 (nth 1 (nth 2 form
)))
3562 (setq byte-compile-function-environment
3563 (cons (cons (nth 1 (nth 1 form
))
3564 (nth 1 (nth 2 form
)))
3565 byte-compile-function-environment
))))
3566 (byte-compile-normal-call form
))
3568 ;; Turn off warnings about prior calls to the function being defalias'd.
3569 ;; This could be smarter and compare those calls with
3570 ;; the function it is being aliased to.
3571 (defun byte-compile-defalias-warn (new alias
)
3572 (let ((calls (assq new byte-compile-unresolved-functions
)))
3574 (setq byte-compile-unresolved-functions
3575 (delq calls byte-compile-unresolved-functions
)))))
3579 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3580 ;; optimization to have the 'TAG as a part of the tag.
3581 ;; Tags will be (TAG . (tag-number . stack-depth)).
3582 (defun byte-compile-make-tag ()
3583 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
3586 (defun byte-compile-out-tag (tag)
3587 (setq byte-compile-output
(cons tag byte-compile-output
))
3590 ;; ## remove this someday
3591 (and byte-compile-depth
3592 (not (= (cdr (cdr tag
)) byte-compile-depth
))
3593 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
3594 (setq byte-compile-depth
(cdr (cdr tag
))))
3595 (setcdr (cdr tag
) byte-compile-depth
)))
3597 (defun byte-compile-goto (opcode tag
)
3598 (setq byte-compile-output
(cons (cons opcode tag
) byte-compile-output
))
3599 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
3600 (1- byte-compile-depth
)
3601 byte-compile-depth
))
3602 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
3603 (1- byte-compile-depth
))))
3605 (defun byte-compile-out (opcode offset
)
3606 (setq byte-compile-output
(cons (cons opcode offset
) byte-compile-output
))
3607 (cond ((eq opcode
'byte-call
)
3608 (setq byte-compile-depth
(- byte-compile-depth offset
)))
3609 ((eq opcode
'byte-return
)
3610 ;; This is actually an unnecessary case, because there should be
3611 ;; no more opcodes behind byte-return.
3612 (setq byte-compile-depth nil
))
3614 (setq byte-compile-depth
(+ byte-compile-depth
3615 (or (aref byte-stack
+-info
3616 (symbol-value opcode
))
3618 byte-compile-maxdepth
(max byte-compile-depth
3619 byte-compile-maxdepth
))))
3620 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3626 (defun byte-compile-annotate-call-tree (form)
3628 ;; annotate the current call
3629 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
3630 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
3632 (cons byte-compile-current-form
(nth 1 entry
))))
3633 (setq byte-compile-call-tree
3634 (cons (list (car form
) (list byte-compile-current-form
) nil
)
3635 byte-compile-call-tree
)))
3636 ;; annotate the current function
3637 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
3638 (or (memq (car form
) (nth 2 entry
)) ;called
3639 (setcar (cdr (cdr entry
))
3640 (cons (car form
) (nth 2 entry
))))
3641 (setq byte-compile-call-tree
3642 (cons (list byte-compile-current-form nil
(list (car form
)))
3643 byte-compile-call-tree
)))
3646 ;; Renamed from byte-compile-report-call-tree
3647 ;; to avoid interfering with completion of byte-compile-file.
3649 (defun display-call-tree (&optional filename
)
3650 "Display a call graph of a specified file.
3651 This lists which functions have been called, what functions called
3652 them, and what functions they call. The list includes all functions
3653 whose definitions have been compiled in this Emacs session, as well as
3654 all functions called by those functions.
3656 The call graph does not include macros, inline functions, or
3657 primitives that the byte-code interpreter knows about directly \(eq,
3660 The call tree also lists those functions which are not known to be called
3661 \(that is, to which no calls have been compiled\), and which cannot be
3662 invoked interactively."
3664 (message "Generating call tree...")
3665 (with-output-to-temp-buffer "*Call-Tree*"
3666 (set-buffer "*Call-Tree*")
3668 (message "Generating call tree... (sorting on %s)"
3669 byte-compile-call-tree-sort
)
3670 (insert "Call tree for "
3671 (cond ((null byte-compile-current-file
) (or filename
"???"))
3672 ((stringp byte-compile-current-file
)
3673 byte-compile-current-file
)
3674 (t (buffer-name byte-compile-current-file
)))
3676 (prin1-to-string byte-compile-call-tree-sort
)
3678 (if byte-compile-call-tree-sort
3679 (setq byte-compile-call-tree
3680 (sort byte-compile-call-tree
3681 (cond ((eq byte-compile-call-tree-sort
'callers
)
3682 (function (lambda (x y
) (< (length (nth 1 x
))
3683 (length (nth 1 y
))))))
3684 ((eq byte-compile-call-tree-sort
'calls
)
3685 (function (lambda (x y
) (< (length (nth 2 x
))
3686 (length (nth 2 y
))))))
3687 ((eq byte-compile-call-tree-sort
'calls
+callers
)
3688 (function (lambda (x y
) (< (+ (length (nth 1 x
))
3690 (+ (length (nth 1 y
))
3691 (length (nth 2 y
)))))))
3692 ((eq byte-compile-call-tree-sort
'name
)
3693 (function (lambda (x y
) (string< (car x
)
3695 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3696 byte-compile-call-tree-sort
))))))
3697 (message "Generating call tree...")
3698 (let ((rest byte-compile-call-tree
)
3699 (b (current-buffer))
3703 (prin1 (car (car rest
)) b
)
3704 (setq callers
(nth 1 (car rest
))
3705 calls
(nth 2 (car rest
)))
3707 (cond ((not (fboundp (setq f
(car (car rest
)))))
3709 " <top level>";; shouldn't insert nil then, actually -sk
3711 ((subrp (setq f
(symbol-function f
)))
3714 (format " ==> %s" f
))
3715 ((byte-code-function-p f
)
3716 "<compiled function>")
3718 "<malformed function>")
3719 ((eq 'macro
(car f
))
3720 (if (or (byte-code-function-p (cdr f
))
3721 (assq 'byte-code
(cdr (cdr (cdr f
)))))
3724 ((assq 'byte-code
(cdr (cdr f
)))
3725 "<compiled lambda>")
3726 ((eq 'lambda
(car f
))
3729 (format " (%d callers + %d calls = %d)"
3730 ;; Does the optimizer eliminate common subexpressions?-sk
3733 (+ (length callers
) (length calls
)))
3737 (insert " called by:\n")
3739 (insert " " (if (car callers
)
3740 (mapconcat 'symbol-name callers
", ")
3742 (let ((fill-prefix " "))
3743 (fill-region-as-paragraph p
(point)))))
3746 (insert " calls:\n")
3748 (insert " " (mapconcat 'symbol-name calls
", "))
3749 (let ((fill-prefix " "))
3750 (fill-region-as-paragraph p
(point)))))
3752 (setq rest
(cdr rest
)))
3754 (message "Generating call tree...(finding uncalled functions...)")
3755 (setq rest byte-compile-call-tree
)
3756 (let ((uncalled nil
))
3758 (or (nth 1 (car rest
))
3759 (null (setq f
(car (car rest
))))
3760 (byte-compile-fdefinition f t
)
3761 (commandp (byte-compile-fdefinition f nil
))
3762 (setq uncalled
(cons f uncalled
)))
3763 (setq rest
(cdr rest
)))
3765 (let ((fill-prefix " "))
3766 (insert "Noninteractive functions not known to be called:\n ")
3768 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
3769 (fill-region-as-paragraph p
(point)))))
3771 (message "Generating call tree...done.")
3776 (defun batch-byte-compile-if-not-done ()
3777 "Like `byte-compile-file' but doesn't recompile if already up to date.
3778 Use this from the command line, with `-batch';
3779 it won't work in an interactive Emacs."
3780 (batch-byte-compile t
))
3782 ;;; by crl@newton.purdue.edu
3783 ;;; Only works noninteractively.
3785 (defun batch-byte-compile (&optional noforce
)
3786 "Run `byte-compile-file' on the files remaining on the command line.
3787 Use this from the command line, with `-batch';
3788 it won't work in an interactive Emacs.
3789 Each file is processed even if an error occurred previously.
3790 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
3791 If NOFORCE is non-nil, don't recompile a file that seems to be
3792 already up-to-date."
3793 ;; command-line-args-left is what is left of the command line (from startup.el)
3794 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3795 (if (not noninteractive
)
3796 (error "`batch-byte-compile' is to be used only with -batch"))
3798 (while command-line-args-left
3799 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
3800 ;; Directory as argument.
3801 (let ((files (directory-files (car command-line-args-left
)))
3803 (dolist (file files
)
3804 (if (and (string-match emacs-lisp-file-regexp file
)
3805 (not (auto-save-file-name-p file
))
3806 (setq source
(expand-file-name file
3807 (car command-line-args-left
)))
3808 (setq dest
(byte-compile-dest-file source
))
3809 (file-exists-p dest
)
3810 (file-newer-than-file-p source dest
))
3811 (if (null (batch-byte-compile-file source
))
3813 ;; Specific file argument
3814 (if (or (not noforce
)
3815 (let* ((source (car command-line-args-left
))
3816 (dest (byte-compile-dest-file source
)))
3817 (or (not (file-exists-p dest
))
3818 (file-newer-than-file-p source dest
))))
3819 (if (null (batch-byte-compile-file (car command-line-args-left
)))
3821 (setq command-line-args-left
(cdr command-line-args-left
)))
3822 (kill-emacs (if error
1 0))))
3824 (defun batch-byte-compile-file (file)
3826 (byte-compile-file file
)
3828 (message (if (cdr err
)
3829 ">>Error occurred processing %s: %s (%s)"
3830 ">>Error occurred processing %s: %s")
3832 (get (car err
) 'error-message
)
3833 (prin1-to-string (cdr err
)))
3834 (let ((destfile (byte-compile-dest-file file
)))
3835 (if (file-exists-p destfile
)
3836 (delete-file destfile
)))
3839 (message (if (cdr err
)
3840 ">>Error occurred processing %s: %s (%s)"
3841 ">>Error occurred processing %s: %s")
3843 (get (car err
) 'error-message
)
3844 (prin1-to-string (cdr err
)))
3848 (defun batch-byte-recompile-directory ()
3849 "Run `byte-recompile-directory' on the dirs remaining on the command line.
3850 Must be used only with `-batch', and kills Emacs on completion.
3851 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'."
3852 ;; command-line-args-left is what is left of the command line (startup.el)
3853 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3854 (if (not noninteractive
)
3855 (error "batch-byte-recompile-directory is to be used only with -batch"))
3856 (or command-line-args-left
3857 (setq command-line-args-left
'(".")))
3858 (while command-line-args-left
3859 (byte-recompile-directory (car command-line-args-left
))
3860 (setq command-line-args-left
(cdr command-line-args-left
)))
3864 (make-obsolete-variable 'auto-fill-hook
'auto-fill-function
"before 19.15")
3865 (make-obsolete-variable 'blink-paren-hook
'blink-paren-function
"before 19.15")
3866 (make-obsolete-variable 'lisp-indent-hook
'lisp-indent-function
"before 19.15")
3867 (make-obsolete-variable 'inhibit-local-variables
3868 "use enable-local-variables (with the reversed sense)."
3870 (make-obsolete-variable 'unread-command-event
3871 "use unread-command-events; which is a list of events rather than a single event."
3873 (make-obsolete-variable 'suspend-hooks
'suspend-hook
"before 19.15")
3874 (make-obsolete-variable 'comment-indent-hook
'comment-indent-function
"before 19.15")
3875 (make-obsolete-variable 'meta-flag
"use the set-input-mode function instead." "before 19.34")
3876 (make-obsolete-variable 'before-change-function
3877 "use before-change-functions; which is a list of functions rather than a single function."
3879 (make-obsolete-variable 'after-change-function
3880 "use after-change-functions; which is a list of functions rather than a single function."
3882 (make-obsolete-variable 'font-lock-doc-string-face
'font-lock-string-face
"before 19.34")
3884 (provide 'byte-compile
)
3888 ;;; report metering (see the hacks in bytecode.c)
3890 (defun byte-compile-report-ops ()
3891 (defvar byte-code-meter
)
3892 (with-output-to-temp-buffer "*Meter*"
3893 (set-buffer "*Meter*")
3894 (let ((i 0) n op off
)
3896 (setq n
(aref (aref byte-code-meter
0) i
)
3898 (if t
;(not (zerop n))
3902 (cond ((< op byte-nth
)
3903 (setq off
(logand op
7))
3904 (setq op
(logand op
248)))
3905 ((>= op byte-constant
)
3906 (setq off
(- op byte-constant
)
3908 (setq op
(aref byte-code-vector op
))
3909 (insert (format "%-4d" i
))
3910 (insert (symbol-name op
))
3911 (if off
(insert " [" (int-to-string off
) "]"))
3913 (insert (int-to-string n
) "\n")))
3916 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
3917 ;; itself, compile some of its most used recursive functions (at load time).
3920 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
3921 (assq 'byte-code
(symbol-function 'byte-compile-form
))
3922 (let ((byte-optimize nil
) ; do it fast
3923 (byte-compile-warnings nil
))
3925 (or noninteractive
(message "compiling %s..." x
))
3927 (or noninteractive
(message "compiling %s...done" x
)))
3928 '(byte-compile-normal-call
3931 ;; Inserted some more than necessary, to speed it up.
3932 byte-compile-top-level
3933 byte-compile-out-toplevel
3934 byte-compile-constant
3935 byte-compile-variable-ref
))))
3938 (run-hooks 'bytecomp-load-hook
)
3940 ;;; bytecomp.el ends here