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.124 $")
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!
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-const-variables nil
407 "List of variables declared as constants during compilation of this file.")
408 (defvar byte-compile-free-references
)
409 (defvar byte-compile-free-assignments
)
411 (defvar byte-compiler-error-flag
)
413 (defconst byte-compile-initial-macro-environment
415 ;; (byte-compiler-options . (lambda (&rest forms)
416 ;; (apply 'byte-compiler-options-handler forms)))
417 (eval-when-compile .
(lambda (&rest body
)
419 (byte-compile-eval (byte-compile-top-level
420 (cons 'progn body
))))))
421 (eval-and-compile .
(lambda (&rest body
)
422 (byte-compile-eval-before-compile (cons 'progn body
))
423 (cons 'progn body
))))
424 "The default macro-environment passed to macroexpand by the compiler.
425 Placing a macro here will cause a macro to have different semantics when
426 expanded by the compiler as when expanded by the interpreter.")
428 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
429 "Alist of macros defined in the file being compiled.
430 Each element looks like (MACRONAME . DEFINITION). It is
431 \(MACRONAME . nil) when a macro is redefined as a function.")
433 (defvar byte-compile-function-environment nil
434 "Alist of functions defined in the file being compiled.
435 This is so we can inline them when necessary.
436 Each element looks like (FUNCTIONNAME . DEFINITION). It is
437 \(FUNCTIONNAME . nil) when a function is redefined as a macro.")
439 (defvar byte-compile-unresolved-functions nil
440 "Alist of undefined functions to which calls have been compiled.
441 Used for warnings when the function is not known to be defined or is later
442 defined with incorrect args.")
444 (defvar byte-compile-tag-number
0)
445 (defvar byte-compile-output nil
446 "Alist describing contents to put in byte code string.
447 Each element is (INDEX . VALUE)")
448 (defvar byte-compile-depth
0 "Current depth of execution stack.")
449 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
452 ;;; The byte codes; this information is duplicated in bytecomp.c
454 (defvar byte-code-vector nil
455 "An array containing byte-code names indexed by byte-code values.")
457 (defvar byte-stack
+-info nil
458 "An array with the stack adjustment for each byte-code.")
460 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
461 ;; This is a speed-hack for building the byte-code-vector at compile-time.
462 ;; We fill in the vector at macroexpand-time, and then after the last call
463 ;; to byte-defop, we write the vector out as a constant instead of writing
464 ;; out a bunch of calls to aset.
465 ;; Actually, we don't fill in the vector itself, because that could make
466 ;; it problematic to compile big changes to this compiler; we store the
467 ;; values on its plist, and remove them later in -extrude.
468 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
469 (put 'byte-code-vector
'tmp-compile-time-value
470 (make-vector 256 nil
))))
471 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
472 (put 'byte-stack
+-info
'tmp-compile-time-value
473 (make-vector 256 nil
)))))
474 (aset v1 opcode opname
)
475 (aset v2 opcode stack-adjust
))
477 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
478 (list 'defconst opname opcode
)))
480 (defmacro byte-extrude-byte-code-vectors
()
481 (prog1 (list 'setq
'byte-code-vector
482 (get 'byte-code-vector
'tmp-compile-time-value
)
484 (get 'byte-stack
+-info
'tmp-compile-time-value
))
485 (put 'byte-code-vector
'tmp-compile-time-value nil
)
486 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
491 ;; These opcodes are special in that they pack their argument into the
494 (byte-defop 8 1 byte-varref
"for variable reference")
495 (byte-defop 16 -
1 byte-varset
"for setting a variable")
496 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
497 (byte-defop 32 0 byte-call
"for calling a function")
498 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
499 ;; codes 8-47 are consumed by the preceding opcodes
503 (byte-defop 56 -
1 byte-nth
)
504 (byte-defop 57 0 byte-symbolp
)
505 (byte-defop 58 0 byte-consp
)
506 (byte-defop 59 0 byte-stringp
)
507 (byte-defop 60 0 byte-listp
)
508 (byte-defop 61 -
1 byte-eq
)
509 (byte-defop 62 -
1 byte-memq
)
510 (byte-defop 63 0 byte-not
)
511 (byte-defop 64 0 byte-car
)
512 (byte-defop 65 0 byte-cdr
)
513 (byte-defop 66 -
1 byte-cons
)
514 (byte-defop 67 0 byte-list1
)
515 (byte-defop 68 -
1 byte-list2
)
516 (byte-defop 69 -
2 byte-list3
)
517 (byte-defop 70 -
3 byte-list4
)
518 (byte-defop 71 0 byte-length
)
519 (byte-defop 72 -
1 byte-aref
)
520 (byte-defop 73 -
2 byte-aset
)
521 (byte-defop 74 0 byte-symbol-value
)
522 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
523 (byte-defop 76 -
1 byte-set
)
524 (byte-defop 77 -
1 byte-fset
) ; this was commented out
525 (byte-defop 78 -
1 byte-get
)
526 (byte-defop 79 -
2 byte-substring
)
527 (byte-defop 80 -
1 byte-concat2
)
528 (byte-defop 81 -
2 byte-concat3
)
529 (byte-defop 82 -
3 byte-concat4
)
530 (byte-defop 83 0 byte-sub1
)
531 (byte-defop 84 0 byte-add1
)
532 (byte-defop 85 -
1 byte-eqlsign
)
533 (byte-defop 86 -
1 byte-gtr
)
534 (byte-defop 87 -
1 byte-lss
)
535 (byte-defop 88 -
1 byte-leq
)
536 (byte-defop 89 -
1 byte-geq
)
537 (byte-defop 90 -
1 byte-diff
)
538 (byte-defop 91 0 byte-negate
)
539 (byte-defop 92 -
1 byte-plus
)
540 (byte-defop 93 -
1 byte-max
)
541 (byte-defop 94 -
1 byte-min
)
542 (byte-defop 95 -
1 byte-mult
) ; v19 only
543 (byte-defop 96 1 byte-point
)
544 (byte-defop 98 0 byte-goto-char
)
545 (byte-defop 99 0 byte-insert
)
546 (byte-defop 100 1 byte-point-max
)
547 (byte-defop 101 1 byte-point-min
)
548 (byte-defop 102 0 byte-char-after
)
549 (byte-defop 103 1 byte-following-char
)
550 (byte-defop 104 1 byte-preceding-char
)
551 (byte-defop 105 1 byte-current-column
)
552 (byte-defop 106 0 byte-indent-to
)
553 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
554 (byte-defop 108 1 byte-eolp
)
555 (byte-defop 109 1 byte-eobp
)
556 (byte-defop 110 1 byte-bolp
)
557 (byte-defop 111 1 byte-bobp
)
558 (byte-defop 112 1 byte-current-buffer
)
559 (byte-defop 113 0 byte-set-buffer
)
560 (byte-defop 114 0 byte-save-current-buffer
561 "To make a binding to record the current buffer")
562 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
563 (byte-defop 116 1 byte-interactive-p
)
565 ;; These ops are new to v19
566 (byte-defop 117 0 byte-forward-char
)
567 (byte-defop 118 0 byte-forward-word
)
568 (byte-defop 119 -
1 byte-skip-chars-forward
)
569 (byte-defop 120 -
1 byte-skip-chars-backward
)
570 (byte-defop 121 0 byte-forward-line
)
571 (byte-defop 122 0 byte-char-syntax
)
572 (byte-defop 123 -
1 byte-buffer-substring
)
573 (byte-defop 124 -
1 byte-delete-region
)
574 (byte-defop 125 -
1 byte-narrow-to-region
)
575 (byte-defop 126 1 byte-widen
)
576 (byte-defop 127 0 byte-end-of-line
)
580 ;; These store their argument in the next two bytes
581 (byte-defop 129 1 byte-constant2
582 "for reference to a constant with vector index >= byte-constant-limit")
583 (byte-defop 130 0 byte-goto
"for unconditional jump")
584 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
585 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
586 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
587 "to examine top-of-stack, jump and don't pop it if it's nil,
589 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
590 "to examine top-of-stack, jump and don't pop it if it's non nil,
593 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
594 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
595 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
597 (byte-defop 138 0 byte-save-excursion
598 "to make a binding to record the buffer, point and mark")
599 (byte-defop 139 0 byte-save-window-excursion
600 "to make a binding to record entire window configuration")
601 (byte-defop 140 0 byte-save-restriction
602 "to make a binding to record the current buffer clipping restrictions")
603 (byte-defop 141 -
1 byte-catch
604 "for catch. Takes, on stack, the tag and an expression for the body")
605 (byte-defop 142 -
1 byte-unwind-protect
606 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
608 ;; For condition-case. Takes, on stack, the variable to bind,
609 ;; an expression for the body, and a list of clauses.
610 (byte-defop 143 -
2 byte-condition-case
)
612 ;; For entry to with-output-to-temp-buffer.
613 ;; Takes, on stack, the buffer name.
614 ;; Binds standard-output and does some other things.
615 ;; Returns with temp buffer on the stack in place of buffer name.
616 (byte-defop 144 0 byte-temp-output-buffer-setup
)
618 ;; For exit from with-output-to-temp-buffer.
619 ;; Expects the temp buffer on the stack underneath value to return.
620 ;; Pops them both, then pushes the value back on.
621 ;; Unbinds standard-output and makes the temp buffer visible.
622 (byte-defop 145 -
1 byte-temp-output-buffer-show
)
624 ;; these ops are new to v19
626 ;; To unbind back to the beginning of this frame.
627 ;; Not used yet, but will be needed for tail-recursion elimination.
628 (byte-defop 146 0 byte-unbind-all
)
630 ;; these ops are new to v19
631 (byte-defop 147 -
2 byte-set-marker
)
632 (byte-defop 148 0 byte-match-beginning
)
633 (byte-defop 149 0 byte-match-end
)
634 (byte-defop 150 0 byte-upcase
)
635 (byte-defop 151 0 byte-downcase
)
636 (byte-defop 152 -
1 byte-string
=)
637 (byte-defop 153 -
1 byte-string
<)
638 (byte-defop 154 -
1 byte-equal
)
639 (byte-defop 155 -
1 byte-nthcdr
)
640 (byte-defop 156 -
1 byte-elt
)
641 (byte-defop 157 -
1 byte-member
)
642 (byte-defop 158 -
1 byte-assq
)
643 (byte-defop 159 0 byte-nreverse
)
644 (byte-defop 160 -
1 byte-setcar
)
645 (byte-defop 161 -
1 byte-setcdr
)
646 (byte-defop 162 0 byte-car-safe
)
647 (byte-defop 163 0 byte-cdr-safe
)
648 (byte-defop 164 -
1 byte-nconc
)
649 (byte-defop 165 -
1 byte-quo
)
650 (byte-defop 166 -
1 byte-rem
)
651 (byte-defop 167 0 byte-numberp
)
652 (byte-defop 168 0 byte-integerp
)
655 (byte-defop 175 nil byte-listN
)
656 (byte-defop 176 nil byte-concatN
)
657 (byte-defop 177 nil byte-insertN
)
661 (byte-defop 192 1 byte-constant
"for reference to a constant")
662 ;; codes 193-255 are consumed by byte-constant.
663 (defconst byte-constant-limit
64
664 "Exclusive maximum index usable in the `byte-constant' opcode.")
666 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
667 byte-goto-if-nil-else-pop
668 byte-goto-if-not-nil-else-pop
)
669 "List of byte-codes whose offset is a pc.")
671 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
673 (byte-extrude-byte-code-vectors)
675 ;;; lapcode generator
677 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
678 ;; source -> bytecode, because it's a lot easier to make optimizations
679 ;; on lapcode than on bytecode.
681 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
682 ;; where instruction is a symbol naming a byte-code instruction,
683 ;; and parameter is an argument to that instruction, if any.
685 ;; The instruction can be the pseudo-op TAG, which means that this position
686 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
687 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
688 ;; parameter for some goto op.
690 ;; If the operation is varbind, varref, varset or push-constant, then the
691 ;; parameter is (variable/constant . index_in_constant_vector).
693 ;; First, the source code is macroexpanded and optimized in various ways.
694 ;; Then the resultant code is compiled into lapcode. Another set of
695 ;; optimizations are then run over the lapcode. Then the variables and
696 ;; constants referenced by the lapcode are collected and placed in the
697 ;; constants-vector. (This happens now so that variables referenced by dead
698 ;; code don't consume space.) And finally, the lapcode is transformed into
699 ;; compacted byte-code.
701 ;; A distinction is made between variables and constants because the variable-
702 ;; referencing instructions are more sensitive to the variables being near the
703 ;; front of the constants-vector than the constant-referencing instructions.
704 ;; Also, this lets us notice references to free variables.
706 (defun byte-compile-lapcode (lap)
707 "Turns lapcode into bytecode. The lapcode is destroyed."
708 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
709 (let ((pc 0) ; Program counter
710 op off
; Operation & offset
711 (bytes '()) ; Put the output bytes here
712 (patchlist nil
)) ; List of tags and goto's to patch
714 (setq op
(car (car lap
))
716 (cond ((not (symbolp op
))
717 (error "Non-symbolic opcode `%s'" op
))
720 (setq patchlist
(cons off patchlist
)))
721 ((memq op byte-goto-ops
)
723 (setq bytes
(cons (cons pc
(cdr off
))
725 (cons (symbol-value op
) bytes
))))
726 (setq patchlist
(cons bytes patchlist
)))
729 (cond ((cond ((consp off
)
730 ;; Variable or constant reference
732 (eq op
'byte-constant
)))
733 (cond ((< off byte-constant-limit
)
735 (cons (+ byte-constant off
) bytes
))
739 (cons (logand off
255)
740 (cons byte-constant2 bytes
))))))
741 ((<= byte-listN
(symbol-value op
))
743 (cons off
(cons (symbol-value op
) bytes
)))
746 (cons (+ (symbol-value op
) off
) bytes
))
749 (cons off
(cons (+ (symbol-value op
) 6) bytes
)))
753 (cons (logand off
255)
754 (cons (+ (symbol-value op
) 7)
756 (setq lap
(cdr lap
)))
757 ;;(if (not (= pc (length bytes)))
758 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
759 ;; Patch PC into jumps
762 (setq bytes
(car patchlist
))
763 (cond ((atom (car bytes
))) ; Tag
765 (setq pc
(car (cdr (car bytes
)))) ; Pick PC from tag
766 (setcar (cdr bytes
) (logand pc
255))
767 (setcar bytes
(lsh pc -
8))))
768 (setq patchlist
(cdr patchlist
))))
769 (concat (nreverse bytes
))))
772 ;;; compile-time evaluation
774 (defun byte-compile-eval (form)
775 "Eval FORM and mark the functions defined therein.
776 Each function's symbol gets marked with the `byte-compile-noruntime' property."
777 (let ((hist-orig load-history
)
778 (hist-nil-orig current-load-list
))
780 (when (memq 'noruntime byte-compile-warnings
)
781 (let ((hist-new load-history
)
782 (hist-nil-new current-load-list
))
783 ;; Go through load-history, look for newly loaded files
784 ;; and mark all the functions defined therein.
785 (while (and hist-new
(not (eq hist-new hist-orig
)))
786 (let ((xs (pop hist-new
))
788 ;; Make sure the file was not already loaded before.
789 (unless (assoc (car xs
) hist-orig
)
793 (unless (memq s old-autoloads
)
794 (put s
'byte-compile-noruntime t
)))
795 ((and (consp s
) (eq t
(car s
)))
796 (push (cdr s
) old-autoloads
))
797 ((and (consp s
) (eq 'autoload
(car s
)))
798 (put (cdr s
) 'byte-compile-noruntime t
)))))))
799 ;; Go through current-load-list for the locally defined funs.
801 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
802 (let ((s (pop hist-nil-new
)))
803 (when (and (symbolp s
) (not (memq s old-autoloads
)))
804 (put s
'byte-compile-noruntime t
))
805 (when (and (consp s
) (eq t
(car s
)))
806 (push (cdr s
) old-autoloads
))))))))))
808 (defun byte-compile-eval-before-compile (form)
809 "Evaluate FORM for `eval-and-compile'."
810 (let ((hist-nil-orig current-load-list
))
812 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
813 (let ((tem current-load-list
))
814 (while (not (eq tem hist-nil-orig
))
815 (when (equal (car tem
) '(require . cl
))
816 (setq byte-compile-warnings
817 (remq 'cl-functions byte-compile-warnings
)))
818 (setq tem
(cdr tem
)))))))
820 ;;; byte compiler messages
822 (defvar byte-compile-current-form nil
)
823 (defvar byte-compile-dest-file nil
)
824 (defvar byte-compile-current-file nil
)
825 (defvar byte-compile-current-buffer nil
)
827 ;; Log something that isn't a warning.
828 (defmacro byte-compile-log
(format-string &rest args
)
831 '(memq byte-optimize-log
'(t source
))
832 (list 'let
'((print-escape-newlines t
)
835 (list 'byte-compile-log-1
840 (if (symbolp x
) (list 'prin1-to-string x
) x
))
843 ;; Log something that isn't a warning.
844 (defun byte-compile-log-1 (string)
846 (byte-goto-log-buffer)
847 (goto-char (point-max))
848 (byte-compile-warning-prefix nil nil
)
849 (cond (noninteractive
850 (message " %s" string
))
852 (insert (format "%s\n" string
))))))
854 (defvar byte-compile-read-position nil
855 "Character position we began the last `read' from.")
856 (defvar byte-compile-last-position nil
857 "Last known character position in the input.")
859 ;; copied from gnus-util.el
860 (defsubst byte-compile-delete-first
(elt list
)
861 (if (eq (car list
) elt
)
864 (while (and (cdr list
)
865 (not (eq (cadr list
) elt
)))
866 (setq list
(cdr list
)))
868 (setcdr list
(cddr list
)))
871 ;; The purpose of this function is to iterate through the
872 ;; `read-symbol-positions-list'. Each time we process, say, a
873 ;; function definition (`defun') we remove `defun' from
874 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
875 ;; to that symbol's character position. Similarly, if we encounter a
876 ;; variable reference, like in (1+ foo), we remove `foo' from the
877 ;; list. If our current position is after the symbol's position, we
878 ;; assume we've already passed that point, and look for the next
879 ;; occurrence of the symbol.
880 ;; So your're probably asking yourself: Isn't this function a
881 ;; gross hack? And the answer, of course, would be yes.
882 (defun byte-compile-set-symbol-position (sym &optional allow-previous
)
883 (when byte-compile-read-position
886 (setq last byte-compile-last-position
887 entry
(assq sym read-symbol-positions-list
))
889 (setq byte-compile-last-position
890 (+ byte-compile-read-position
(cdr entry
))
891 read-symbol-positions-list
892 (byte-compile-delete-first
893 entry read-symbol-positions-list
)))
894 (or (and allow-previous
(not (= last byte-compile-last-position
)))
895 (> last byte-compile-last-position
)))))))
897 (defvar byte-compile-last-warned-form nil
)
898 (defvar byte-compile-last-logged-file nil
)
900 (defun byte-goto-log-buffer ()
901 (set-buffer (get-buffer-create "*Compile-Log*"))
902 (unless (eq major-mode
'compilation-mode
)
905 ;; This is used as warning-prefix for the compiler.
906 ;; It is always called with the warnings buffer current.
907 (defun byte-compile-warning-prefix (level entry
)
908 (let* ((dir default-directory
)
909 (file (cond ((stringp byte-compile-current-file
)
910 (format "%s:" (file-relative-name byte-compile-current-file dir
)))
911 ((bufferp byte-compile-current-file
)
913 (buffer-name byte-compile-current-file
)))
915 (pos (if (and byte-compile-current-file
916 (integerp byte-compile-read-position
))
917 (with-current-buffer byte-compile-current-buffer
918 (format "%d:%d:" (count-lines (point-min)
919 byte-compile-last-position
)
921 (goto-char byte-compile-last-position
)
922 (1+ (current-column)))))
924 (form (if (eq byte-compile-current-form
:end
) "end of data"
925 (or byte-compile-current-form
"toplevel form"))))
926 (when (or (and byte-compile-current-file
927 (not (equal byte-compile-current-file
928 byte-compile-last-logged-file
)))
929 (and byte-compile-last-warned-form
930 (not (eq byte-compile-current-form
931 byte-compile-last-warned-form
))))
932 (insert (format "\nIn %s:\n" form
)))
934 (insert (format "%s%s" file pos
))))
935 (setq byte-compile-last-logged-file byte-compile-current-file
936 byte-compile-last-warned-form byte-compile-current-form
)
939 ;; This no-op function is used as the value of warning-series
940 ;; to tell inner calls to displaying-byte-compile-warnings
941 ;; not to bind warning-series.
942 (defun byte-compile-warning-series (&rest ignore
)
945 ;; Log the start of a file in *Compile-Log*, and mark it as done.
946 ;; Return the position of the start of the page in the log buffer.
947 ;; But do nothing in batch mode.
948 (defun byte-compile-log-file ()
949 (and (not (equal byte-compile-current-file byte-compile-last-logged-file
))
952 (byte-goto-log-buffer)
953 (goto-char (point-max))
954 (let* ((dir (and byte-compile-current-file
955 (file-name-directory byte-compile-current-file
)))
956 (was-same (equal default-directory dir
))
960 (insert (format "Leaving directory `%s'\n" default-directory
))))
963 (setq pt
(point-marker))
964 (if byte-compile-current-file
965 (insert "\f\nCompiling "
966 (if (stringp byte-compile-current-file
)
967 (concat "file " byte-compile-current-file
)
968 (concat "buffer " (buffer-name byte-compile-current-file
)))
969 " at " (current-time-string) "\n")
970 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
972 (setq default-directory dir
)
974 (insert (format "Entering directory `%s'\n" default-directory
))))
975 (setq byte-compile-last-logged-file byte-compile-current-file
)
978 ;; Log a message STRING in *Compile-Log*.
979 ;; Also log the current function and file if not already done.
980 (defun byte-compile-log-warning (string &optional fill level
)
981 (let ((warning-prefix-function 'byte-compile-warning-prefix
)
982 (warning-group-format "")
983 (warning-fill-prefix (if fill
" ")))
984 (display-warning 'bytecomp string level
"*Compile-Log*")))
986 (defun byte-compile-warn (format &rest args
)
987 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
988 (setq format
(apply 'format format args
))
989 (if byte-compile-error-on-warn
990 (error "%s" format
) ; byte-compile-file catches and logs it
991 (byte-compile-log-warning format t
:warning
)))
993 (defun byte-compile-report-error (error-info)
994 "Report Lisp error in compilation. ERROR-INFO is the error data."
995 (setq byte-compiler-error-flag t
)
996 (byte-compile-log-warning
997 (error-message-string error-info
)
1000 ;;; Used by make-obsolete.
1001 (defun byte-compile-obsolete (form)
1002 (let* ((new (get (car form
) 'byte-obsolete-info
))
1003 (handler (nth 1 new
))
1005 (byte-compile-set-symbol-position (car form
))
1006 (if (memq 'obsolete byte-compile-warnings
)
1007 (byte-compile-warn "%s is an obsolete function%s; %s" (car form
)
1008 (if when
(concat " since " when
) "")
1009 (if (stringp (car new
))
1011 (format "use %s instead." (car new
)))))
1012 (funcall (or handler
'byte-compile-normal-call
) form
)))
1016 ;; (defvar byte-compiler-valid-options
1017 ;; '((optimize byte-optimize (t nil source byte) val)
1018 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1019 ;; (eq val 'emacs18))
1020 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1021 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1022 ;; (verbose byte-compile-verbose (t nil) val)
1023 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1026 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1027 ;; #### This should print a warning if the user tries to change something
1028 ;; than can't be changed because the running compiler doesn't support it.
1030 ;; ((byte-compile-single-version)
1031 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1032 ;; (list (byte-compile-version-cond
1033 ;; byte-compile-generate-emacs19-bytecodes)))
1034 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1035 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1036 ;; '(emacs18) '(emacs19)))))
1038 ;; (defun byte-compiler-options-handler (&rest args)
1039 ;; (let (key val desc choices)
1041 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1042 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1043 ;; (setq key (car (car args))
1044 ;; val (car (cdr (car args)))
1045 ;; desc (assq key byte-compiler-valid-options))
1047 ;; (error "Unknown byte-compiler option `%s'" key))
1048 ;; (setq choices (nth 2 desc))
1049 ;; (if (consp (car choices))
1052 ;; (ret (and (memq (car val) '(+ -))
1053 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1055 ;; (symbol-value (nth 1 desc)))))))
1056 ;; (setq choices (car choices))
1058 ;; (setq this (car val))
1059 ;; (cond ((memq this choices)
1060 ;; (setq ret (funcall handler this ret)))
1061 ;; ((eq this '+) (setq handler 'cons))
1062 ;; ((eq this '-) (setq handler 'delq))
1063 ;; ((error "`%s' only accepts %s" key choices)))
1064 ;; (setq val (cdr val)))
1065 ;; (set (nth 1 desc) ret))
1066 ;; (or (memq val choices)
1067 ;; (error "`%s' must be one of `%s'" key choices))
1068 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1069 ;; (setq args (cdr args)))
1072 ;;; sanity-checking arglists
1074 (defun byte-compile-fdefinition (name macro-p
)
1075 (let* ((list (if macro-p
1076 byte-compile-macro-environment
1077 byte-compile-function-environment
))
1078 (env (cdr (assq name list
))))
1081 (while (and (symbolp fn
)
1083 (or (symbolp (symbol-function fn
))
1084 (consp (symbol-function fn
))
1086 (byte-code-function-p (symbol-function fn
)))))
1087 (setq fn
(symbol-function fn
)))
1088 (if (and (not macro-p
) (byte-code-function-p fn
))
1091 (if (eq 'macro
(car fn
))
1095 (if (eq 'autoload
(car fn
))
1099 (defun byte-compile-arglist-signature (arglist)
1104 (cond ((eq (car arglist
) '&optional
)
1105 (or opts
(setq opts
0)))
1106 ((eq (car arglist
) '&rest
)
1112 (setq opts
(1+ opts
))
1113 (setq args
(1+ args
)))))
1114 (setq arglist
(cdr arglist
)))
1115 (cons args
(if restp nil
(if opts
(+ args opts
) args
)))))
1118 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1120 (> (car new
) (car old
)) ; requires more args now
1121 (and (null (cdr old
)) ; took rest-args, doesn't any more
1123 (and (cdr new
) (cdr old
) ; can't take as many args now
1124 (< (cdr new
) (cdr old
)))
1127 (defun byte-compile-arglist-signature-string (signature)
1128 (cond ((null (cdr signature
))
1129 (format "%d+" (car signature
)))
1130 ((= (car signature
) (cdr signature
))
1131 (format "%d" (car signature
)))
1132 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1135 ;; Warn if the form is calling a function with the wrong number of arguments.
1136 (defun byte-compile-callargs-warn (form)
1137 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1138 (byte-compile-fdefinition (car form
) t
)))
1140 (byte-compile-arglist-signature
1141 (if (eq 'lambda
(car-safe def
))
1143 (if (byte-code-function-p def
)
1146 (if (and (fboundp (car form
))
1147 (subrp (symbol-function (car form
))))
1148 (subr-arity (symbol-function (car form
))))))
1149 (ncall (length (cdr form
))))
1150 ;; Check many or unevalled from subr-arity.
1151 (if (and (cdr-safe sig
)
1152 (not (numberp (cdr sig
))))
1155 (when (or (< ncall
(car sig
))
1156 (and (cdr sig
) (> ncall
(cdr sig
))))
1157 (byte-compile-set-symbol-position (car form
))
1159 "%s called with %d argument%s, but %s %s"
1161 (if (= 1 ncall
) "" "s")
1162 (if (< ncall
(car sig
))
1165 (byte-compile-arglist-signature-string sig
))))
1166 ;; Check to see if the function will be available at runtime
1167 ;; and/or remember its arity if it's unknown.
1168 (or (and (or sig
(fboundp (car form
))) ; might be a subr or autoload.
1169 (not (get (car form
) 'byte-compile-noruntime
)))
1170 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1172 ;; It's a currently-undefined function.
1173 ;; Remember number of args in call.
1174 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1175 (n (length (cdr form
))))
1177 (or (memq n
(cdr cons
))
1178 (setcdr cons
(cons n
(cdr cons
))))
1179 (setq byte-compile-unresolved-functions
1180 (cons (list (car form
) n
)
1181 byte-compile-unresolved-functions
)))))))
1183 ;; Warn if the function or macro is being redefined with a different
1184 ;; number of arguments.
1185 (defun byte-compile-arglist-warn (form macrop
)
1186 (let ((old (byte-compile-fdefinition (nth 1 form
) macrop
)))
1188 (let ((sig1 (byte-compile-arglist-signature
1189 (if (eq 'lambda
(car-safe old
))
1191 (if (byte-code-function-p old
)
1194 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1195 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1196 (byte-compile-set-symbol-position (nth 1 form
))
1198 "%s %s used to take %s %s, now takes %s"
1199 (if (eq (car form
) 'defun
) "function" "macro")
1201 (byte-compile-arglist-signature-string sig1
)
1202 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1203 (byte-compile-arglist-signature-string sig2
))))
1204 ;; This is the first definition. See if previous calls are compatible.
1205 (let ((calls (assq (nth 1 form
) byte-compile-unresolved-functions
))
1209 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1210 nums
(sort (copy-sequence (cdr calls
)) (function <))
1212 max
(car (nreverse nums
)))
1213 (when (or (< min
(car sig
))
1214 (and (cdr sig
) (> max
(cdr sig
))))
1215 (byte-compile-set-symbol-position (nth 1 form
))
1217 "%s being defined to take %s%s, but was previously called with %s"
1219 (byte-compile-arglist-signature-string sig
)
1220 (if (equal sig
'(1 .
1)) " arg" " args")
1221 (byte-compile-arglist-signature-string (cons min max
))))
1223 (setq byte-compile-unresolved-functions
1224 (delq calls byte-compile-unresolved-functions
)))))
1227 (defvar byte-compile-cl-functions nil
1228 "List of functions defined in CL.")
1230 (defun byte-compile-find-cl-functions ()
1231 (unless byte-compile-cl-functions
1232 (dolist (elt load-history
)
1233 (when (and (stringp (car elt
))
1234 (string-match "^cl\\>" (car elt
)))
1235 (setq byte-compile-cl-functions
1236 (append byte-compile-cl-functions
1238 (let ((tail byte-compile-cl-functions
))
1240 (if (and (consp (car tail
))
1241 (eq (car (car tail
)) 'autoload
))
1242 (setcar tail
(cdr (car tail
))))
1243 (setq tail
(cdr tail
))))))
1245 (defun byte-compile-cl-warn (form)
1246 "Warn if FORM is a call of a function from the CL package."
1247 (let ((func (car-safe form
)))
1248 (if (and byte-compile-cl-functions
1249 (memq func byte-compile-cl-functions
)
1250 ;; Aliases which won't have been expended at this point.
1251 ;; These aren't all aliases of subrs, so not trivial to
1252 ;; avoid hardwiring the list.
1254 '(cl-block-wrapper cl-block-throw
1255 multiple-value-call nth-value
1256 copy-seq first second rest endp cl-member
1257 ;; These are included in generated code
1258 ;; that can't be called except at compile time
1259 ;; or unless cl is loaded anyway.
1260 cl-defsubst-expand cl-struct-setf-expander
1261 ;; These would sometimes be warned about
1262 ;; but such warnings are never useful,
1263 ;; so don't warn about them.
1264 macroexpand cl-macroexpand-all cl-compiling-file
))))
1265 (byte-compile-warn "Function `%s' from cl package called at runtime"
1269 (defun byte-compile-print-syms (str1 strn syms
)
1271 (byte-compile-set-symbol-position (car syms
) t
))
1272 (cond ((and (cdr syms
) (not noninteractive
))
1277 (setq s
(symbol-name (pop syms
))
1278 L
(+ L
(length s
) 2))
1279 (if (< L
(1- fill-column
))
1280 (setq str
(concat str
" " s
(and syms
",")))
1281 (setq str
(concat str
"\n " s
(and syms
","))
1282 L
(+ (length s
) 4))))
1283 (byte-compile-warn "%s" str
)))
1285 (byte-compile-warn "%s %s"
1287 (mapconcat #'symbol-name syms
", ")))
1290 (byte-compile-warn str1
(car syms
)))))
1292 ;; If we have compiled any calls to functions which are not known to be
1293 ;; defined, issue a warning enumerating them.
1294 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1295 (defun byte-compile-warn-about-unresolved-functions ()
1296 (when (memq 'unresolved byte-compile-warnings
)
1297 (let ((byte-compile-current-form :end
)
1300 ;; Separate the functions that will not be available at runtime
1301 ;; from the truly unresolved ones.
1302 (dolist (f byte-compile-unresolved-functions
)
1304 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1305 ;; Complain about the no-run-time functions
1306 (byte-compile-print-syms
1307 "the function `%s' might not be defined at runtime."
1308 "the following functions might not be defined at runtime:"
1310 ;; Complain about the unresolved functions
1311 (byte-compile-print-syms
1312 "the function `%s' is not known to be defined."
1313 "the following functions are not known to be defined:"
1318 (defsubst byte-compile-const-symbol-p
(symbol &optional any-value
)
1319 "Non-nil if SYMBOL is constant.
1320 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1322 (or (memq symbol
'(nil t
))
1324 (if any-value
(memq symbol byte-compile-const-variables
))))
1326 (defmacro byte-compile-constp
(form)
1327 "Return non-nil if FORM is a constant."
1328 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1329 ((not (symbolp ,form
)))
1330 ((byte-compile-const-symbol-p ,form
))))
1332 (defmacro byte-compile-close-variables
(&rest body
)
1335 ;; Close over these variables to encapsulate the
1336 ;; compilation state
1338 (byte-compile-macro-environment
1339 ;; Copy it because the compiler may patch into the
1340 ;; macroenvironment.
1341 (copy-alist byte-compile-initial-macro-environment
))
1342 (byte-compile-function-environment nil
)
1343 (byte-compile-bound-variables nil
)
1344 (byte-compile-const-variables nil
)
1345 (byte-compile-free-references nil
)
1346 (byte-compile-free-assignments nil
)
1348 ;; Close over these variables so that `byte-compiler-options'
1349 ;; can change them on a per-file basis.
1351 (byte-compile-verbose byte-compile-verbose
)
1352 (byte-optimize byte-optimize
)
1353 (byte-compile-compatibility byte-compile-compatibility
)
1354 (byte-compile-dynamic byte-compile-dynamic
)
1355 (byte-compile-dynamic-docstrings
1356 byte-compile-dynamic-docstrings
)
1357 ;; (byte-compile-generate-emacs19-bytecodes
1358 ;; byte-compile-generate-emacs19-bytecodes)
1359 (byte-compile-warnings (if (eq byte-compile-warnings t
)
1360 byte-compile-warning-types
1361 byte-compile-warnings
))
1365 (defmacro displaying-byte-compile-warnings
(&rest body
)
1366 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body
))
1367 (warning-series-started
1368 (and (markerp warning-series
)
1369 (eq (marker-buffer warning-series
)
1370 (get-buffer "*Compile-Log*")))))
1371 (byte-compile-find-cl-functions)
1372 (if (or (eq warning-series
'byte-compile-warning-series
)
1373 warning-series-started
)
1374 ;; warning-series does come from compilation,
1375 ;; so don't bind it, but maybe do set it.
1377 ;; Log the file name. Record position of that text.
1378 (setq tem
(byte-compile-log-file))
1379 (unless warning-series-started
1380 (setq warning-series
(or tem
'byte-compile-warning-series
)))
1381 (if byte-compile-debug
1382 (funcall --displaying-byte-compile-warnings-fn
)
1383 (condition-case error-info
1384 (funcall --displaying-byte-compile-warnings-fn
)
1385 (error (byte-compile-report-error error-info
)))))
1386 ;; warning-series does not come from compilation, so bind it.
1387 (let ((warning-series
1388 ;; Log the file name. Record position of that text.
1389 (or (byte-compile-log-file) 'byte-compile-warning-series
)))
1390 (if byte-compile-debug
1391 (funcall --displaying-byte-compile-warnings-fn
)
1392 (condition-case error-info
1393 (funcall --displaying-byte-compile-warnings-fn
)
1394 (error (byte-compile-report-error error-info
))))))))
1397 (defun byte-force-recompile (directory)
1398 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1399 Files in subdirectories of DIRECTORY are processed also."
1400 (interactive "DByte force recompile (directory): ")
1401 (byte-recompile-directory directory nil t
))
1404 (defun byte-recompile-directory (directory &optional arg force
)
1405 "Recompile every `.el' file in DIRECTORY that needs recompilation.
1406 This is if a `.elc' file exists but is older than the `.el' file.
1407 Files in subdirectories of DIRECTORY are processed also.
1409 If the `.elc' file does not exist, normally this function *does not*
1410 compile the corresponding `.el' file. However,
1411 if ARG (the prefix argument) is 0, that means do compile all those files.
1412 A nonzero ARG means ask the user, for each such `.el' file,
1413 whether to compile it.
1415 A nonzero ARG also means ask about each subdirectory before scanning it.
1417 If the third argument FORCE is non-nil,
1418 recompile every `.el' file that already has a `.elc' file."
1419 (interactive "DByte recompile directory: \nP")
1421 (setq arg
(prefix-numeric-value arg
)))
1425 (force-mode-line-update))
1426 (save-current-buffer
1427 (byte-goto-log-buffer)
1428 (setq default-directory
(expand-file-name directory
))
1429 (let ((directories (list (expand-file-name directory
)))
1430 (default-directory default-directory
)
1436 (displaying-byte-compile-warnings
1438 (setq directory
(car directories
))
1439 (message "Checking %s..." directory
)
1440 (let ((files (directory-files directory
))
1442 (dolist (file files
)
1443 (setq source
(expand-file-name file directory
))
1444 (if (and (not (member file
'("." ".." "RCS" "CVS")))
1445 (file-directory-p source
)
1446 (not (file-symlink-p source
)))
1447 ;; This file is a subdirectory. Handle them differently.
1448 (when (or (null arg
)
1450 (y-or-n-p (concat "Check " source
"? ")))
1452 (nconc directories
(list source
))))
1453 ;; It is an ordinary file. Decide whether to compile it.
1454 (if (and (string-match emacs-lisp-file-regexp source
)
1455 (file-readable-p source
)
1456 (not (auto-save-file-name-p source
))
1457 (setq dest
(byte-compile-dest-file source
))
1458 (if (file-exists-p dest
)
1459 ;; File was already compiled.
1460 (or force
(file-newer-than-file-p source dest
))
1461 ;; No compiled file exists yet.
1464 (y-or-n-p (concat "Compile " source
"? "))))))
1465 (progn (if (and noninteractive
(not byte-compile-verbose
))
1466 (message "Compiling %s..." source
))
1467 (let ((res (byte-compile-file source
)))
1468 (cond ((eq res
'no-byte-compile
)
1469 (setq skip-count
(1+ skip-count
)))
1471 (setq file-count
(1+ file-count
)))
1473 (setq fail-count
(1+ fail-count
)))))
1475 (message "Checking %s..." directory
))
1476 (if (not (eq last-dir directory
))
1477 (setq last-dir directory
1478 dir-count
(1+ dir-count
)))
1480 (setq directories
(cdr directories
))))
1481 (message "Done (Total of %d file%s compiled%s%s%s)"
1482 file-count
(if (= file-count
1) "" "s")
1483 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1484 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1485 (if (> dir-count
1) (format " in %d directories" dir-count
) "")))))
1487 (defvar no-byte-compile nil
1488 "Non-nil to prevent byte-compiling of emacs-lisp code.
1489 This is normally set in local file variables at the end of the elisp file:
1491 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1494 (defun byte-compile-file (filename &optional load
)
1495 "Compile a file of Lisp code named FILENAME into a file of byte code.
1496 The output file's name is made by appending `c' to the end of FILENAME.
1497 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1498 The value is non-nil if there were no errors, nil if errors."
1499 ;; (interactive "fByte compile file: \nP")
1501 (let ((file buffer-file-name
)
1505 (eq (cdr (assq 'major-mode
(buffer-local-variables)))
1507 (setq file-name
(file-name-nondirectory file
)
1508 file-dir
(file-name-directory file
)))
1509 (list (read-file-name (if current-prefix-arg
1510 "Byte compile and load file: "
1511 "Byte compile file: ")
1512 file-dir file-name nil
)
1513 current-prefix-arg
)))
1514 ;; Expand now so we get the current buffer's defaults
1515 (setq filename
(expand-file-name filename
))
1517 ;; If we're compiling a file that's in a buffer and is modified, offer
1518 ;; to save it first.
1520 (let ((b (get-file-buffer (expand-file-name filename
))))
1521 (if (and b
(buffer-modified-p b
)
1522 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1523 (save-excursion (set-buffer b
) (save-buffer)))))
1525 ;; Force logging of the file name for each file compiled.
1526 (setq byte-compile-last-logged-file nil
)
1527 (let ((byte-compile-current-file filename
)
1528 (set-auto-coding-for-load t
)
1529 target-file input-buffer output-buffer
1530 byte-compile-dest-file
)
1531 (setq target-file
(byte-compile-dest-file filename
))
1532 (setq byte-compile-dest-file target-file
)
1534 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1535 (set-buffer input-buffer
)
1537 (setq buffer-file-coding-system nil
)
1538 ;; Always compile an Emacs Lisp file as multibyte
1539 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1540 (set-buffer-multibyte t
)
1541 (insert-file-contents filename
)
1542 ;; Mimic the way after-insert-file-set-buffer-file-coding-system
1543 ;; can make the buffer unibyte when visiting this file.
1544 (when (or (eq last-coding-system-used
'no-conversion
)
1545 (eq (coding-system-type last-coding-system-used
) 5))
1546 ;; For coding systems no-conversion and raw-text...,
1547 ;; edit the buffer as unibyte.
1548 (set-buffer-multibyte nil
))
1549 ;; Run hooks including the uncompression hook.
1550 ;; If they change the file name, then change it for the output also.
1551 (let ((buffer-file-name filename
)
1552 (default-major-mode 'emacs-lisp-mode
)
1553 (enable-local-eval nil
))
1555 (setq filename buffer-file-name
))
1556 ;; Set the default directory, in case an eval-when-compile uses it.
1557 (setq default-directory
(file-name-directory filename
)))
1558 ;; Check if the file's local variables explicitly specify not to
1559 ;; compile this file.
1560 (if (with-current-buffer input-buffer no-byte-compile
)
1562 (message "%s not compiled because of `no-byte-compile: %s'"
1563 (file-relative-name filename
)
1564 (with-current-buffer input-buffer no-byte-compile
))
1565 (if (file-exists-p target-file
)
1566 (condition-case nil
(delete-file target-file
) (error nil
)))
1567 ;; We successfully didn't compile this file.
1569 (when byte-compile-verbose
1570 (message "Compiling %s..." filename
))
1571 (setq byte-compiler-error-flag nil
)
1572 ;; It is important that input-buffer not be current at this call,
1573 ;; so that the value of point set in input-buffer
1574 ;; within byte-compile-from-buffer lingers in that buffer.
1576 (save-current-buffer
1577 (byte-compile-from-buffer input-buffer filename
)))
1578 (if byte-compiler-error-flag
1580 (when byte-compile-verbose
1581 (message "Compiling %s...done" filename
))
1582 (kill-buffer input-buffer
)
1583 (with-current-buffer output-buffer
1584 (goto-char (point-max))
1585 (insert "\n") ; aaah, unix.
1586 (let ((vms-stmlf-recfm t
))
1587 (if (file-writable-p target-file
)
1588 ;; We must disable any code conversion here.
1589 (let ((coding-system-for-write 'no-conversion
))
1590 (if (memq system-type
'(ms-dos 'windows-nt
))
1591 (setq buffer-file-type t
))
1592 (when (file-exists-p target-file
)
1593 ;; Remove the target before writing it, so that any
1594 ;; hard-links continue to point to the old file (this makes
1595 ;; it possible for installed files to share disk space with
1596 ;; the build tree, without causing problems when emacs-lisp
1597 ;; files in the build tree are recompiled).
1598 (delete-file target-file
))
1599 (write-region (point-min) (point-max) target-file
))
1600 ;; This is just to give a better error message than write-region
1602 (list "Opening output file"
1603 (if (file-exists-p target-file
)
1604 "cannot overwrite file"
1605 "directory not writable or nonexistent")
1607 (kill-buffer (current-buffer)))
1608 (if (and byte-compile-generate-call-tree
1609 (or (eq t byte-compile-generate-call-tree
)
1610 (y-or-n-p (format "Report call tree for %s? " filename
))))
1612 (display-call-tree filename
)))
1617 ;;(defun byte-compile-and-load-file (&optional filename)
1618 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1619 ;;and then load it. The output file's name is made by appending \"c\" to
1620 ;;the end of FILENAME."
1622 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1623 ;; (byte-compile-file filename t)
1624 ;; (let ((current-prefix-arg '(4)))
1625 ;; (call-interactively 'byte-compile-file))))
1627 ;;(defun byte-compile-buffer (&optional buffer)
1628 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1629 ;; (interactive "bByte compile buffer: ")
1630 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1631 ;; (message "Compiling %s..." (buffer-name buffer))
1632 ;; (let* ((filename (or (buffer-file-name buffer)
1633 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1634 ;; (byte-compile-current-file buffer))
1635 ;; (byte-compile-from-buffer buffer nil))
1636 ;; (message "Compiling %s...done" (buffer-name buffer))
1639 ;;; compiling a single function
1641 (defun compile-defun (&optional arg
)
1642 "Compile and evaluate the current top-level form.
1643 Print the result in the minibuffer.
1644 With argument, insert value in current buffer after the form."
1648 (beginning-of-defun)
1649 (let* ((byte-compile-current-file nil
)
1650 (byte-compile-current-buffer (current-buffer))
1651 (byte-compile-read-position (point))
1652 (byte-compile-last-position byte-compile-read-position
)
1653 (byte-compile-last-warned-form 'nothing
)
1655 (let ((read-with-symbol-positions (current-buffer))
1656 (read-symbol-positions-list nil
))
1657 (displaying-byte-compile-warnings
1658 (byte-compile-sexp (read (current-buffer))))))))
1660 (message "Compiling from buffer... done.")
1661 (prin1 value
(current-buffer))
1663 ((message "%s" (prin1-to-string value
)))))))
1666 (defun byte-compile-from-buffer (inbuffer &optional filename
)
1667 ;; Filename is used for the loading-into-Emacs-18 error message.
1669 (byte-compile-current-buffer inbuffer
)
1670 (byte-compile-read-position nil
)
1671 (byte-compile-last-position nil
)
1672 ;; Prevent truncation of flonums and lists as we read and print them
1673 (float-output-format nil
)
1674 (case-fold-search nil
)
1677 ;; Prevent edebug from interfering when we compile
1678 ;; and put the output into a file.
1679 ;; (edebug-all-defs nil)
1680 ;; (edebug-all-forms nil)
1681 ;; Simulate entry to byte-compile-top-level
1682 (byte-compile-constants nil
)
1683 (byte-compile-variables nil
)
1684 (byte-compile-tag-number 0)
1685 (byte-compile-depth 0)
1686 (byte-compile-maxdepth 0)
1687 (byte-compile-output nil
)
1688 ;; This allows us to get the positions of symbols read; it's
1689 ;; new in Emacs 21.4.
1690 (read-with-symbol-positions inbuffer
)
1691 (read-symbol-positions-list nil
)
1692 ;; #### This is bound in b-c-close-variables.
1693 ;; (byte-compile-warnings (if (eq byte-compile-warnings t)
1694 ;; byte-compile-warning-types
1695 ;; byte-compile-warnings))
1697 (byte-compile-close-variables
1700 (set-buffer (get-buffer-create " *Compiler Output*")))
1701 (set-buffer-multibyte t
)
1703 ;; (emacs-lisp-mode)
1704 (setq case-fold-search nil
)
1705 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1706 ;; write files containing binary information specially.
1707 ;; Under most circumstances, such files will be in binary
1708 ;; overwrite mode, so those OS's use that flag to guess how
1709 ;; they should write their data. Advise them that .elc files
1710 ;; need to be written carefully.
1711 (setq overwrite-mode
'overwrite-mode-binary
))
1712 (displaying-byte-compile-warnings
1713 (and filename
(byte-compile-insert-header filename inbuffer outbuffer
))
1715 (set-buffer inbuffer
)
1718 ;; Compile the forms from the input buffer.
1720 (while (progn (skip-chars-forward " \t\n\^l")
1724 (setq byte-compile-read-position
(point)
1725 byte-compile-last-position byte-compile-read-position
)
1726 (let ((form (read inbuffer
)))
1727 (byte-compile-file-form form
)))
1728 ;; Compile pending forms at end of file.
1729 (byte-compile-flush-pending)
1730 (byte-compile-warn-about-unresolved-functions)
1731 ;; Should we always do this? When calling multiple files, it
1732 ;; would be useful to delay this warning until all have
1734 (setq byte-compile-unresolved-functions nil
))
1735 ;; Fix up the header at the front of the output
1736 ;; if the buffer contains multibyte characters.
1737 (and filename
(byte-compile-fix-header filename inbuffer outbuffer
))))
1740 (defun byte-compile-fix-header (filename inbuffer outbuffer
)
1741 (with-current-buffer outbuffer
1742 ;; See if the buffer has any multibyte characters.
1743 (when (< (point-max) (position-bytes (point-max)))
1744 (when (byte-compile-version-cond byte-compile-compatibility
)
1745 (error "Version-18 compatibility not valid with multibyte characters"))
1746 (goto-char (point-min))
1747 ;; Find the comment that describes the version test.
1748 (search-forward "\n;;; This file")
1750 (narrow-to-region (point) (point-max))
1751 ;; Find the line of ballast semicolons.
1752 (search-forward ";;;;;;;;;;")
1755 (narrow-to-region (point-min) (point))
1756 (let ((old-header-end (point))
1758 (goto-char (point-min))
1759 (delete-region (point) (progn (re-search-forward "^(")
1762 (insert ";;; This file contains multibyte non-ASCII characters\n"
1763 ";;; and therefore cannot be loaded into Emacs 19.\n")
1764 ;; Replace "19" or "19.29" with "20", twice.
1765 (re-search-forward "19\\(\\.[0-9]+\\)")
1766 (replace-match "20")
1767 (re-search-forward "19\\(\\.[0-9]+\\)")
1768 (replace-match "20")
1769 ;; Now compensate for the change in size,
1770 ;; to make sure all positions in the file remain valid.
1771 (setq delta
(- (point-max) old-header-end
))
1772 (goto-char (point-max))
1774 (delete-char delta
)))))
1776 (defun byte-compile-insert-header (filename inbuffer outbuffer
)
1777 (set-buffer inbuffer
)
1778 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
1779 (dynamic byte-compile-dynamic
))
1780 (set-buffer outbuffer
)
1782 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1783 ;; that is the file-format version number (18, 19 or 20) as a
1784 ;; byte, followed by some nulls. The primary motivation for doing
1785 ;; this is to get some binary characters up in the first line of
1786 ;; the file so that `diff' will simply say "Binary files differ"
1787 ;; instead of actually doing a diff of two .elc files. An extra
1788 ;; benefit is that you can add this to /etc/magic:
1790 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1791 ;; >4 byte x version %d
1795 (if (byte-compile-version-cond byte-compile-compatibility
) 18 20)
1798 (insert ";;; Compiled by "
1799 (or (and (boundp 'user-mail-address
) user-mail-address
)
1800 (concat (user-login-name) "@" (system-name)))
1802 (current-time-string) "\n;;; from file " filename
"\n")
1803 (insert ";;; in Emacs version " emacs-version
"\n")
1804 (insert ";;; with bytecomp version "
1805 (progn (string-match "[0-9.]+" byte-compile-version
)
1806 (match-string 0 byte-compile-version
))
1809 ((eq byte-optimize
'source
) "with source-level optimization only")
1810 ((eq byte-optimize
'byte
) "with byte-level optimization only")
1811 (byte-optimize "with all optimizations")
1812 (t "without optimization"))
1813 (if (byte-compile-version-cond byte-compile-compatibility
)
1814 "; compiled with Emacs 18 compatibility.\n"
1817 (insert ";;; Function definitions are lazy-loaded.\n"))
1818 (if (not (byte-compile-version-cond byte-compile-compatibility
))
1819 (let (intro-string minimum-version
)
1820 ;; Figure out which Emacs version to require,
1821 ;; and what comment to use to explain why.
1822 ;; Note that this fails to take account of whether
1823 ;; the buffer contains multibyte characters. We may have to
1824 ;; compensate at the end in byte-compile-fix-header.
1825 (if dynamic-docstrings
1827 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
1828 minimum-version
"19.29")
1830 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
1831 minimum-version
"19"))
1832 ;; Now insert the comment and the error check.
1836 ;; Have to check if emacs-version is bound so that this works
1837 ;; in files loaded early in loadup.el.
1838 "(if (and (boundp 'emacs-version)\n"
1839 ;; If there is a name at the end of emacs-version,
1840 ;; don't try to check the version number.
1841 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1842 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
1843 (format "\t (string-lessp emacs-version \"%s\")))\n"
1846 ;; prin1-to-string is used to quote backslashes.
1847 (substring (prin1-to-string (file-name-nondirectory filename
))
1849 (format "' was compiled for Emacs %s or later\"))\n\n"
1851 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1852 ;; can delete them so as to keep the buffer positions
1853 ;; constant for the actual compiled code.
1854 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
1855 ;; Here if we want Emacs 18 compatibility.
1856 (when dynamic-docstrings
1857 (error "Version-18 compatibility doesn't support dynamic doc strings"))
1858 (when byte-compile-dynamic
1859 (error "Version-18 compatibility doesn't support dynamic byte code"))
1860 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
1863 (defun byte-compile-output-file-form (form)
1864 ;; writes the given form to the output buffer, being careful of docstrings
1865 ;; in defun, defmacro, defvar, defconst, autoload and
1866 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1867 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1868 ;; it does not pay to first build the defalias in defmumble and then parse
1870 (if (and (memq (car-safe form
) '(defun defmacro defvar defconst autoload
1871 custom-declare-variable
))
1872 (stringp (nth 3 form
)))
1873 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
1875 '(autoload custom-declare-variable
)))
1876 (let ((print-escape-newlines t
)
1881 (princ "\n" outbuffer
)
1882 (prin1 form outbuffer
)
1885 (defvar print-gensym-alist
) ;Used before print-circle existed.
1887 (defun byte-compile-output-docform (preface name info form specindex quoted
)
1888 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1889 If PREFACE and NAME are non-nil, print them too,
1890 before INFO and the FORM but after the doc string itself.
1891 If SPECINDEX is non-nil, it is the index in FORM
1892 of the function bytecode string. In that case,
1893 we output that argument and the following argument (the constants vector)
1894 together, for lazy loading.
1895 QUOTED says that we have to put a quote before the
1896 list that represents a doc string reference.
1897 `autoload' and `custom-declare-variable' need that."
1898 ;; We need to examine byte-compile-dynamic-docstrings
1899 ;; in the input buffer (now current), not in the output buffer.
1900 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
1902 (prog1 (current-buffer)
1903 (set-buffer outbuffer
)
1906 ;; Insert the doc string, and make it a comment with #@LENGTH.
1907 (and (>= (nth 1 info
) 0)
1909 (not byte-compile-compatibility
)
1911 ;; Make the doc string start at beginning of line
1912 ;; for make-docfile's sake.
1915 (byte-compile-output-as-comment
1916 (nth (nth 1 info
) form
) nil
))
1917 (setq position
(- (position-bytes position
) (point-min) -
1))
1918 ;; If the doc string starts with * (a user variable),
1920 (if (and (stringp (nth (nth 1 info
) form
))
1921 (> (length (nth (nth 1 info
) form
)) 0)
1922 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
1923 (setq position
(- position
)))))
1928 (prin1 name outbuffer
)))
1930 (let ((print-escape-newlines t
)
1932 ;; For compatibility with code before print-circle,
1933 ;; use a cons cell to say that we want
1934 ;; print-gensym-alist not to be cleared
1935 ;; between calls to print functions.
1937 print-gensym-alist
; was used before print-circle existed.
1938 (print-continuous-numbering t
)
1941 (prin1 (car form
) outbuffer
)
1942 (while (setq form
(cdr form
))
1943 (setq index
(1+ index
))
1945 (cond ((and (numberp specindex
) (= index specindex
)
1946 ;; Don't handle the definition dynamically
1947 ;; if it refers (or might refer)
1948 ;; to objects already output
1949 ;; (for instance, gensyms in the arg list).
1951 (dotimes (i (length print-number-table
))
1952 (if (aref print-number-table i
)
1955 ;; Output the byte code and constants specially
1956 ;; for lazy dynamic loading.
1958 (byte-compile-output-as-comment
1959 (cons (car form
) (nth 1 form
))
1961 (setq position
(- (position-bytes position
) (point-min) -
1))
1962 (princ (format "(#$ . %d) nil" position
) outbuffer
)
1963 (setq form
(cdr form
))
1964 (setq index
(1+ index
))))
1965 ((= index
(nth 1 info
))
1967 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
1970 (let ((print-escape-newlines nil
))
1971 (goto-char (prog1 (1+ (point))
1972 (prin1 (car form
) outbuffer
)))
1974 (goto-char (point-max)))))
1976 (prin1 (car form
) outbuffer
)))))
1977 (insert (nth 2 info
))))))
1980 (defun byte-compile-keep-pending (form &optional handler
)
1981 (if (memq byte-optimize
'(t source
))
1982 (setq form
(byte-optimize-form form t
)))
1984 (let ((for-effect t
))
1985 ;; To avoid consing up monstrously large forms at load time, we split
1986 ;; the output regularly.
1987 (and (memq (car-safe form
) '(fset defalias
))
1988 (nthcdr 300 byte-compile-output
)
1989 (byte-compile-flush-pending))
1990 (funcall handler form
)
1992 (byte-compile-discard)))
1993 (byte-compile-form form t
))
1996 (defun byte-compile-flush-pending ()
1997 (if byte-compile-output
1998 (let ((form (byte-compile-out-toplevel t
'file
)))
1999 (cond ((eq (car-safe form
) 'progn
)
2000 (mapc 'byte-compile-output-file-form
(cdr form
)))
2002 (byte-compile-output-file-form form
)))
2003 (setq byte-compile-constants nil
2004 byte-compile-variables nil
2005 byte-compile-depth
0
2006 byte-compile-maxdepth
0
2007 byte-compile-output nil
))))
2009 (defun byte-compile-file-form (form)
2010 (let ((byte-compile-current-form nil
) ; close over this for warnings.
2014 (byte-compile-keep-pending form
))
2015 ((and (symbolp (car form
))
2016 (setq handler
(get (car form
) 'byte-hunk-handler
)))
2017 (cond ((setq form
(funcall handler form
))
2018 (byte-compile-flush-pending)
2019 (byte-compile-output-file-form form
))))
2020 ((eq form
(setq form
(macroexpand form byte-compile-macro-environment
)))
2021 (byte-compile-keep-pending form
))
2023 (byte-compile-file-form form
)))))
2025 ;; Functions and variables with doc strings must be output separately,
2026 ;; so make-docfile can recognise them. Most other things can be output
2029 (put 'defsubst
'byte-hunk-handler
'byte-compile-file-form-defsubst
)
2030 (defun byte-compile-file-form-defsubst (form)
2031 (when (assq (nth 1 form
) byte-compile-unresolved-functions
)
2032 (setq byte-compile-current-form
(nth 1 form
))
2033 (byte-compile-warn "defsubst %s was used before it was defined"
2035 (byte-compile-file-form
2036 (macroexpand form byte-compile-macro-environment
))
2037 ;; Return nil so the form is not output twice.
2040 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
2041 (defun byte-compile-file-form-autoload (form)
2042 (and (let ((form form
))
2043 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
2044 (null form
)) ;Constants only
2045 (eval (nth 5 form
)) ;Macro
2046 (eval form
)) ;Define the autoload.
2047 ;; Avoid undefined function warnings for the autoload.
2048 (if (and (consp (nth 1 form
))
2049 (eq (car (nth 1 form
)) 'quote
)
2050 (consp (cdr (nth 1 form
)))
2051 (symbolp (nth 1 (nth 1 form
))))
2052 (add-to-list 'byte-compile-function-environment
2053 (cons (nth 1 (nth 1 form
))
2054 (cons 'autoload
(cdr (cdr form
))))))
2055 (if (stringp (nth 3 form
))
2057 ;; No doc string, so we can compile this as a normal form.
2058 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
2060 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2061 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2062 (defun byte-compile-file-form-defvar (form)
2063 (if (null (nth 3 form
))
2064 ;; Since there is no doc string, we can compile this as a normal form,
2065 ;; and not do a file-boundary.
2066 (byte-compile-keep-pending form
)
2067 (when (memq 'free-vars byte-compile-warnings
)
2068 (push (nth 1 form
) byte-compile-bound-variables
)
2069 (if (eq (car form
) 'defconst
)
2070 (push (nth 1 form
) byte-compile-const-variables
)))
2071 (cond ((consp (nth 2 form
))
2072 (setq form
(copy-sequence form
))
2073 (setcar (cdr (cdr form
))
2074 (byte-compile-top-level (nth 2 form
) nil
'file
))))
2077 (put 'custom-declare-variable
'byte-hunk-handler
2078 'byte-compile-file-form-custom-declare-variable
)
2079 (defun byte-compile-file-form-custom-declare-variable (form)
2080 (when (memq 'free-vars byte-compile-warnings
)
2081 (push (nth 1 (nth 1 form
)) byte-compile-bound-variables
))
2082 (let ((tail (nthcdr 4 form
)))
2084 ;; If there are any (function (lambda ...)) expressions, compile
2086 (if (and (consp (car tail
))
2087 (eq (car (car tail
)) 'function
)
2088 (consp (nth 1 (car tail
))))
2089 (setcar tail
(byte-compile-lambda (nth 1 (car tail
))))
2090 ;; Likewise for a bare lambda.
2091 (if (and (consp (car tail
))
2092 (eq (car (car tail
)) 'lambda
))
2093 (setcar tail
(byte-compile-lambda (car tail
)))))
2094 (setq tail
(cdr tail
))))
2097 (put 'require
'byte-hunk-handler
'byte-compile-file-form-eval-boundary
)
2098 (defun byte-compile-file-form-eval-boundary (form)
2099 (let ((old-load-list current-load-list
))
2101 ;; (require 'cl) turns off warnings for cl functions.
2102 (let ((tem current-load-list
))
2103 (while (not (eq tem old-load-list
))
2104 (when (equal (car tem
) '(require . cl
))
2105 (setq byte-compile-warnings
2106 (remq 'cl-functions byte-compile-warnings
)))
2107 (setq tem
(cdr tem
)))))
2108 (byte-compile-keep-pending form
'byte-compile-normal-call
))
2110 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
2111 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
2112 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
2113 (defun byte-compile-file-form-progn (form)
2114 (mapc 'byte-compile-file-form
(cdr form
))
2115 ;; Return nil so the forms are not output twice.
2118 ;; This handler is not necessary, but it makes the output from dont-compile
2119 ;; and similar macros cleaner.
2120 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
2121 (defun byte-compile-file-form-eval (form)
2122 (if (eq (car-safe (nth 1 form
)) 'quote
)
2123 (nth 1 (nth 1 form
))
2124 (byte-compile-keep-pending form
)))
2126 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
2127 (defun byte-compile-file-form-defun (form)
2128 (byte-compile-file-form-defmumble form nil
))
2130 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
2131 (defun byte-compile-file-form-defmacro (form)
2132 (byte-compile-file-form-defmumble form t
))
2134 (defun byte-compile-file-form-defmumble (form macrop
)
2135 (let* ((name (car (cdr form
)))
2136 (this-kind (if macrop
'byte-compile-macro-environment
2137 'byte-compile-function-environment
))
2138 (that-kind (if macrop
'byte-compile-function-environment
2139 'byte-compile-macro-environment
))
2140 (this-one (assq name
(symbol-value this-kind
)))
2141 (that-one (assq name
(symbol-value that-kind
)))
2142 (byte-compile-free-references nil
)
2143 (byte-compile-free-assignments nil
))
2144 (byte-compile-set-symbol-position name
)
2145 ;; When a function or macro is defined, add it to the call tree so that
2146 ;; we can tell when functions are not used.
2147 (if byte-compile-generate-call-tree
2148 (or (assq name byte-compile-call-tree
)
2149 (setq byte-compile-call-tree
2150 (cons (list name nil nil
) byte-compile-call-tree
))))
2152 (setq byte-compile-current-form name
) ; for warnings
2153 (if (memq 'redefine byte-compile-warnings
)
2154 (byte-compile-arglist-warn form macrop
))
2155 (if byte-compile-verbose
2156 (message "Compiling %s... (%s)" (or filename
"") (nth 1 form
)))
2158 (if (and (memq 'redefine byte-compile-warnings
)
2159 ;; don't warn when compiling the stubs in byte-run...
2160 (not (assq (nth 1 form
)
2161 byte-compile-initial-macro-environment
)))
2163 "%s defined multiple times, as both function and macro"
2165 (setcdr that-one nil
))
2167 (when (and (memq 'redefine byte-compile-warnings
)
2168 ;; hack: don't warn when compiling the magic internal
2169 ;; byte-compiler macros in byte-run.el...
2170 (not (assq (nth 1 form
)
2171 byte-compile-initial-macro-environment
)))
2172 (byte-compile-warn "%s %s defined multiple times in this file"
2173 (if macrop
"macro" "function")
2175 ((and (fboundp name
)
2176 (eq (car-safe (symbol-function name
))
2177 (if macrop
'lambda
'macro
)))
2178 (when (memq 'redefine byte-compile-warnings
)
2179 (byte-compile-warn "%s %s being redefined as a %s"
2180 (if macrop
"function" "macro")
2182 (if macrop
"macro" "function")))
2183 ;; shadow existing definition
2185 (cons (cons name nil
) (symbol-value this-kind
))))
2187 (let ((body (nthcdr 3 form
)))
2188 (when (and (stringp (car body
))
2189 (symbolp (car-safe (cdr-safe body
)))
2190 (car-safe (cdr-safe body
))
2191 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
2192 (byte-compile-set-symbol-position (nth 1 form
))
2193 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2196 ;; Generate code for declarations in macro definitions.
2197 ;; Remove declarations from the body of the macro definition.
2199 (let ((tail (nthcdr 2 form
)))
2200 (when (stringp (car (cdr tail
)))
2201 (setq tail
(cdr tail
)))
2202 (while (and (consp (car (cdr tail
)))
2203 (eq (car (car (cdr tail
))) 'declare
))
2204 (let ((declaration (car (cdr tail
))))
2205 (setcdr tail
(cdr (cdr tail
)))
2206 (princ `(if macro-declaration-function
2207 (funcall macro-declaration-function
2208 ',name
',declaration
))
2211 (let* ((new-one (byte-compile-lambda (cons 'lambda
(nthcdr 2 form
))))
2212 (code (byte-compile-byte-code-maker new-one
)))
2214 (setcdr this-one new-one
)
2216 (cons (cons name new-one
) (symbol-value this-kind
))))
2217 (if (and (stringp (nth 3 form
))
2218 (eq 'quote
(car-safe code
))
2219 (eq 'lambda
(car-safe (nth 1 code
))))
2221 (cons name
(cdr (nth 1 code
))))
2222 (byte-compile-flush-pending)
2223 (if (not (stringp (nth 3 form
)))
2224 ;; No doc string. Provide -1 as the "doc string index"
2225 ;; so that no element will be treated as a doc string.
2226 (byte-compile-output-docform
2227 (if (byte-compile-version-cond byte-compile-compatibility
)
2228 "\n(fset '" "\n(defalias '")
2231 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]")))
2232 ((eq (car code
) 'quote
)
2234 (if macrop
'(" '(macro " -
1 ")") '(" '(" -
1 ")")))
2235 ((if macrop
'(" (cons 'macro (" -
1 "))") '(" (" -
1 ")"))))
2237 (and (atom code
) byte-compile-dynamic
2240 ;; Output the form by hand, that's much simpler than having
2241 ;; b-c-output-file-form analyze the defalias.
2242 (byte-compile-output-docform
2243 (if (byte-compile-version-cond byte-compile-compatibility
)
2244 "\n(fset '" "\n(defalias '")
2247 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2248 ((eq (car code
) 'quote
)
2250 (if macrop
'(" '(macro " 2 ")") '(" '(" 2 ")")))
2251 ((if macrop
'(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2253 (and (atom code
) byte-compile-dynamic
2256 (princ ")" outbuffer
)
2259 ;; Print Lisp object EXP in the output file, inside a comment,
2260 ;; and return the file position it will have.
2261 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2262 (defun byte-compile-output-as-comment (exp quoted
)
2263 (let ((position (point)))
2265 (prog1 (current-buffer)
2266 (set-buffer outbuffer
)
2268 ;; Insert EXP, and make it a comment with #@LENGTH.
2271 (prin1 exp outbuffer
)
2272 (princ exp outbuffer
))
2273 (goto-char position
)
2274 ;; Quote certain special characters as needed.
2275 ;; get_doc_string in doc.c does the unquoting.
2276 (while (search-forward "\^A" nil t
)
2277 (replace-match "\^A\^A" t t
))
2278 (goto-char position
)
2279 (while (search-forward "\000" nil t
)
2280 (replace-match "\^A0" t t
))
2281 (goto-char position
)
2282 (while (search-forward "\037" nil t
)
2283 (replace-match "\^A_" t t
))
2284 (goto-char (point-max))
2286 (goto-char position
)
2287 (insert "#@" (format "%d" (- (position-bytes (point-max))
2288 (position-bytes position
))))
2290 ;; Save the file position of the object.
2291 ;; Note we should add 1 to skip the space
2292 ;; that we inserted before the actual doc string,
2293 ;; and subtract 1 to convert from an 1-origin Emacs position
2294 ;; to a file position; they cancel.
2295 (setq position
(point))
2296 (goto-char (point-max))))
2302 (defun byte-compile (form)
2303 "If FORM is a symbol, byte-compile its function definition.
2304 If FORM is a lambda or a macro, byte-compile it as a function."
2305 (displaying-byte-compile-warnings
2306 (byte-compile-close-variables
2307 (let* ((fun (if (symbolp form
)
2308 (and (fboundp form
) (symbol-function form
))
2310 (macro (eq (car-safe fun
) 'macro
)))
2312 (setq fun
(cdr fun
)))
2313 (cond ((eq (car-safe fun
) 'lambda
)
2315 (cons 'macro
(byte-compile-lambda fun
))
2316 (byte-compile-lambda fun
)))
2321 (defun byte-compile-sexp (sexp)
2322 "Compile and return SEXP."
2323 (displaying-byte-compile-warnings
2324 (byte-compile-close-variables
2325 (byte-compile-top-level sexp
))))
2327 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2328 (defun byte-compile-byte-code-maker (fun)
2330 ((byte-compile-version-cond byte-compile-compatibility
)
2331 ;; Return (quote (lambda ...)).
2332 (list 'quote
(byte-compile-byte-code-unmake fun
)))
2333 ;; ## atom is faster than compiled-func-p.
2334 ((atom fun
) ; compiled function.
2335 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2336 ;; would have produced a lambda.
2338 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2339 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2341 (if (and (setq tmp
(assq 'byte-code
(cdr-safe (cdr fun
))))
2342 (null (cdr (memq tmp fun
))))
2343 ;; Generate a make-byte-code call.
2344 (let* ((interactive (assq 'interactive
(cdr (cdr fun
)))))
2345 (nconc (list 'make-byte-code
2346 (list 'quote
(nth 1 fun
)) ;arglist
2350 (cond ((stringp (nth 2 fun
))
2351 (list (nth 2 fun
))) ;doc
2355 (list (if (or (null (nth 1 interactive
))
2356 (stringp (nth 1 interactive
)))
2358 ;; Interactive spec is a list or a variable
2359 ;; (if it is correct).
2360 (list 'quote
(nth 1 interactive
))))))))
2361 ;; a non-compiled function (probably trivial)
2362 (list 'quote fun
))))))
2364 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2365 (defun byte-compile-byte-code-unmake (function)
2366 (if (consp function
)
2367 function
;;It already is a lambda.
2368 (setq function
(append function nil
)) ; turn it into a list
2369 (nconc (list 'lambda
(nth 0 function
))
2370 (and (nth 4 function
) (list (nth 4 function
)))
2371 (if (nthcdr 5 function
)
2372 (list (cons 'interactive
(if (nth 5 function
)
2373 (nthcdr 5 function
)))))
2374 (list (list 'byte-code
2375 (nth 1 function
) (nth 2 function
)
2376 (nth 3 function
))))))
2379 (defun byte-compile-check-lambda-list (list)
2380 "Check lambda-list LIST for errors."
2383 (let ((arg (car list
)))
2385 (byte-compile-set-symbol-position arg
))
2386 (cond ((or (not (symbolp arg
))
2387 (byte-compile-const-symbol-p arg t
))
2388 (error "Invalid lambda variable %s" arg
))
2391 (error "&rest without variable name"))
2393 (error "Garbage following &rest VAR in lambda-list")))
2394 ((eq arg
'&optional
)
2396 (error "Variable name missing after &optional")))
2398 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2401 (setq list
(cdr list
)))))
2404 ;; Byte-compile a lambda-expression and return a valid function.
2405 ;; The value is usually a compiled function but may be the original
2406 ;; lambda-expression.
2407 (defun byte-compile-lambda (fun)
2408 (unless (eq 'lambda
(car-safe fun
))
2409 (error "Not a lambda list: %S" fun
))
2410 (byte-compile-set-symbol-position 'lambda
)
2411 (byte-compile-check-lambda-list (nth 1 fun
))
2412 (let* ((arglist (nth 1 fun
))
2413 (byte-compile-bound-variables
2414 (nconc (and (memq 'free-vars byte-compile-warnings
)
2415 (delq '&rest
(delq '&optional
(copy-sequence arglist
))))
2416 byte-compile-bound-variables
))
2417 (body (cdr (cdr fun
)))
2418 (doc (if (stringp (car body
))
2420 ;; Discard the doc string
2421 ;; unless it is the last element of the body.
2423 (setq body
(cdr body
))))))
2424 (int (assq 'interactive body
)))
2425 ;; Process the interactive spec.
2427 (byte-compile-set-symbol-position 'interactive
)
2428 ;; Skip (interactive) if it is in front (the most usual location).
2429 (if (eq int
(car body
))
2430 (setq body
(cdr body
)))
2431 (cond ((consp (cdr int
))
2433 (byte-compile-warn "malformed interactive spec: %s"
2434 (prin1-to-string int
)))
2435 ;; If the interactive spec is a call to `list',
2436 ;; don't compile it, because `call-interactively'
2437 ;; looks at the args of `list'.
2438 (let ((form (nth 1 int
)))
2439 (while (memq (car-safe form
) '(let let
* progn save-excursion
))
2440 (while (consp (cdr form
))
2441 (setq form
(cdr form
)))
2442 (setq form
(car form
)))
2443 (or (eq (car-safe form
) 'list
)
2444 (setq int
(list 'interactive
2445 (byte-compile-top-level (nth 1 int
)))))))
2447 (byte-compile-warn "malformed interactive spec: %s"
2448 (prin1-to-string int
)))))
2449 ;; Process the body.
2450 (let ((compiled (byte-compile-top-level (cons 'progn body
) nil
'lambda
)))
2451 ;; Build the actual byte-coded function.
2452 (if (and (eq 'byte-code
(car-safe compiled
))
2453 (not (byte-compile-version-cond
2454 byte-compile-compatibility
)))
2455 (apply 'make-byte-code
2456 (append (list arglist
)
2457 ;; byte-string, constants-vector, stack depth
2459 ;; optionally, the doc string.
2462 ;; optionally, the interactive spec.
2464 (list (nth 1 int
)))))
2466 (nconc (if int
(list int
))
2467 (cond ((eq (car-safe compiled
) 'progn
) (cdr compiled
))
2468 (compiled (list compiled
)))))
2469 (nconc (list 'lambda arglist
)
2470 (if (or doc
(stringp (car compiled
)))
2471 (cons doc
(cond (compiled)
2475 (defun byte-compile-constants-vector ()
2476 ;; Builds the constants-vector from the current variables and constants.
2477 ;; This modifies the constants from (const . nil) to (const . offset).
2478 ;; To keep the byte-codes to look up the vector as short as possible:
2479 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2480 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2481 ;; Next variables again, to get 2-byte codes for variable lookup.
2482 ;; The rest of the constants and variables need 3-byte byte-codes.
2484 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2485 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2487 (limits '(5 ; Use the 1-byte varref codes,
2488 63 ; 1-constlim ; 1-byte byte-constant codes,
2489 255 ; 2-byte varref codes,
2490 65535)) ; 3-byte codes for the rest.
2492 (while (or rest other
)
2493 (setq limit
(car limits
))
2494 (while (and rest
(not (eq i limit
)))
2495 (if (setq tmp
(assq (car (car rest
)) ret
))
2496 (setcdr (car rest
) (cdr tmp
))
2497 (setcdr (car rest
) (setq i
(1+ i
)))
2498 (setq ret
(cons (car rest
) ret
)))
2499 (setq rest
(cdr rest
)))
2500 (setq limits
(cdr limits
)
2502 (setq other rest
))))
2503 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2505 ;; Given an expression FORM, compile it and return an equivalent byte-code
2506 ;; expression (a call to the function byte-code).
2507 (defun byte-compile-top-level (form &optional for-effect output-type
)
2508 ;; OUTPUT-TYPE advises about how form is expected to be used:
2509 ;; 'eval or nil -> a single form,
2510 ;; 'progn or t -> a list of forms,
2511 ;; 'lambda -> body of a lambda,
2512 ;; 'file -> used at file-level.
2513 (let ((byte-compile-constants nil
)
2514 (byte-compile-variables nil
)
2515 (byte-compile-tag-number 0)
2516 (byte-compile-depth 0)
2517 (byte-compile-maxdepth 0)
2518 (byte-compile-output nil
))
2519 (if (memq byte-optimize
'(t source
))
2520 (setq form
(byte-optimize-form form for-effect
)))
2521 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2522 (setq form
(nth 1 form
)))
2523 (if (and (eq 'byte-code
(car-safe form
))
2524 (not (memq byte-optimize
'(t byte
)))
2525 (stringp (nth 1 form
)) (vectorp (nth 2 form
))
2526 (natnump (nth 3 form
)))
2528 (byte-compile-form form for-effect
)
2529 (byte-compile-out-toplevel for-effect output-type
))))
2531 (defun byte-compile-out-toplevel (&optional for-effect output-type
)
2533 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2534 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2535 (setq byte-compile-output
(cdr byte-compile-output
))
2536 (byte-compile-push-constant
2537 ;; Push any constant - preferably one which already is used, and
2538 ;; a number or symbol - ie not some big sequence. The return value
2539 ;; isn't returned, but it would be a shame if some textually large
2540 ;; constant was not optimized away because we chose to return it.
2541 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2542 (let ((tmp (reverse byte-compile-constants
)))
2543 (while (and tmp
(not (or (symbolp (caar tmp
))
2544 (numberp (caar tmp
)))))
2545 (setq tmp
(cdr tmp
)))
2547 (byte-compile-out 'byte-return
0)
2548 (setq byte-compile-output
(nreverse byte-compile-output
))
2549 (if (memq byte-optimize
'(t byte
))
2550 (setq byte-compile-output
2551 (byte-optimize-lapcode byte-compile-output for-effect
)))
2553 ;; Decompile trivial functions:
2554 ;; only constants and variables, or a single funcall except in lambdas.
2555 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2556 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2557 ;; Note that even (quote foo) must be parsed just as any subr by the
2558 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2559 ;; What to leave uncompiled:
2560 ;; lambda -> never. we used to leave it uncompiled if the body was
2561 ;; a single atom, but that causes confusion if the docstring
2562 ;; uses the (file . pos) syntax. Besides, now that we have
2563 ;; the Lisp_Compiled type, the compiled form is faster.
2564 ;; eval -> atom, quote or (function atom atom atom)
2565 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2566 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2568 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2571 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2572 ((or (eq output-type
'lambda
)
2573 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2574 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2575 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2577 (setq rest
(nreverse
2578 (cdr (memq tmp
(reverse byte-compile-output
)))))
2580 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2581 (setq tmp
(car (cdr (car rest
))))
2582 (if (if (eq (car (car rest
)) 'byte-constant
)
2585 (not (byte-compile-const-symbol-p tmp
)))))
2587 (setq body
(cons (list 'quote tmp
) body
)))
2588 (setq body
(cons tmp body
))))
2590 ;; Allow a funcall if at most one atom follows it.
2591 (null (nthcdr 3 rest
))
2592 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2593 (or (null (cdr rest
))
2594 (and (memq output-type
'(file progn t
))
2596 (eq (car (nth 1 rest
)) 'byte-discard
)
2597 (progn (setq rest
(cdr rest
)) t
))))
2598 (setq maycall nil
) ; Only allow one real function call.
2599 (setq body
(nreverse body
))
2601 (if (and (eq tmp
'funcall
)
2602 (eq (car-safe (car body
)) 'quote
))
2603 (cons (nth 1 (car body
)) (cdr body
))
2605 (or (eq output-type
'file
)
2606 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2607 (setq rest
(cdr rest
)))
2609 (let ((byte-compile-vector (byte-compile-constants-vector)))
2610 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2611 byte-compile-vector byte-compile-maxdepth
)))
2612 ;; it's a trivial function
2613 ((cdr body
) (cons 'progn
(nreverse body
)))
2616 ;; Given BODY, compile it and return a new body.
2617 (defun byte-compile-top-level-body (body &optional for-effect
)
2618 (setq body
(byte-compile-top-level (cons 'progn body
) for-effect t
))
2619 (cond ((eq (car-safe body
) 'progn
)
2624 ;; This is the recursive entry point for compiling each subform of an
2626 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2627 ;; before terminating (ie no value will be left on the stack).
2628 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2629 ;; which does not leave a value on the stack, and then set for-effect to nil
2630 ;; (to prevent byte-compile-form from outputting the byte-discard).
2631 ;; If a handler wants to call another handler, it should do so via
2632 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2633 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2635 (defun byte-compile-form (form &optional for-effect
)
2636 (setq form
(macroexpand form byte-compile-macro-environment
))
2637 (cond ((not (consp form
))
2638 (when (symbolp form
)
2639 (byte-compile-set-symbol-position form
))
2640 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2641 (byte-compile-constant form
))
2642 ((and for-effect byte-compile-delete-errors
)
2643 (setq for-effect nil
))
2644 (t (byte-compile-variable-ref 'byte-varref form
))))
2645 ((symbolp (car form
))
2646 (let* ((fn (car form
))
2647 (handler (get fn
'byte-compile
)))
2648 (byte-compile-set-symbol-position fn
)
2649 (when (byte-compile-const-symbol-p fn
)
2650 (byte-compile-warn "%s called as a function" fn
))
2652 (or (not (byte-compile-version-cond
2653 byte-compile-compatibility
))
2654 (not (get (get fn
'byte-opcode
) 'emacs19-opcode
))))
2655 (funcall handler form
)
2656 (if (memq 'callargs byte-compile-warnings
)
2657 (byte-compile-callargs-warn form
))
2658 (byte-compile-normal-call form
))
2659 (if (memq 'cl-functions byte-compile-warnings
)
2660 (byte-compile-cl-warn form
))))
2661 ((and (or (byte-code-function-p (car form
))
2662 (eq (car-safe (car form
)) 'lambda
))
2663 ;; if the form comes out the same way it went in, that's
2664 ;; because it was malformed, and we couldn't unfold it.
2665 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
2666 (byte-compile-form form for-effect
)
2667 (setq for-effect nil
))
2668 ((byte-compile-normal-call form
)))
2670 (byte-compile-discard)))
2672 (defun byte-compile-normal-call (form)
2673 (if byte-compile-generate-call-tree
2674 (byte-compile-annotate-call-tree form
))
2675 (byte-compile-push-constant (car form
))
2676 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
2677 (byte-compile-out 'byte-call
(length (cdr form
))))
2679 (defun byte-compile-variable-ref (base-op var
)
2681 (byte-compile-set-symbol-position var
))
2682 (if (or (not (symbolp var
))
2683 (byte-compile-const-symbol-p var
(not (eq base-op
'byte-varref
))))
2685 (cond ((eq base-op
'byte-varbind
) "attempt to let-bind %s %s")
2686 ((eq base-op
'byte-varset
) "variable assignment to %s %s")
2687 (t "variable reference to %s %s"))
2688 (if (symbolp var
) "constant" "nonvariable")
2689 (prin1-to-string var
))
2690 (if (and (get var
'byte-obsolete-variable
)
2691 (memq 'obsolete byte-compile-warnings
))
2692 (let* ((ob (get var
'byte-obsolete-variable
))
2694 (byte-compile-warn "%s is an obsolete variable%s; %s" var
2695 (if when
(concat " since " when
) "")
2696 (if (stringp (car ob
))
2698 (format "use %s instead." (car ob
))))))
2699 (if (memq 'free-vars byte-compile-warnings
)
2700 (if (eq base-op
'byte-varbind
)
2701 (push var byte-compile-bound-variables
)
2703 (memq var byte-compile-bound-variables
)
2704 (if (eq base-op
'byte-varset
)
2705 (or (memq var byte-compile-free-assignments
)
2707 (byte-compile-warn "assignment to free variable %s" var
)
2708 (push var byte-compile-free-assignments
)))
2709 (or (memq var byte-compile-free-references
)
2711 (byte-compile-warn "reference to free variable %s" var
)
2712 (push var byte-compile-free-references
))))))))
2713 (let ((tmp (assq var byte-compile-variables
)))
2715 (setq tmp
(list var
))
2716 (push tmp byte-compile-variables
))
2717 (byte-compile-out base-op tmp
)))
2719 (defmacro byte-compile-get-constant
(const)
2720 `(or (if (stringp ,const
)
2721 (assoc ,const byte-compile-constants
)
2722 (assq ,const byte-compile-constants
))
2723 (car (setq byte-compile-constants
2724 (cons (list ,const
) byte-compile-constants
)))))
2726 ;; Use this when the value of a form is a constant. This obeys for-effect.
2727 (defun byte-compile-constant (const)
2729 (setq for-effect nil
)
2730 (when (symbolp const
)
2731 (byte-compile-set-symbol-position const
))
2732 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
2734 ;; Use this for a constant that is not the value of its containing form.
2735 ;; This ignores for-effect.
2736 (defun byte-compile-push-constant (const)
2737 (let ((for-effect nil
))
2738 (inline (byte-compile-constant const
))))
2741 ;; Compile those primitive ordinary functions
2742 ;; which have special byte codes just for speed.
2744 (defmacro byte-defop-compiler
(function &optional compile-handler
)
2745 ;; add a compiler-form for FUNCTION.
2746 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2747 ;; the opcode to be used. If function is a list, the first element
2748 ;; is the function and the second element is the bytecode-symbol.
2749 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2750 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2751 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2753 (if (symbolp function
)
2754 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
2755 (setq opcode
(car (cdr function
))
2756 function
(car function
)))
2758 (list 'put
(list 'quote function
) ''byte-compile
2760 (or (cdr (assq compile-handler
2761 '((0 . byte-compile-no-args
)
2762 (1 . byte-compile-one-arg
)
2763 (2 . byte-compile-two-args
)
2764 (3 . byte-compile-three-args
)
2765 (0-1 . byte-compile-zero-or-one-arg
)
2766 (1-2 . byte-compile-one-or-two-args
)
2767 (2-3 . byte-compile-two-or-three-args
)
2770 (intern (concat "byte-compile-"
2771 (symbol-name function
))))))))
2774 (list 'put
(list 'quote function
)
2775 ''byte-opcode
(list 'quote opcode
))
2776 (list 'put
(list 'quote opcode
)
2777 ''byte-opcode-invert
(list 'quote function
)))
2780 (defmacro byte-defop-compiler19
(function &optional compile-handler
)
2781 ;; Just like byte-defop-compiler, but defines an opcode that will only
2782 ;; be used when byte-compile-compatibility is false.
2783 (if (and (byte-compile-single-version)
2784 byte-compile-compatibility
)
2785 ;; #### instead of doing nothing, this should do some remprops,
2786 ;; #### to protect against the case where a single-version compiler
2787 ;; #### is loaded into a world that has contained a multi-version one.
2792 (or (car (cdr-safe function
))
2793 (intern (concat "byte-"
2794 (symbol-name (or (car-safe function
) function
))))))
2796 (list 'byte-defop-compiler function compile-handler
))))
2798 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
2799 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
2802 (put 'byte-call
'byte-opcode-invert
'funcall
)
2803 (put 'byte-list1
'byte-opcode-invert
'list
)
2804 (put 'byte-list2
'byte-opcode-invert
'list
)
2805 (put 'byte-list3
'byte-opcode-invert
'list
)
2806 (put 'byte-list4
'byte-opcode-invert
'list
)
2807 (put 'byte-listN
'byte-opcode-invert
'list
)
2808 (put 'byte-concat2
'byte-opcode-invert
'concat
)
2809 (put 'byte-concat3
'byte-opcode-invert
'concat
)
2810 (put 'byte-concat4
'byte-opcode-invert
'concat
)
2811 (put 'byte-concatN
'byte-opcode-invert
'concat
)
2812 (put 'byte-insertN
'byte-opcode-invert
'insert
)
2814 (byte-defop-compiler (dot byte-point
) 0)
2815 (byte-defop-compiler (dot-max byte-point-max
) 0)
2816 (byte-defop-compiler (dot-min byte-point-min
) 0)
2817 (byte-defop-compiler point
0)
2818 ;;(byte-defop-compiler mark 0) ;; obsolete
2819 (byte-defop-compiler point-max
0)
2820 (byte-defop-compiler point-min
0)
2821 (byte-defop-compiler following-char
0)
2822 (byte-defop-compiler preceding-char
0)
2823 (byte-defop-compiler current-column
0)
2824 (byte-defop-compiler eolp
0)
2825 (byte-defop-compiler eobp
0)
2826 (byte-defop-compiler bolp
0)
2827 (byte-defop-compiler bobp
0)
2828 (byte-defop-compiler current-buffer
0)
2829 ;;(byte-defop-compiler read-char 0) ;; obsolete
2830 (byte-defop-compiler interactive-p
0)
2831 (byte-defop-compiler19 widen
0)
2832 (byte-defop-compiler19 end-of-line
0-
1)
2833 (byte-defop-compiler19 forward-char
0-
1)
2834 (byte-defop-compiler19 forward-line
0-
1)
2835 (byte-defop-compiler symbolp
1)
2836 (byte-defop-compiler consp
1)
2837 (byte-defop-compiler stringp
1)
2838 (byte-defop-compiler listp
1)
2839 (byte-defop-compiler not
1)
2840 (byte-defop-compiler (null byte-not
) 1)
2841 (byte-defop-compiler car
1)
2842 (byte-defop-compiler cdr
1)
2843 (byte-defop-compiler length
1)
2844 (byte-defop-compiler symbol-value
1)
2845 (byte-defop-compiler symbol-function
1)
2846 (byte-defop-compiler (1+ byte-add1
) 1)
2847 (byte-defop-compiler (1- byte-sub1
) 1)
2848 (byte-defop-compiler goto-char
1)
2849 (byte-defop-compiler char-after
0-
1)
2850 (byte-defop-compiler set-buffer
1)
2851 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2852 (byte-defop-compiler19 forward-word
1)
2853 (byte-defop-compiler19 char-syntax
1)
2854 (byte-defop-compiler19 nreverse
1)
2855 (byte-defop-compiler19 car-safe
1)
2856 (byte-defop-compiler19 cdr-safe
1)
2857 (byte-defop-compiler19 numberp
1)
2858 (byte-defop-compiler19 integerp
1)
2859 (byte-defop-compiler19 skip-chars-forward
1-
2)
2860 (byte-defop-compiler19 skip-chars-backward
1-
2)
2861 (byte-defop-compiler eq
2)
2862 (byte-defop-compiler memq
2)
2863 (byte-defop-compiler cons
2)
2864 (byte-defop-compiler aref
2)
2865 (byte-defop-compiler set
2)
2866 (byte-defop-compiler (= byte-eqlsign
) 2)
2867 (byte-defop-compiler (< byte-lss
) 2)
2868 (byte-defop-compiler (> byte-gtr
) 2)
2869 (byte-defop-compiler (<= byte-leq
) 2)
2870 (byte-defop-compiler (>= byte-geq
) 2)
2871 (byte-defop-compiler get
2)
2872 (byte-defop-compiler nth
2)
2873 (byte-defop-compiler substring
2-
3)
2874 (byte-defop-compiler19 (move-marker byte-set-marker
) 2-
3)
2875 (byte-defop-compiler19 set-marker
2-
3)
2876 (byte-defop-compiler19 match-beginning
1)
2877 (byte-defop-compiler19 match-end
1)
2878 (byte-defop-compiler19 upcase
1)
2879 (byte-defop-compiler19 downcase
1)
2880 (byte-defop-compiler19 string
= 2)
2881 (byte-defop-compiler19 string
< 2)
2882 (byte-defop-compiler19 (string-equal byte-string
=) 2)
2883 (byte-defop-compiler19 (string-lessp byte-string
<) 2)
2884 (byte-defop-compiler19 equal
2)
2885 (byte-defop-compiler19 nthcdr
2)
2886 (byte-defop-compiler19 elt
2)
2887 (byte-defop-compiler19 member
2)
2888 (byte-defop-compiler19 assq
2)
2889 (byte-defop-compiler19 (rplaca byte-setcar
) 2)
2890 (byte-defop-compiler19 (rplacd byte-setcdr
) 2)
2891 (byte-defop-compiler19 setcar
2)
2892 (byte-defop-compiler19 setcdr
2)
2893 (byte-defop-compiler19 buffer-substring
2)
2894 (byte-defop-compiler19 delete-region
2)
2895 (byte-defop-compiler19 narrow-to-region
2)
2896 (byte-defop-compiler19 (% byte-rem
) 2)
2897 (byte-defop-compiler aset
3)
2899 (byte-defop-compiler max byte-compile-associative
)
2900 (byte-defop-compiler min byte-compile-associative
)
2901 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
2902 (byte-defop-compiler19 (* byte-mult
) byte-compile-associative
)
2904 ;;####(byte-defop-compiler19 move-to-column 1)
2905 (byte-defop-compiler-1 interactive byte-compile-noop
)
2908 (defun byte-compile-subr-wrong-args (form n
)
2909 (byte-compile-set-symbol-position (car form
))
2910 (byte-compile-warn "%s called with %d arg%s, but requires %s"
2911 (car form
) (length (cdr form
))
2912 (if (= 1 (length (cdr form
))) "" "s") n
)
2913 ;; get run-time wrong-number-of-args error.
2914 (byte-compile-normal-call form
))
2916 (defun byte-compile-no-args (form)
2917 (if (not (= (length form
) 1))
2918 (byte-compile-subr-wrong-args form
"none")
2919 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2921 (defun byte-compile-one-arg (form)
2922 (if (not (= (length form
) 2))
2923 (byte-compile-subr-wrong-args form
1)
2924 (byte-compile-form (car (cdr form
))) ;; Push the argument
2925 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2927 (defun byte-compile-two-args (form)
2928 (if (not (= (length form
) 3))
2929 (byte-compile-subr-wrong-args form
2)
2930 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2931 (byte-compile-form (nth 2 form
))
2932 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2934 (defun byte-compile-three-args (form)
2935 (if (not (= (length form
) 4))
2936 (byte-compile-subr-wrong-args form
3)
2937 (byte-compile-form (car (cdr form
))) ;; Push the arguments
2938 (byte-compile-form (nth 2 form
))
2939 (byte-compile-form (nth 3 form
))
2940 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
2942 (defun byte-compile-zero-or-one-arg (form)
2943 (let ((len (length form
)))
2944 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
2945 ((= len
2) (byte-compile-one-arg form
))
2946 (t (byte-compile-subr-wrong-args form
"0-1")))))
2948 (defun byte-compile-one-or-two-args (form)
2949 (let ((len (length form
)))
2950 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
2951 ((= len
3) (byte-compile-two-args form
))
2952 (t (byte-compile-subr-wrong-args form
"1-2")))))
2954 (defun byte-compile-two-or-three-args (form)
2955 (let ((len (length form
)))
2956 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
2957 ((= len
4) (byte-compile-three-args form
))
2958 (t (byte-compile-subr-wrong-args form
"2-3")))))
2960 (defun byte-compile-noop (form)
2961 (byte-compile-constant nil
))
2963 (defun byte-compile-discard ()
2964 (byte-compile-out 'byte-discard
0))
2967 ;; Compile a function that accepts one or more args and is right-associative.
2968 ;; We do it by left-associativity so that the operations
2969 ;; are done in the same order as in interpreted code.
2970 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
2971 ;; in order to convert markers to numbers, and trigger expected errors.
2972 (defun byte-compile-associative (form)
2974 (let ((opcode (get (car form
) 'byte-opcode
))
2975 (args (copy-sequence (cdr form
))))
2976 (byte-compile-form (car args
))
2977 (setq args
(cdr args
))
2978 (or args
(setq args
'(0)
2979 opcode
(get '+ 'byte-opcode
)))
2981 (byte-compile-form arg
)
2982 (byte-compile-out opcode
0)))
2983 (byte-compile-constant (eval form
))))
2986 ;; more complicated compiler macros
2988 (byte-defop-compiler list
)
2989 (byte-defop-compiler concat
)
2990 (byte-defop-compiler fset
)
2991 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
2992 (byte-defop-compiler indent-to
)
2993 (byte-defop-compiler insert
)
2994 (byte-defop-compiler-1 function byte-compile-function-form
)
2995 (byte-defop-compiler-1 - byte-compile-minus
)
2996 (byte-defop-compiler19 (/ byte-quo
) byte-compile-quo
)
2997 (byte-defop-compiler19 nconc
)
2999 (defun byte-compile-list (form)
3000 (let ((count (length (cdr form
))))
3002 (byte-compile-constant nil
))
3004 (mapc 'byte-compile-form
(cdr form
))
3006 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
3007 ((and (< count
256) (not (byte-compile-version-cond
3008 byte-compile-compatibility
)))
3009 (mapc 'byte-compile-form
(cdr form
))
3010 (byte-compile-out 'byte-listN count
))
3011 (t (byte-compile-normal-call form
)))))
3013 (defun byte-compile-concat (form)
3014 (let ((count (length (cdr form
))))
3015 (cond ((and (< 1 count
) (< count
5))
3016 (mapc 'byte-compile-form
(cdr form
))
3018 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
3020 ;; Concat of one arg is not a no-op if arg is not a string.
3022 (byte-compile-form ""))
3023 ((and (< count
256) (not (byte-compile-version-cond
3024 byte-compile-compatibility
)))
3025 (mapc 'byte-compile-form
(cdr form
))
3026 (byte-compile-out 'byte-concatN count
))
3027 ((byte-compile-normal-call form
)))))
3029 (defun byte-compile-minus (form)
3030 (if (null (setq form
(cdr form
)))
3031 (byte-compile-constant 0)
3032 (byte-compile-form (car form
))
3034 (while (setq form
(cdr form
))
3035 (byte-compile-form (car form
))
3036 (byte-compile-out 'byte-diff
0))
3037 (byte-compile-out 'byte-negate
0))))
3039 (defun byte-compile-quo (form)
3040 (let ((len (length form
)))
3042 (byte-compile-subr-wrong-args form
"2 or more"))
3044 (byte-compile-form (car (setq form
(cdr form
))))
3045 (while (setq form
(cdr form
))
3046 (byte-compile-form (car form
))
3047 (byte-compile-out 'byte-quo
0))))))
3049 (defun byte-compile-nconc (form)
3050 (let ((len (length form
)))
3052 (byte-compile-constant nil
))
3054 ;; nconc of one arg is a noop, even if that arg isn't a list.
3055 (byte-compile-form (nth 1 form
)))
3057 (byte-compile-form (car (setq form
(cdr form
))))
3058 (while (setq form
(cdr form
))
3059 (byte-compile-form (car form
))
3060 (byte-compile-out 'byte-nconc
0))))))
3062 (defun byte-compile-fset (form)
3063 ;; warn about forms like (fset 'foo '(lambda () ...))
3064 ;; (where the lambda expression is non-trivial...)
3065 (let ((fn (nth 2 form
))
3067 (if (and (eq (car-safe fn
) 'quote
)
3068 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
3070 (setq body
(cdr (cdr fn
)))
3071 (if (stringp (car body
)) (setq body
(cdr body
)))
3072 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
3073 (if (and (consp (car body
))
3074 (not (eq 'byte-code
(car (car body
)))))
3076 "A quoted lambda form is the second argument of fset. This is probably
3077 not what you want, as that lambda cannot be compiled. Consider using
3078 the syntax (function (lambda (...) ...)) instead.")))))
3079 (byte-compile-two-args form
))
3081 (defun byte-compile-funarg (form)
3082 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3083 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3084 (byte-compile-normal-call
3085 (let ((fn (nth 1 form
)))
3086 (if (and (eq (car-safe fn
) 'quote
)
3087 (eq (car-safe (nth 1 fn
)) 'lambda
))
3089 (cons (cons 'function
(cdr fn
))
3093 (defun byte-compile-funarg-2 (form)
3094 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3095 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3096 (byte-compile-normal-call
3097 (let ((fn (nth 2 form
)))
3098 (if (and (eq (car-safe fn
) 'quote
)
3099 (eq (car-safe (nth 1 fn
)) 'lambda
))
3102 (cons (cons 'function
(cdr fn
))
3103 (cdr (cdr (cdr form
))))))
3106 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3107 ;; Otherwise it will be incompatible with the interpreter,
3108 ;; and (funcall (function foo)) will lose with autoloads.
3110 (defun byte-compile-function-form (form)
3111 (byte-compile-constant
3112 (cond ((symbolp (nth 1 form
))
3114 ;; If we're not allowed to use #[] syntax, then output a form like
3115 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3116 ;; In this situation, calling make-byte-code at run-time will usually
3117 ;; be less efficient than processing a call to byte-code.
3118 ((byte-compile-version-cond byte-compile-compatibility
)
3119 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form
))))
3120 ((byte-compile-lambda (nth 1 form
))))))
3122 (defun byte-compile-indent-to (form)
3123 (let ((len (length form
)))
3125 (byte-compile-form (car (cdr form
)))
3126 (byte-compile-out 'byte-indent-to
0))
3128 ;; no opcode for 2-arg case.
3129 (byte-compile-normal-call form
))
3131 (byte-compile-subr-wrong-args form
"1-2")))))
3133 (defun byte-compile-insert (form)
3134 (cond ((null (cdr form
))
3135 (byte-compile-constant nil
))
3136 ((and (not (byte-compile-version-cond
3137 byte-compile-compatibility
))
3138 (<= (length form
) 256))
3139 (mapc 'byte-compile-form
(cdr form
))
3140 (if (cdr (cdr form
))
3141 (byte-compile-out 'byte-insertN
(length (cdr form
)))
3142 (byte-compile-out 'byte-insert
0)))
3143 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
3144 (byte-compile-normal-call form
))
3145 ;; We can split it; there is no function call after inserting 1st arg.
3147 (while (setq form
(cdr form
))
3148 (byte-compile-form (car form
))
3149 (byte-compile-out 'byte-insert
0)
3151 (byte-compile-discard))))))
3154 (byte-defop-compiler-1 setq
)
3155 (byte-defop-compiler-1 setq-default
)
3156 (byte-defop-compiler-1 quote
)
3157 (byte-defop-compiler-1 quote-form
)
3159 (defun byte-compile-setq (form)
3160 (let ((args (cdr form
)))
3163 (byte-compile-form (car (cdr args
)))
3164 (or for-effect
(cdr (cdr args
))
3165 (byte-compile-out 'byte-dup
0))
3166 (byte-compile-variable-ref 'byte-varset
(car args
))
3167 (setq args
(cdr (cdr args
))))
3168 ;; (setq), with no arguments.
3169 (byte-compile-form nil for-effect
))
3170 (setq for-effect nil
)))
3172 (defun byte-compile-setq-default (form)
3173 (let ((args (cdr form
))
3177 (cons (list 'set-default
(list 'quote
(car args
)) (car (cdr args
)))
3179 (setq args
(cdr (cdr args
))))
3180 (byte-compile-form (cons 'progn
(nreverse setters
)))))
3182 (defun byte-compile-quote (form)
3183 (byte-compile-constant (car (cdr form
))))
3185 (defun byte-compile-quote-form (form)
3186 (byte-compile-constant (byte-compile-top-level (nth 1 form
))))
3189 ;;; control structures
3191 (defun byte-compile-body (body &optional for-effect
)
3193 (byte-compile-form (car body
) t
)
3194 (setq body
(cdr body
)))
3195 (byte-compile-form (car body
) for-effect
))
3197 (defsubst byte-compile-body-do-effect
(body)
3198 (byte-compile-body body for-effect
)
3199 (setq for-effect nil
))
3201 (defsubst byte-compile-form-do-effect
(form)
3202 (byte-compile-form form for-effect
)
3203 (setq for-effect nil
))
3205 (byte-defop-compiler-1 inline byte-compile-progn
)
3206 (byte-defop-compiler-1 progn
)
3207 (byte-defop-compiler-1 prog1
)
3208 (byte-defop-compiler-1 prog2
)
3209 (byte-defop-compiler-1 if
)
3210 (byte-defop-compiler-1 cond
)
3211 (byte-defop-compiler-1 and
)
3212 (byte-defop-compiler-1 or
)
3213 (byte-defop-compiler-1 while
)
3214 (byte-defop-compiler-1 funcall
)
3215 (byte-defop-compiler-1 apply byte-compile-funarg
)
3216 (byte-defop-compiler-1 mapcar byte-compile-funarg
)
3217 (byte-defop-compiler-1 mapatoms byte-compile-funarg
)
3218 (byte-defop-compiler-1 mapconcat byte-compile-funarg
)
3219 (byte-defop-compiler-1 mapc byte-compile-funarg
)
3220 (byte-defop-compiler-1 maphash byte-compile-funarg
)
3221 (byte-defop-compiler-1 map-char-table byte-compile-funarg
)
3222 (byte-defop-compiler-1 sort byte-compile-funarg-2
)
3223 (byte-defop-compiler-1 let
)
3224 (byte-defop-compiler-1 let
*)
3226 (defun byte-compile-progn (form)
3227 (byte-compile-body-do-effect (cdr form
)))
3229 (defun byte-compile-prog1 (form)
3230 (byte-compile-form-do-effect (car (cdr form
)))
3231 (byte-compile-body (cdr (cdr form
)) t
))
3233 (defun byte-compile-prog2 (form)
3234 (byte-compile-form (nth 1 form
) t
)
3235 (byte-compile-form-do-effect (nth 2 form
))
3236 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3238 (defmacro byte-compile-goto-if
(cond discard tag
)
3241 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3242 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3245 (defun byte-compile-if (form)
3246 (byte-compile-form (car (cdr form
)))
3247 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3248 ;; and avoid warnings about the relevent symbols in the consequent.
3249 (let* ((clause (nth 1 form
))
3250 (fbound (if (eq 'fboundp
(car-safe clause
))
3251 (and (eq 'quote
(car-safe (nth 1 clause
)))
3252 ;; Ignore if the symbol is already on the
3255 (nth 1 (nth 1 clause
)) ; the relevant symbol
3256 byte-compile-unresolved-functions
))
3257 (nth 1 (nth 1 clause
)))))
3258 (bound (if (eq 'boundp
(car-safe clause
))
3259 (and (eq 'quote
(car-safe (nth 1 clause
)))
3260 (nth 1 (nth 1 clause
)))))
3261 (donetag (byte-compile-make-tag)))
3262 (if (null (nthcdr 3 form
))
3265 (byte-compile-goto-if nil for-effect donetag
)
3266 ;; Maybe add to the bound list.
3267 (let ((byte-compile-bound-variables
3269 (cons bound byte-compile-bound-variables
)
3270 byte-compile-bound-variables
)))
3271 (byte-compile-form (nth 2 form
) for-effect
))
3272 ;; Maybe remove the function symbol from the unresolved list.
3274 (setq byte-compile-unresolved-functions
3275 (delq (assq fbound byte-compile-unresolved-functions
)
3276 byte-compile-unresolved-functions
)))
3277 (byte-compile-out-tag donetag
))
3278 (let ((elsetag (byte-compile-make-tag)))
3279 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3280 ;; As above for the first form.
3281 (let ((byte-compile-bound-variables
3283 (cons bound byte-compile-bound-variables
)
3284 byte-compile-bound-variables
)))
3285 (byte-compile-form (nth 2 form
) for-effect
))
3287 (setq byte-compile-unresolved-functions
3288 (delq (assq fbound byte-compile-unresolved-functions
)
3289 byte-compile-unresolved-functions
)))
3290 (byte-compile-goto 'byte-goto donetag
)
3291 (byte-compile-out-tag elsetag
)
3292 (byte-compile-body (cdr (cdr (cdr form
))) for-effect
)
3293 (byte-compile-out-tag donetag
))))
3294 (setq for-effect nil
))
3296 (defun byte-compile-cond (clauses)
3297 (let ((donetag (byte-compile-make-tag))
3299 (while (setq clauses
(cdr clauses
))
3300 (setq clause
(car clauses
))
3301 (cond ((or (eq (car clause
) t
)
3302 (and (eq (car-safe (car clause
)) 'quote
)
3303 (car-safe (cdr-safe (car clause
)))))
3304 ;; Unconditional clause
3305 (setq clause
(cons t clause
)
3308 (byte-compile-form (car clause
))
3309 (if (null (cdr clause
))
3310 ;; First clause is a singleton.
3311 (byte-compile-goto-if t for-effect donetag
)
3312 (setq nexttag
(byte-compile-make-tag))
3313 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3314 (byte-compile-body (cdr clause
) for-effect
)
3315 (byte-compile-goto 'byte-goto donetag
)
3316 (byte-compile-out-tag nexttag
)))))
3318 (and (cdr clause
) (not (eq (car clause
) t
))
3319 (progn (byte-compile-form (car clause
))
3320 (byte-compile-goto-if nil for-effect donetag
)
3321 (setq clause
(cdr clause
))))
3322 (byte-compile-body-do-effect clause
)
3323 (byte-compile-out-tag donetag
)))
3325 (defun byte-compile-and (form)
3326 (let ((failtag (byte-compile-make-tag))
3329 (byte-compile-form-do-effect t
)
3331 (byte-compile-form (car args
))
3332 (byte-compile-goto-if nil for-effect failtag
)
3333 (setq args
(cdr args
)))
3334 (byte-compile-form-do-effect (car args
))
3335 (byte-compile-out-tag failtag
))))
3337 (defun byte-compile-or (form)
3338 (let ((wintag (byte-compile-make-tag))
3341 (byte-compile-form-do-effect nil
)
3343 (byte-compile-form (car args
))
3344 (byte-compile-goto-if t for-effect wintag
)
3345 (setq args
(cdr args
)))
3346 (byte-compile-form-do-effect (car args
))
3347 (byte-compile-out-tag wintag
))))
3349 (defun byte-compile-while (form)
3350 (let ((endtag (byte-compile-make-tag))
3351 (looptag (byte-compile-make-tag)))
3352 (byte-compile-out-tag looptag
)
3353 (byte-compile-form (car (cdr form
)))
3354 (byte-compile-goto-if nil for-effect endtag
)
3355 (byte-compile-body (cdr (cdr form
)) t
)
3356 (byte-compile-goto 'byte-goto looptag
)
3357 (byte-compile-out-tag endtag
)
3358 (setq for-effect nil
)))
3360 (defun byte-compile-funcall (form)
3361 (mapc 'byte-compile-form
(cdr form
))
3362 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3365 (defun byte-compile-let (form)
3366 ;; First compute the binding values in the old scope.
3367 (let ((varlist (car (cdr form
))))
3368 (dolist (var varlist
)
3370 (byte-compile-form (car (cdr var
)))
3371 (byte-compile-push-constant nil
))))
3372 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3373 (varlist (reverse (car (cdr form
)))))
3374 (dolist (var varlist
)
3375 (byte-compile-variable-ref 'byte-varbind
(if (consp var
) (car var
) var
)))
3376 (byte-compile-body-do-effect (cdr (cdr form
)))
3377 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3379 (defun byte-compile-let* (form)
3380 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3381 (varlist (copy-sequence (car (cdr form
)))))
3382 (dolist (var varlist
)
3384 (byte-compile-push-constant nil
)
3385 (byte-compile-form (car (cdr var
)))
3386 (setq var
(car var
)))
3387 (byte-compile-variable-ref 'byte-varbind var
))
3388 (byte-compile-body-do-effect (cdr (cdr form
)))
3389 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3392 (byte-defop-compiler-1 /= byte-compile-negated
)
3393 (byte-defop-compiler-1 atom byte-compile-negated
)
3394 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3396 (put '/= 'byte-compile-negated-op
'=)
3397 (put 'atom
'byte-compile-negated-op
'consp
)
3398 (put 'nlistp
'byte-compile-negated-op
'listp
)
3400 (defun byte-compile-negated (form)
3401 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3403 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3404 (defun byte-compile-negation-optimizer (form)
3405 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3406 (byte-compile-set-symbol-position (car form
))
3408 (cons (or (get (car form
) 'byte-compile-negated-op
)
3410 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3414 ;;; other tricky macro-like special-forms
3416 (byte-defop-compiler-1 catch
)
3417 (byte-defop-compiler-1 unwind-protect
)
3418 (byte-defop-compiler-1 condition-case
)
3419 (byte-defop-compiler-1 save-excursion
)
3420 (byte-defop-compiler-1 save-current-buffer
)
3421 (byte-defop-compiler-1 save-restriction
)
3422 (byte-defop-compiler-1 save-window-excursion
)
3423 (byte-defop-compiler-1 with-output-to-temp-buffer
)
3424 (byte-defop-compiler-1 track-mouse
)
3426 (defun byte-compile-catch (form)
3427 (byte-compile-form (car (cdr form
)))
3428 (byte-compile-push-constant
3429 (byte-compile-top-level (cons 'progn
(cdr (cdr form
))) for-effect
))
3430 (byte-compile-out 'byte-catch
0))
3432 (defun byte-compile-unwind-protect (form)
3433 (byte-compile-push-constant
3434 (byte-compile-top-level-body (cdr (cdr form
)) t
))
3435 (byte-compile-out 'byte-unwind-protect
0)
3436 (byte-compile-form-do-effect (car (cdr form
)))
3437 (byte-compile-out 'byte-unbind
1))
3439 (defun byte-compile-track-mouse (form)
3441 `(funcall '(lambda nil
3442 (track-mouse ,@(byte-compile-top-level-body (cdr form
)))))))
3444 (defun byte-compile-condition-case (form)
3445 (let* ((var (nth 1 form
))
3446 (byte-compile-bound-variables
3447 (if var
(cons var byte-compile-bound-variables
)
3448 byte-compile-bound-variables
)))
3449 (byte-compile-set-symbol-position 'condition-case
)
3450 (unless (symbolp var
)
3452 "%s is not a variable-name or nil (in condition-case)" var
))
3453 (byte-compile-push-constant var
)
3454 (byte-compile-push-constant (byte-compile-top-level
3455 (nth 2 form
) for-effect
))
3456 (let ((clauses (cdr (cdr (cdr form
))))
3459 (let* ((clause (car clauses
))
3460 (condition (car clause
)))
3461 (cond ((not (or (symbolp condition
)
3462 (and (listp condition
)
3463 (let ((syms condition
) (ok t
))
3465 (if (not (symbolp (car syms
)))
3467 (setq syms
(cdr syms
)))
3470 "%s is not a condition name or list of such (in condition-case)"
3471 (prin1-to-string condition
)))
3472 ;; ((not (or (eq condition 't)
3473 ;; (and (stringp (get condition 'error-message))
3474 ;; (consp (get condition 'error-conditions)))))
3475 ;; (byte-compile-warn
3476 ;; "%s is not a known condition name (in condition-case)"
3479 (setq compiled-clauses
3480 (cons (cons condition
3481 (byte-compile-top-level-body
3482 (cdr clause
) for-effect
))
3484 (setq clauses
(cdr clauses
)))
3485 (byte-compile-push-constant (nreverse compiled-clauses
)))
3486 (byte-compile-out 'byte-condition-case
0)))
3489 (defun byte-compile-save-excursion (form)
3490 (byte-compile-out 'byte-save-excursion
0)
3491 (byte-compile-body-do-effect (cdr form
))
3492 (byte-compile-out 'byte-unbind
1))
3494 (defun byte-compile-save-restriction (form)
3495 (byte-compile-out 'byte-save-restriction
0)
3496 (byte-compile-body-do-effect (cdr form
))
3497 (byte-compile-out 'byte-unbind
1))
3499 (defun byte-compile-save-current-buffer (form)
3500 (byte-compile-out 'byte-save-current-buffer
0)
3501 (byte-compile-body-do-effect (cdr form
))
3502 (byte-compile-out 'byte-unbind
1))
3504 (defun byte-compile-save-window-excursion (form)
3505 (byte-compile-push-constant
3506 (byte-compile-top-level-body (cdr form
) for-effect
))
3507 (byte-compile-out 'byte-save-window-excursion
0))
3509 (defun byte-compile-with-output-to-temp-buffer (form)
3510 (byte-compile-form (car (cdr form
)))
3511 (byte-compile-out 'byte-temp-output-buffer-setup
0)
3512 (byte-compile-body (cdr (cdr form
)))
3513 (byte-compile-out 'byte-temp-output-buffer-show
0))
3516 ;;; top-level forms elsewhere
3518 (byte-defop-compiler-1 defun
)
3519 (byte-defop-compiler-1 defmacro
)
3520 (byte-defop-compiler-1 defvar
)
3521 (byte-defop-compiler-1 defconst byte-compile-defvar
)
3522 (byte-defop-compiler-1 autoload
)
3523 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
3524 (byte-defop-compiler-1 defalias
)
3526 (defun byte-compile-defun (form)
3527 ;; This is not used for file-level defuns with doc strings.
3528 (if (symbolp (car form
))
3529 (byte-compile-set-symbol-position (car form
))
3530 (byte-compile-set-symbol-position 'defun
)
3531 (error "defun name must be a symbol, not %s" (car form
)))
3532 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3533 (list 'fset
(list 'quote
(nth 1 form
))
3534 (byte-compile-byte-code-maker
3535 (byte-compile-lambda (cons 'lambda
(cdr (cdr form
)))))))
3536 (byte-compile-discard)
3537 (byte-compile-constant (nth 1 form
)))
3539 (defun byte-compile-defmacro (form)
3540 ;; This is not used for file-level defmacros with doc strings.
3541 (byte-compile-body-do-effect
3542 (list (list 'fset
(list 'quote
(nth 1 form
))
3543 (let ((code (byte-compile-byte-code-maker
3544 (byte-compile-lambda
3545 (cons 'lambda
(cdr (cdr form
)))))))
3546 (if (eq (car-safe code
) 'make-byte-code
)
3547 (list 'cons
''macro code
)
3548 (list 'quote
(cons 'macro
(eval code
))))))
3549 (list 'quote
(nth 1 form
)))))
3551 (defun byte-compile-defvar (form)
3552 ;; This is not used for file-level defvar/consts with doc strings.
3553 (let ((fun (nth 0 form
))
3555 (value (nth 2 form
))
3556 (string (nth 3 form
)))
3557 (byte-compile-set-symbol-position fun
)
3558 (when (or (> (length form
) 4)
3559 (and (eq fun
'defconst
) (null (cddr form
))))
3561 "%s called with %d arguments, but accepts only %s"
3562 fun
(length (cdr form
)) "2-3"))
3563 (when (memq 'free-vars byte-compile-warnings
)
3564 (push var byte-compile-bound-variables
)
3565 (if (eq fun
'defconst
)
3566 (push var byte-compile-const-variables
)))
3567 (byte-compile-body-do-effect
3569 ;; Put the defined variable in this library's load-history entry
3570 ;; just as a real defvar would, but only in top-level forms.
3571 (when (and (cddr form
) (null byte-compile-current-form
))
3572 `(push ',var current-load-list
))
3573 (when (> (length form
) 3)
3574 (when (and string
(not (stringp string
)))
3575 (byte-compile-warn "third arg to %s %s is not a string: %s"
3577 `(put ',var
'variable-documentation
,string
))
3578 (if (cddr form
) ; `value' provided
3579 (if (eq fun
'defconst
)
3580 ;; `defconst' sets `var' unconditionally.
3581 (let ((tmp (make-symbol "defconst-tmp-var")))
3582 `(funcall '(lambda (,tmp
) (defconst ,var
,tmp
))
3584 ;; `defvar' sets `var' only when unbound.
3585 `(if (not (boundp ',var
)) (setq ,var
,value
)))
3586 (when (eq fun
'defconst
)
3587 ;; This will signal an appropriate error at runtime.
3591 (defun byte-compile-autoload (form)
3592 (byte-compile-set-symbol-position 'autoload
)
3593 (and (byte-compile-constp (nth 1 form
))
3594 (byte-compile-constp (nth 5 form
))
3595 (eval (nth 5 form
)) ; macro-p
3596 (not (fboundp (eval (nth 1 form
))))
3598 "The compiler ignores `autoload' except at top level. You should
3599 probably put the autoload of the macro `%s' at top-level."
3600 (eval (nth 1 form
))))
3601 (byte-compile-normal-call form
))
3603 ;; Lambdas in valid places are handled as special cases by various code.
3604 ;; The ones that remain are errors.
3605 (defun byte-compile-lambda-form (form)
3606 (byte-compile-set-symbol-position 'lambda
)
3607 (error "`lambda' used as function name is invalid"))
3609 ;; Compile normally, but deal with warnings for the function being defined.
3610 (defun byte-compile-defalias (form)
3611 (if (and (consp (cdr form
)) (consp (nth 1 form
))
3612 (eq (car (nth 1 form
)) 'quote
)
3613 (consp (cdr (nth 1 form
)))
3614 (symbolp (nth 1 (nth 1 form
)))
3615 (consp (nthcdr 2 form
))
3616 (consp (nth 2 form
))
3617 (eq (car (nth 2 form
)) 'quote
)
3618 (consp (cdr (nth 2 form
)))
3619 (symbolp (nth 1 (nth 2 form
))))
3621 (byte-compile-defalias-warn (nth 1 (nth 1 form
)))
3622 (setq byte-compile-function-environment
3623 (cons (cons (nth 1 (nth 1 form
))
3624 (nth 1 (nth 2 form
)))
3625 byte-compile-function-environment
))))
3626 (byte-compile-normal-call form
))
3628 ;; Turn off warnings about prior calls to the function being defalias'd.
3629 ;; This could be smarter and compare those calls with
3630 ;; the function it is being aliased to.
3631 (defun byte-compile-defalias-warn (new)
3632 (let ((calls (assq new byte-compile-unresolved-functions
)))
3634 (setq byte-compile-unresolved-functions
3635 (delq calls byte-compile-unresolved-functions
)))))
3639 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3640 ;; optimization to have the 'TAG as a part of the tag.
3641 ;; Tags will be (TAG . (tag-number . stack-depth)).
3642 (defun byte-compile-make-tag ()
3643 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
3646 (defun byte-compile-out-tag (tag)
3647 (setq byte-compile-output
(cons tag byte-compile-output
))
3650 ;; ## remove this someday
3651 (and byte-compile-depth
3652 (not (= (cdr (cdr tag
)) byte-compile-depth
))
3653 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
3654 (setq byte-compile-depth
(cdr (cdr tag
))))
3655 (setcdr (cdr tag
) byte-compile-depth
)))
3657 (defun byte-compile-goto (opcode tag
)
3658 (push (cons opcode tag
) byte-compile-output
)
3659 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
3660 (1- byte-compile-depth
)
3661 byte-compile-depth
))
3662 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
3663 (1- byte-compile-depth
))))
3665 (defun byte-compile-out (opcode offset
)
3666 (push (cons opcode offset
) byte-compile-output
)
3667 (cond ((eq opcode
'byte-call
)
3668 (setq byte-compile-depth
(- byte-compile-depth offset
)))
3669 ((eq opcode
'byte-return
)
3670 ;; This is actually an unnecessary case, because there should be
3671 ;; no more opcodes behind byte-return.
3672 (setq byte-compile-depth nil
))
3674 (setq byte-compile-depth
(+ byte-compile-depth
3675 (or (aref byte-stack
+-info
3676 (symbol-value opcode
))
3678 byte-compile-maxdepth
(max byte-compile-depth
3679 byte-compile-maxdepth
))))
3680 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3686 (defun byte-compile-annotate-call-tree (form)
3688 ;; annotate the current call
3689 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
3690 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
3692 (cons byte-compile-current-form
(nth 1 entry
))))
3693 (setq byte-compile-call-tree
3694 (cons (list (car form
) (list byte-compile-current-form
) nil
)
3695 byte-compile-call-tree
)))
3696 ;; annotate the current function
3697 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
3698 (or (memq (car form
) (nth 2 entry
)) ;called
3699 (setcar (cdr (cdr entry
))
3700 (cons (car form
) (nth 2 entry
))))
3701 (setq byte-compile-call-tree
3702 (cons (list byte-compile-current-form nil
(list (car form
)))
3703 byte-compile-call-tree
)))
3706 ;; Renamed from byte-compile-report-call-tree
3707 ;; to avoid interfering with completion of byte-compile-file.
3709 (defun display-call-tree (&optional filename
)
3710 "Display a call graph of a specified file.
3711 This lists which functions have been called, what functions called
3712 them, and what functions they call. The list includes all functions
3713 whose definitions have been compiled in this Emacs session, as well as
3714 all functions called by those functions.
3716 The call graph does not include macros, inline functions, or
3717 primitives that the byte-code interpreter knows about directly \(eq,
3720 The call tree also lists those functions which are not known to be called
3721 \(that is, to which no calls have been compiled\), and which cannot be
3722 invoked interactively."
3724 (message "Generating call tree...")
3725 (with-output-to-temp-buffer "*Call-Tree*"
3726 (set-buffer "*Call-Tree*")
3728 (message "Generating call tree... (sorting on %s)"
3729 byte-compile-call-tree-sort
)
3730 (insert "Call tree for "
3731 (cond ((null byte-compile-current-file
) (or filename
"???"))
3732 ((stringp byte-compile-current-file
)
3733 byte-compile-current-file
)
3734 (t (buffer-name byte-compile-current-file
)))
3736 (prin1-to-string byte-compile-call-tree-sort
)
3738 (if byte-compile-call-tree-sort
3739 (setq byte-compile-call-tree
3740 (sort byte-compile-call-tree
3741 (cond ((eq byte-compile-call-tree-sort
'callers
)
3742 (function (lambda (x y
) (< (length (nth 1 x
))
3743 (length (nth 1 y
))))))
3744 ((eq byte-compile-call-tree-sort
'calls
)
3745 (function (lambda (x y
) (< (length (nth 2 x
))
3746 (length (nth 2 y
))))))
3747 ((eq byte-compile-call-tree-sort
'calls
+callers
)
3748 (function (lambda (x y
) (< (+ (length (nth 1 x
))
3750 (+ (length (nth 1 y
))
3751 (length (nth 2 y
)))))))
3752 ((eq byte-compile-call-tree-sort
'name
)
3753 (function (lambda (x y
) (string< (car x
)
3755 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
3756 byte-compile-call-tree-sort
))))))
3757 (message "Generating call tree...")
3758 (let ((rest byte-compile-call-tree
)
3759 (b (current-buffer))
3763 (prin1 (car (car rest
)) b
)
3764 (setq callers
(nth 1 (car rest
))
3765 calls
(nth 2 (car rest
)))
3767 (cond ((not (fboundp (setq f
(car (car rest
)))))
3769 " <top level>";; shouldn't insert nil then, actually -sk
3771 ((subrp (setq f
(symbol-function f
)))
3774 (format " ==> %s" f
))
3775 ((byte-code-function-p f
)
3776 "<compiled function>")
3778 "<malformed function>")
3779 ((eq 'macro
(car f
))
3780 (if (or (byte-code-function-p (cdr f
))
3781 (assq 'byte-code
(cdr (cdr (cdr f
)))))
3784 ((assq 'byte-code
(cdr (cdr f
)))
3785 "<compiled lambda>")
3786 ((eq 'lambda
(car f
))
3789 (format " (%d callers + %d calls = %d)"
3790 ;; Does the optimizer eliminate common subexpressions?-sk
3793 (+ (length callers
) (length calls
)))
3797 (insert " called by:\n")
3799 (insert " " (if (car callers
)
3800 (mapconcat 'symbol-name callers
", ")
3802 (let ((fill-prefix " "))
3803 (fill-region-as-paragraph p
(point)))))
3806 (insert " calls:\n")
3808 (insert " " (mapconcat 'symbol-name calls
", "))
3809 (let ((fill-prefix " "))
3810 (fill-region-as-paragraph p
(point)))))
3812 (setq rest
(cdr rest
)))
3814 (message "Generating call tree...(finding uncalled functions...)")
3815 (setq rest byte-compile-call-tree
)
3816 (let ((uncalled nil
))
3818 (or (nth 1 (car rest
))
3819 (null (setq f
(car (car rest
))))
3820 (byte-compile-fdefinition f t
)
3821 (commandp (byte-compile-fdefinition f nil
))
3822 (setq uncalled
(cons f uncalled
)))
3823 (setq rest
(cdr rest
)))
3825 (let ((fill-prefix " "))
3826 (insert "Noninteractive functions not known to be called:\n ")
3828 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
3829 (fill-region-as-paragraph p
(point)))))
3831 (message "Generating call tree...done.")
3836 (defun batch-byte-compile-if-not-done ()
3837 "Like `byte-compile-file' but doesn't recompile if already up to date.
3838 Use this from the command line, with `-batch';
3839 it won't work in an interactive Emacs."
3840 (batch-byte-compile t
))
3842 ;;; by crl@newton.purdue.edu
3843 ;;; Only works noninteractively.
3845 (defun batch-byte-compile (&optional noforce
)
3846 "Run `byte-compile-file' on the files remaining on the command line.
3847 Use this from the command line, with `-batch';
3848 it won't work in an interactive Emacs.
3849 Each file is processed even if an error occurred previously.
3850 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
3851 If NOFORCE is non-nil, don't recompile a file that seems to be
3852 already up-to-date."
3853 ;; command-line-args-left is what is left of the command line (from startup.el)
3854 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3855 (if (not noninteractive
)
3856 (error "`batch-byte-compile' is to be used only with -batch"))
3858 (while command-line-args-left
3859 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
3860 ;; Directory as argument.
3861 (let ((files (directory-files (car command-line-args-left
)))
3863 (dolist (file files
)
3864 (if (and (string-match emacs-lisp-file-regexp file
)
3865 (not (auto-save-file-name-p file
))
3866 (setq source
(expand-file-name file
3867 (car command-line-args-left
)))
3868 (setq dest
(byte-compile-dest-file source
))
3869 (file-exists-p dest
)
3870 (file-newer-than-file-p source dest
))
3871 (if (null (batch-byte-compile-file source
))
3873 ;; Specific file argument
3874 (if (or (not noforce
)
3875 (let* ((source (car command-line-args-left
))
3876 (dest (byte-compile-dest-file source
)))
3877 (or (not (file-exists-p dest
))
3878 (file-newer-than-file-p source dest
))))
3879 (if (null (batch-byte-compile-file (car command-line-args-left
)))
3881 (setq command-line-args-left
(cdr command-line-args-left
)))
3882 (kill-emacs (if error
1 0))))
3884 (defun batch-byte-compile-file (file)
3886 (byte-compile-file file
)
3888 (message (if (cdr err
)
3889 ">>Error occurred processing %s: %s (%s)"
3890 ">>Error occurred processing %s: %s")
3892 (get (car err
) 'error-message
)
3893 (prin1-to-string (cdr err
)))
3894 (let ((destfile (byte-compile-dest-file file
)))
3895 (if (file-exists-p destfile
)
3896 (delete-file destfile
)))
3899 (message (if (cdr err
)
3900 ">>Error occurred processing %s: %s (%s)"
3901 ">>Error occurred processing %s: %s")
3903 (get (car err
) 'error-message
)
3904 (prin1-to-string (cdr err
)))
3908 (defun batch-byte-recompile-directory ()
3909 "Run `byte-recompile-directory' on the dirs remaining on the command line.
3910 Must be used only with `-batch', and kills Emacs on completion.
3911 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'."
3912 ;; command-line-args-left is what is left of the command line (startup.el)
3913 (defvar command-line-args-left
) ;Avoid 'free variable' warning
3914 (if (not noninteractive
)
3915 (error "batch-byte-recompile-directory is to be used only with -batch"))
3916 (or command-line-args-left
3917 (setq command-line-args-left
'(".")))
3918 (while command-line-args-left
3919 (byte-recompile-directory (car command-line-args-left
))
3920 (setq command-line-args-left
(cdr command-line-args-left
)))
3924 (make-obsolete-variable 'auto-fill-hook
'auto-fill-function
"before 19.15")
3925 (make-obsolete-variable 'blink-paren-hook
'blink-paren-function
"before 19.15")
3926 (make-obsolete-variable 'lisp-indent-hook
'lisp-indent-function
"before 19.15")
3927 (make-obsolete-variable 'inhibit-local-variables
3928 "use enable-local-variables (with the reversed sense)."
3930 (make-obsolete-variable 'unread-command-event
3931 "use unread-command-events; which is a list of events rather than a single event."
3933 (make-obsolete-variable 'suspend-hooks
'suspend-hook
"before 19.15")
3934 (make-obsolete-variable 'comment-indent-hook
'comment-indent-function
"before 19.15")
3935 (make-obsolete-variable 'meta-flag
"use the set-input-mode function instead." "before 19.34")
3936 (make-obsolete-variable 'before-change-function
3937 "use before-change-functions; which is a list of functions rather than a single function."
3939 (make-obsolete-variable 'after-change-function
3940 "use after-change-functions; which is a list of functions rather than a single function."
3942 (make-obsolete-variable 'font-lock-doc-string-face
'font-lock-string-face
"before 19.34")
3944 (provide 'byte-compile
)
3948 ;;; report metering (see the hacks in bytecode.c)
3950 (defun byte-compile-report-ops ()
3951 (defvar byte-code-meter
)
3952 (with-output-to-temp-buffer "*Meter*"
3953 (set-buffer "*Meter*")
3954 (let ((i 0) n op off
)
3956 (setq n
(aref (aref byte-code-meter
0) i
)
3958 (if t
;(not (zerop n))
3962 (cond ((< op byte-nth
)
3963 (setq off
(logand op
7))
3964 (setq op
(logand op
248)))
3965 ((>= op byte-constant
)
3966 (setq off
(- op byte-constant
)
3968 (setq op
(aref byte-code-vector op
))
3969 (insert (format "%-4d" i
))
3970 (insert (symbol-name op
))
3971 (if off
(insert " [" (int-to-string off
) "]"))
3973 (insert (int-to-string n
) "\n")))
3976 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
3977 ;; itself, compile some of its most used recursive functions (at load time).
3980 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
3981 (assq 'byte-code
(symbol-function 'byte-compile-form
))
3982 (let ((byte-optimize nil
) ; do it fast
3983 (byte-compile-warnings nil
))
3985 (or noninteractive
(message "compiling %s..." x
))
3987 (or noninteractive
(message "compiling %s...done" x
)))
3988 '(byte-compile-normal-call
3991 ;; Inserted some more than necessary, to speed it up.
3992 byte-compile-top-level
3993 byte-compile-out-toplevel
3994 byte-compile-constant
3995 byte-compile-variable-ref
))))
3998 (run-hooks 'bytecomp-load-hook
)
4000 ;;; bytecomp.el ends here