1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
29 ;; of p-code (`lapcode') which takes up less space and can be interpreted
30 ;; faster. [`LAP' == `Lisp Assembly Program'.]
31 ;; The user entry points are byte-compile-file and byte-recompile-directory.
35 ;; ========================================================================
37 ;; byte-recompile-directory, byte-compile-file,
38 ;; batch-byte-compile, batch-byte-recompile-directory,
39 ;; byte-compile, compile-defun,
41 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
42 ;; because they are not terribly useful and get in the way of completion.)
44 ;; This version of the byte compiler has the following improvements:
45 ;; + optimization of compiled code:
46 ;; - removal of unreachable code;
47 ;; - removal of calls to side-effectless functions whose return-value
49 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
51 ;; - open-coding of literal lambdas;
52 ;; - peephole optimization of emitted code;
53 ;; - trivial functions are left uncompiled for speed.
54 ;; + support for inline functions;
55 ;; + compile-time evaluation of arbitrary expressions;
56 ;; + compile-time warning messages for:
57 ;; - functions being redefined with incompatible arglists;
58 ;; - functions being redefined as macros, or vice-versa;
59 ;; - functions or macros defined multiple times in the same file;
60 ;; - functions being called with the incorrect number of arguments;
61 ;; - functions being called which are not defined globally, in the
62 ;; file, or as autoloads;
63 ;; - assignment and reference of undeclared free variables;
64 ;; - various syntax errors;
65 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
66 ;; + correct compilation of top-level uses of macros;
67 ;; + the ability to generate a histogram of functions called.
69 ;; User customization variables: M-x customize-group bytecomp
73 ;; o The form `defsubst' is just like `defun', except that the function
74 ;; generated will be open-coded in compiled code which uses it. This
75 ;; means that no function call will be generated, it will simply be
76 ;; spliced in. Lisp functions calls are very slow, so this can be a
79 ;; You can generally accomplish the same thing with `defmacro', but in
80 ;; that case, the defined procedure can't be used as an argument to
83 ;; o You can also open-code one particular call to a function without
84 ;; open-coding all calls. Use the 'inline' form to do this, like so:
86 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
88 ;; (inline ;; `foo' and `baz' will be
89 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
92 ;; o It is possible to open-code a function in the same file it is defined
93 ;; in without having to load that file before compiling it. The
94 ;; byte-compiler has been modified to remember function definitions in
95 ;; the compilation environment in the same way that it remembers macro
98 ;; o Forms like ((lambda ...) ...) are open-coded.
100 ;; o The form `eval-when-compile' is like progn, except that the body
101 ;; is evaluated at compile-time. When it appears at top-level, this
102 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
103 ;; When it does not appear at top-level, it is similar to the
104 ;; Common Lisp #. reader macro (but not in interpreted code).
106 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
107 ;; the whole form is evalled both at compile-time and at run-time.
109 ;; o The command compile-defun is analogous to eval-defun.
111 ;; o If you run byte-compile-file on a filename which is visited in a
112 ;; buffer, and that buffer is modified, you are asked whether you want
113 ;; to save the buffer before compiling.
115 ;; o byte-compiled files now start with the string `;ELC'.
116 ;; Some versions of `file' can be customized to recognize that.
119 (eval-when-compile (require 'cl
))
121 (or (fboundp 'defsubst
)
122 ;; This really ought to be loaded already!
125 (defgroup bytecomp nil
126 "Emacs Lisp byte-compiler."
129 (defcustom emacs-lisp-file-regexp
"\\.el\\'"
130 "Regexp which matches Emacs Lisp source files.
131 If you change this, you might want to set `byte-compile-dest-file-function'."
135 (defcustom byte-compile-dest-file-function nil
136 "Function for the function `byte-compile-dest-file' to call.
137 It should take one argument, the name of an Emacs Lisp source
138 file name, and return the name of the compiled file."
140 :type
'(choice (const nil
) function
)
143 ;; This enables file name handlers such as jka-compr
144 ;; to remove parts of the file name that should not be copied
145 ;; through to the output file name.
146 (defun byte-compiler-base-file-name (filename)
147 (let ((handler (find-file-name-handler filename
148 'byte-compiler-base-file-name
)))
150 (funcall handler
'byte-compiler-base-file-name filename
)
153 (or (fboundp 'byte-compile-dest-file
)
154 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
155 ;; so only define it if it is undefined.
156 ;; Note - redefining this function is obsolete as of 23.2.
157 ;; Customize byte-compile-dest-file-function instead.
158 (defun byte-compile-dest-file (filename)
159 "Convert an Emacs Lisp source file name to a compiled file name.
160 If `byte-compile-dest-file-function' is non-nil, uses that
161 function to do the work. Otherwise, if FILENAME matches
162 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
163 adds `c' to it; otherwise adds `.elc'."
164 (if byte-compile-dest-file-function
165 (funcall byte-compile-dest-file-function filename
)
166 (setq filename
(file-name-sans-versions
167 (byte-compiler-base-file-name filename
)))
168 (cond ((string-match emacs-lisp-file-regexp filename
)
169 (concat (substring filename
0 (match-beginning 0)) ".elc"))
170 (t (concat filename
".elc"))))))
172 ;; This can be the 'byte-compile property of any symbol.
173 (autoload 'byte-compile-inline-expand
"byte-opt")
175 ;; This is the entrypoint to the lapcode optimizer pass1.
176 (autoload 'byte-optimize-form
"byte-opt")
177 ;; This is the entrypoint to the lapcode optimizer pass2.
178 (autoload 'byte-optimize-lapcode
"byte-opt")
179 (autoload 'byte-compile-unfold-lambda
"byte-opt")
181 ;; This is the entry point to the decompiler, which is used by the
182 ;; disassembler. The disassembler just requires 'byte-compile, but
183 ;; that doesn't define this function, so this seems to be a reasonable
185 (autoload 'byte-decompile-bytecode
"byte-opt")
187 (defcustom byte-compile-verbose
188 (and (not noninteractive
) (> baud-rate search-slow-speed
))
189 "Non-nil means print messages describing progress of byte-compiler."
193 (defcustom byte-optimize t
194 "Enable optimization in the byte compiler.
196 nil - no optimization
197 t - all optimizations
198 `source' - source-level optimizations only
199 `byte' - code-level optimizations only"
201 :type
'(choice (const :tag
"none" nil
)
203 (const :tag
"source-level" source
)
204 (const :tag
"byte-level" byte
)))
206 (defcustom byte-compile-delete-errors nil
207 "If non-nil, the optimizer may delete forms that may signal an error.
208 This includes variable references and calls to functions such as `car'."
212 (defvar byte-compile-dynamic nil
213 "If non-nil, compile function bodies so they load lazily.
214 They are hidden in comments in the compiled file,
215 and each one is brought into core when the
218 To enable this option, make it a file-local variable
219 in the source file you want it to apply to.
220 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
222 When this option is true, if you load the compiled file and then move it,
223 the functions you loaded will not be able to run.")
224 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
226 (defvar byte-compile-disable-print-circle nil
227 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
228 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
230 (defcustom byte-compile-dynamic-docstrings t
231 "If non-nil, compile doc strings for lazy access.
232 We bury the doc strings of functions and variables inside comments in
233 the file, and bring them into core only when they are actually needed.
235 When this option is true, if you load the compiled file and then move it,
236 you won't be able to find the documentation of anything in that file.
238 To disable this option for a certain file, make it a file-local variable
239 in the source file. For example, add this to the first line:
240 -*-byte-compile-dynamic-docstrings:nil;-*-
241 You can also set the variable globally.
243 This option is enabled by default because it reduces Emacs memory usage."
246 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
248 (defcustom byte-optimize-log nil
249 "If true, the byte-compiler will log its optimizations into *Compile-Log*.
250 If this is 'source, then only source-level optimizations will be logged.
251 If it is 'byte, then only byte-level optimizations will be logged."
253 :type
'(choice (const :tag
"none" nil
)
255 (const :tag
"source-level" source
)
256 (const :tag
"byte-level" byte
)))
258 (defcustom byte-compile-error-on-warn nil
259 "If true, the byte-compiler reports warnings with `error'."
263 (defconst byte-compile-warning-types
264 '(redefine callargs free-vars unresolved
265 obsolete noruntime cl-functions interactive-only
266 make-local mapcar constants suspicious
)
267 "The list of warning types used when `byte-compile-warnings' is t.")
268 (defcustom byte-compile-warnings t
269 "List of warnings that the byte-compiler should issue (t for all).
271 Elements of the list may be:
273 free-vars references to variables not in the current lexical scope.
274 unresolved calls to unknown functions.
275 callargs function calls with args that don't match the definition.
276 redefine function name redefined from a macro to ordinary function or vice
277 versa, or redefined to take a different number of arguments.
278 obsolete obsolete variables and functions.
279 noruntime functions that may not be defined at runtime (typically
280 defined only under `eval-when-compile').
281 cl-functions calls to runtime functions from the CL package (as
282 distinguished from macros and aliases).
284 commands that normally shouldn't be called from Lisp code.
285 make-local calls to make-variable-buffer-local that may be incorrect.
286 mapcar mapcar called for effect.
287 constants let-binding of, or assignment to, constants/nonvariables.
288 suspicious constructs that usually don't do what the coder wanted.
290 If the list begins with `not', then the remaining elements specify warnings to
291 suppress. For example, (not mapcar) will suppress warnings about mapcar."
293 :type
`(choice (const :tag
"All" t
)
294 (set :menu-tag
"Some"
295 ,@(mapcar (lambda (x) `(const ,x
))
296 byte-compile-warning-types
))))
299 (put 'byte-compile-warnings
'safe-local-variable
302 (null (delq nil
(mapcar (lambda (x) (not (symbolp x
))) v
))))))
304 (defun byte-compile-warning-enabled-p (warning)
305 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
306 (or (eq byte-compile-warnings t
)
307 (if (eq (car byte-compile-warnings
) 'not
)
308 (not (memq warning byte-compile-warnings
))
309 (memq warning byte-compile-warnings
))))
312 (defun byte-compile-disable-warning (warning)
313 "Change `byte-compile-warnings' to disable WARNING.
314 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
315 Otherwise, if the first element is `not', add WARNING, else remove it.
316 Normally you should let-bind `byte-compile-warnings' before calling this,
317 else the global value will be modified."
318 (setq byte-compile-warnings
319 (cond ((eq byte-compile-warnings t
)
321 ((eq (car byte-compile-warnings
) 'not
)
322 (if (memq warning byte-compile-warnings
)
323 byte-compile-warnings
324 (append byte-compile-warnings
(list warning
))))
326 (delq warning byte-compile-warnings
)))))
329 (defun byte-compile-enable-warning (warning)
330 "Change `byte-compile-warnings' to enable WARNING.
331 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
332 first element is `not', remove WARNING, else add it.
333 Normally you should let-bind `byte-compile-warnings' before calling this,
334 else the global value will be modified."
335 (or (eq byte-compile-warnings t
)
336 (setq byte-compile-warnings
337 (cond ((eq (car byte-compile-warnings
) 'not
)
338 (delq warning byte-compile-warnings
))
339 ((memq warning byte-compile-warnings
)
340 byte-compile-warnings
)
342 (append byte-compile-warnings
(list warning
)))))))
344 (defvar byte-compile-interactive-only-functions
345 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
346 insert-file insert-buffer insert-file-literally previous-line next-line
347 goto-line comint-run delete-backward-char
)
348 "List of commands that are not meant to be called from Lisp.")
350 (defvar byte-compile-not-obsolete-vars nil
351 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
353 (defvar byte-compile-not-obsolete-funcs nil
354 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
356 (defcustom byte-compile-generate-call-tree nil
357 "Non-nil means collect call-graph information when compiling.
358 This records which functions were called and from where.
359 If the value is t, compilation displays the call graph when it finishes.
360 If the value is neither t nor nil, compilation asks you whether to display
363 The call tree only lists functions called, not macros used. Those functions
364 which the byte-code interpreter knows about directly (eq, cons, etc.) are
367 The call tree also lists those functions which are not known to be called
368 \(that is, to which no calls have been compiled). Functions which can be
369 invoked interactively are excluded from this list."
371 :type
'(choice (const :tag
"Yes" t
) (const :tag
"No" nil
)
372 (other :tag
"Ask" lambda
)))
374 (defvar byte-compile-call-tree nil
375 "Alist of functions and their call tree.
376 Each element looks like
378 \(FUNCTION CALLERS CALLS\)
380 where CALLERS is a list of functions that call FUNCTION, and CALLS
381 is a list of functions for which calls were generated while compiling
384 (defcustom byte-compile-call-tree-sort
'name
385 "If non-nil, sort the call tree.
386 The values `name', `callers', `calls', `calls+callers'
387 specify different fields to sort on."
389 :type
'(choice (const name
) (const callers
) (const calls
)
390 (const calls
+callers
) (const nil
)))
392 (defvar byte-compile-debug nil
)
393 (defvar byte-compile-constants nil
394 "List of all constants encountered during compilation of this form.")
395 (defvar byte-compile-variables nil
396 "List of all variables encountered during compilation of this form.")
397 (defvar byte-compile-bound-variables nil
398 "List of variables bound in the context of the current form.
399 This list lives partly on the stack.")
400 (defvar byte-compile-const-variables nil
401 "List of variables declared as constants during compilation of this file.")
402 (defvar byte-compile-free-references
)
403 (defvar byte-compile-free-assignments
)
405 (defvar byte-compiler-error-flag
)
407 (defconst byte-compile-initial-macro-environment
409 ;; (byte-compiler-options . (lambda (&rest forms)
410 ;; (apply 'byte-compiler-options-handler forms)))
411 (eval-when-compile .
(lambda (&rest body
)
413 (byte-compile-eval (byte-compile-top-level
414 (cons 'progn body
))))))
415 (eval-and-compile .
(lambda (&rest body
)
416 (byte-compile-eval-before-compile (cons 'progn body
))
417 (cons 'progn body
))))
418 "The default macro-environment passed to macroexpand by the compiler.
419 Placing a macro here will cause a macro to have different semantics when
420 expanded by the compiler as when expanded by the interpreter.")
422 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
423 "Alist of macros defined in the file being compiled.
424 Each element looks like (MACRONAME . DEFINITION). It is
425 \(MACRONAME . nil) when a macro is redefined as a function.")
427 (defvar byte-compile-function-environment nil
428 "Alist of functions defined in the file being compiled.
429 This is so we can inline them when necessary.
430 Each element looks like (FUNCTIONNAME . DEFINITION). It is
431 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
432 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
433 and we don't know the definition. For an autoloaded function, DEFINITION
434 has the form (autoload . FILENAME).")
436 (defvar byte-compile-unresolved-functions nil
437 "Alist of undefined functions to which calls have been compiled.
438 This variable is only significant whilst compiling an entire buffer.
439 Used for warnings when a function is not known to be defined or is later
440 defined with incorrect args.")
442 (defvar byte-compile-noruntime-functions nil
443 "Alist of functions called that may not be defined when the compiled code is run.
444 Used for warnings about calling a function that is defined during compilation
445 but won't necessarily be defined when the compiled file is loaded.")
447 (defvar byte-compile-tag-number
0)
448 (defvar byte-compile-output nil
449 "Alist describing contents to put in byte code string.
450 Each element is (INDEX . VALUE)")
451 (defvar byte-compile-depth
0 "Current depth of execution stack.")
452 (defvar byte-compile-maxdepth
0 "Maximum depth of execution stack.")
455 ;;; The byte codes; this information is duplicated in bytecomp.c
457 (defvar byte-code-vector nil
458 "An array containing byte-code names indexed by byte-code values.")
460 (defvar byte-stack
+-info nil
461 "An array with the stack adjustment for each byte-code.")
463 (defmacro byte-defop
(opcode stack-adjust opname
&optional docstring
)
464 ;; This is a speed-hack for building the byte-code-vector at compile-time.
465 ;; We fill in the vector at macroexpand-time, and then after the last call
466 ;; to byte-defop, we write the vector out as a constant instead of writing
467 ;; out a bunch of calls to aset.
468 ;; Actually, we don't fill in the vector itself, because that could make
469 ;; it problematic to compile big changes to this compiler; we store the
470 ;; values on its plist, and remove them later in -extrude.
471 (let ((v1 (or (get 'byte-code-vector
'tmp-compile-time-value
)
472 (put 'byte-code-vector
'tmp-compile-time-value
473 (make-vector 256 nil
))))
474 (v2 (or (get 'byte-stack
+-info
'tmp-compile-time-value
)
475 (put 'byte-stack
+-info
'tmp-compile-time-value
476 (make-vector 256 nil
)))))
477 (aset v1 opcode opname
)
478 (aset v2 opcode stack-adjust
))
480 (list 'defconst opname opcode
(concat "Byte code opcode " docstring
"."))
481 (list 'defconst opname opcode
)))
483 (defmacro byte-extrude-byte-code-vectors
()
484 (prog1 (list 'setq
'byte-code-vector
485 (get 'byte-code-vector
'tmp-compile-time-value
)
487 (get 'byte-stack
+-info
'tmp-compile-time-value
))
488 (put 'byte-code-vector
'tmp-compile-time-value nil
)
489 (put 'byte-stack
+-info
'tmp-compile-time-value nil
)))
494 ;; These opcodes are special in that they pack their argument into the
497 (byte-defop 8 1 byte-varref
"for variable reference")
498 (byte-defop 16 -
1 byte-varset
"for setting a variable")
499 (byte-defop 24 -
1 byte-varbind
"for binding a variable")
500 (byte-defop 32 0 byte-call
"for calling a function")
501 (byte-defop 40 0 byte-unbind
"for unbinding special bindings")
502 ;; codes 8-47 are consumed by the preceding opcodes
506 (byte-defop 56 -
1 byte-nth
)
507 (byte-defop 57 0 byte-symbolp
)
508 (byte-defop 58 0 byte-consp
)
509 (byte-defop 59 0 byte-stringp
)
510 (byte-defop 60 0 byte-listp
)
511 (byte-defop 61 -
1 byte-eq
)
512 (byte-defop 62 -
1 byte-memq
)
513 (byte-defop 63 0 byte-not
)
514 (byte-defop 64 0 byte-car
)
515 (byte-defop 65 0 byte-cdr
)
516 (byte-defop 66 -
1 byte-cons
)
517 (byte-defop 67 0 byte-list1
)
518 (byte-defop 68 -
1 byte-list2
)
519 (byte-defop 69 -
2 byte-list3
)
520 (byte-defop 70 -
3 byte-list4
)
521 (byte-defop 71 0 byte-length
)
522 (byte-defop 72 -
1 byte-aref
)
523 (byte-defop 73 -
2 byte-aset
)
524 (byte-defop 74 0 byte-symbol-value
)
525 (byte-defop 75 0 byte-symbol-function
) ; this was commented out
526 (byte-defop 76 -
1 byte-set
)
527 (byte-defop 77 -
1 byte-fset
) ; this was commented out
528 (byte-defop 78 -
1 byte-get
)
529 (byte-defop 79 -
2 byte-substring
)
530 (byte-defop 80 -
1 byte-concat2
)
531 (byte-defop 81 -
2 byte-concat3
)
532 (byte-defop 82 -
3 byte-concat4
)
533 (byte-defop 83 0 byte-sub1
)
534 (byte-defop 84 0 byte-add1
)
535 (byte-defop 85 -
1 byte-eqlsign
)
536 (byte-defop 86 -
1 byte-gtr
)
537 (byte-defop 87 -
1 byte-lss
)
538 (byte-defop 88 -
1 byte-leq
)
539 (byte-defop 89 -
1 byte-geq
)
540 (byte-defop 90 -
1 byte-diff
)
541 (byte-defop 91 0 byte-negate
)
542 (byte-defop 92 -
1 byte-plus
)
543 (byte-defop 93 -
1 byte-max
)
544 (byte-defop 94 -
1 byte-min
)
545 (byte-defop 95 -
1 byte-mult
) ; v19 only
546 (byte-defop 96 1 byte-point
)
547 (byte-defop 98 0 byte-goto-char
)
548 (byte-defop 99 0 byte-insert
)
549 (byte-defop 100 1 byte-point-max
)
550 (byte-defop 101 1 byte-point-min
)
551 (byte-defop 102 0 byte-char-after
)
552 (byte-defop 103 1 byte-following-char
)
553 (byte-defop 104 1 byte-preceding-char
)
554 (byte-defop 105 1 byte-current-column
)
555 (byte-defop 106 0 byte-indent-to
)
556 (byte-defop 107 0 byte-scan-buffer-OBSOLETE
) ; no longer generated as of v18
557 (byte-defop 108 1 byte-eolp
)
558 (byte-defop 109 1 byte-eobp
)
559 (byte-defop 110 1 byte-bolp
)
560 (byte-defop 111 1 byte-bobp
)
561 (byte-defop 112 1 byte-current-buffer
)
562 (byte-defop 113 0 byte-set-buffer
)
563 (byte-defop 114 0 byte-save-current-buffer
564 "To make a binding to record the current buffer")
565 (byte-defop 115 0 byte-set-mark-OBSOLETE
)
566 (byte-defop 116 1 byte-interactive-p
)
568 ;; These ops are new to v19
569 (byte-defop 117 0 byte-forward-char
)
570 (byte-defop 118 0 byte-forward-word
)
571 (byte-defop 119 -
1 byte-skip-chars-forward
)
572 (byte-defop 120 -
1 byte-skip-chars-backward
)
573 (byte-defop 121 0 byte-forward-line
)
574 (byte-defop 122 0 byte-char-syntax
)
575 (byte-defop 123 -
1 byte-buffer-substring
)
576 (byte-defop 124 -
1 byte-delete-region
)
577 (byte-defop 125 -
1 byte-narrow-to-region
)
578 (byte-defop 126 1 byte-widen
)
579 (byte-defop 127 0 byte-end-of-line
)
583 ;; These store their argument in the next two bytes
584 (byte-defop 129 1 byte-constant2
585 "for reference to a constant with vector index >= byte-constant-limit")
586 (byte-defop 130 0 byte-goto
"for unconditional jump")
587 (byte-defop 131 -
1 byte-goto-if-nil
"to pop value and jump if it's nil")
588 (byte-defop 132 -
1 byte-goto-if-not-nil
"to pop value and jump if it's not nil")
589 (byte-defop 133 -
1 byte-goto-if-nil-else-pop
590 "to examine top-of-stack, jump and don't pop it if it's nil,
592 (byte-defop 134 -
1 byte-goto-if-not-nil-else-pop
593 "to examine top-of-stack, jump and don't pop it if it's non nil,
596 (byte-defop 135 -
1 byte-return
"to pop a value and return it from `byte-code'")
597 (byte-defop 136 -
1 byte-discard
"to discard one value from stack")
598 (byte-defop 137 1 byte-dup
"to duplicate the top of the stack")
600 (byte-defop 138 0 byte-save-excursion
601 "to make a binding to record the buffer, point and mark")
602 (byte-defop 139 0 byte-save-window-excursion
603 "to make a binding to record entire window configuration")
604 (byte-defop 140 0 byte-save-restriction
605 "to make a binding to record the current buffer clipping restrictions")
606 (byte-defop 141 -
1 byte-catch
607 "for catch. Takes, on stack, the tag and an expression for the body")
608 (byte-defop 142 -
1 byte-unwind-protect
609 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
611 ;; For condition-case. Takes, on stack, the variable to bind,
612 ;; an expression for the body, and a list of clauses.
613 (byte-defop 143 -
2 byte-condition-case
)
615 ;; For entry to with-output-to-temp-buffer.
616 ;; Takes, on stack, the buffer name.
617 ;; Binds standard-output and does some other things.
618 ;; Returns with temp buffer on the stack in place of buffer name.
619 (byte-defop 144 0 byte-temp-output-buffer-setup
)
621 ;; For exit from with-output-to-temp-buffer.
622 ;; Expects the temp buffer on the stack underneath value to return.
623 ;; Pops them both, then pushes the value back on.
624 ;; Unbinds standard-output and makes the temp buffer visible.
625 (byte-defop 145 -
1 byte-temp-output-buffer-show
)
627 ;; these ops are new to v19
629 ;; To unbind back to the beginning of this frame.
630 ;; Not used yet, but will be needed for tail-recursion elimination.
631 (byte-defop 146 0 byte-unbind-all
)
633 ;; these ops are new to v19
634 (byte-defop 147 -
2 byte-set-marker
)
635 (byte-defop 148 0 byte-match-beginning
)
636 (byte-defop 149 0 byte-match-end
)
637 (byte-defop 150 0 byte-upcase
)
638 (byte-defop 151 0 byte-downcase
)
639 (byte-defop 152 -
1 byte-string
=)
640 (byte-defop 153 -
1 byte-string
<)
641 (byte-defop 154 -
1 byte-equal
)
642 (byte-defop 155 -
1 byte-nthcdr
)
643 (byte-defop 156 -
1 byte-elt
)
644 (byte-defop 157 -
1 byte-member
)
645 (byte-defop 158 -
1 byte-assq
)
646 (byte-defop 159 0 byte-nreverse
)
647 (byte-defop 160 -
1 byte-setcar
)
648 (byte-defop 161 -
1 byte-setcdr
)
649 (byte-defop 162 0 byte-car-safe
)
650 (byte-defop 163 0 byte-cdr-safe
)
651 (byte-defop 164 -
1 byte-nconc
)
652 (byte-defop 165 -
1 byte-quo
)
653 (byte-defop 166 -
1 byte-rem
)
654 (byte-defop 167 0 byte-numberp
)
655 (byte-defop 168 0 byte-integerp
)
658 (byte-defop 175 nil byte-listN
)
659 (byte-defop 176 nil byte-concatN
)
660 (byte-defop 177 nil byte-insertN
)
664 (byte-defop 192 1 byte-constant
"for reference to a constant")
665 ;; codes 193-255 are consumed by byte-constant.
666 (defconst byte-constant-limit
64
667 "Exclusive maximum index usable in the `byte-constant' opcode.")
669 (defconst byte-goto-ops
'(byte-goto byte-goto-if-nil byte-goto-if-not-nil
670 byte-goto-if-nil-else-pop
671 byte-goto-if-not-nil-else-pop
)
672 "List of byte-codes whose offset is a pc.")
674 (defconst byte-goto-always-pop-ops
'(byte-goto-if-nil byte-goto-if-not-nil
))
676 (byte-extrude-byte-code-vectors)
678 ;;; lapcode generator
680 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
681 ;; source -> bytecode, because it's a lot easier to make optimizations
682 ;; on lapcode than on bytecode.
684 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
685 ;; where instruction is a symbol naming a byte-code instruction,
686 ;; and parameter is an argument to that instruction, if any.
688 ;; The instruction can be the pseudo-op TAG, which means that this position
689 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
690 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
691 ;; parameter for some goto op.
693 ;; If the operation is varbind, varref, varset or push-constant, then the
694 ;; parameter is (variable/constant . index_in_constant_vector).
696 ;; First, the source code is macroexpanded and optimized in various ways.
697 ;; Then the resultant code is compiled into lapcode. Another set of
698 ;; optimizations are then run over the lapcode. Then the variables and
699 ;; constants referenced by the lapcode are collected and placed in the
700 ;; constants-vector. (This happens now so that variables referenced by dead
701 ;; code don't consume space.) And finally, the lapcode is transformed into
702 ;; compacted byte-code.
704 ;; A distinction is made between variables and constants because the variable-
705 ;; referencing instructions are more sensitive to the variables being near the
706 ;; front of the constants-vector than the constant-referencing instructions.
707 ;; Also, this lets us notice references to free variables.
709 (defun byte-compile-lapcode (lap)
710 "Turns lapcode into bytecode. The lapcode is destroyed."
711 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
712 (let ((pc 0) ; Program counter
713 op off
; Operation & offset
714 (bytes '()) ; Put the output bytes here
715 (patchlist nil
)) ; List of tags and goto's to patch
717 (setq op
(car (car lap
))
719 (cond ((not (symbolp op
))
720 (error "Non-symbolic opcode `%s'" op
))
723 (setq patchlist
(cons off patchlist
)))
724 ((memq op byte-goto-ops
)
726 (setq bytes
(cons (cons pc
(cdr off
))
728 (cons (symbol-value op
) bytes
))))
729 (setq patchlist
(cons bytes patchlist
)))
732 (cond ((cond ((consp off
)
733 ;; Variable or constant reference
735 (eq op
'byte-constant
)))
736 (cond ((< off byte-constant-limit
)
738 (cons (+ byte-constant off
) bytes
))
742 (cons (logand off
255)
743 (cons byte-constant2 bytes
))))))
744 ((<= byte-listN
(symbol-value op
))
746 (cons off
(cons (symbol-value op
) bytes
)))
749 (cons (+ (symbol-value op
) off
) bytes
))
752 (cons off
(cons (+ (symbol-value op
) 6) bytes
)))
756 (cons (logand off
255)
757 (cons (+ (symbol-value op
) 7)
759 (setq lap
(cdr lap
)))
760 ;;(if (not (= pc (length bytes)))
761 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
762 ;; Patch PC into jumps
765 (setq bytes
(car patchlist
))
766 (cond ((atom (car bytes
))) ; Tag
768 (setq pc
(car (cdr (car bytes
)))) ; Pick PC from tag
769 (setcar (cdr bytes
) (logand pc
255))
770 (setcar bytes
(lsh pc -
8))
771 ;; FIXME: Replace this by some workaround.
772 (if (> (car bytes
) 255) (error "Bytecode overflow"))))
773 (setq patchlist
(cdr patchlist
))))
774 (apply 'unibyte-string
(nreverse bytes
))))
777 ;;; compile-time evaluation
779 (defun byte-compile-cl-file-p (file)
780 "Return non-nil if FILE is one of the CL files."
782 (string-match "^cl\\>" (file-name-nondirectory file
))))
784 (defun byte-compile-eval (form)
785 "Eval FORM and mark the functions defined therein.
786 Each function's symbol gets added to `byte-compile-noruntime-functions'."
787 (let ((hist-orig load-history
)
788 (hist-nil-orig current-load-list
))
790 (when (byte-compile-warning-enabled-p 'noruntime
)
791 (let ((hist-new load-history
)
792 (hist-nil-new current-load-list
))
793 ;; Go through load-history, look for newly loaded files
794 ;; and mark all the functions defined therein.
795 (while (and hist-new
(not (eq hist-new hist-orig
)))
796 (let ((xs (pop hist-new
))
798 ;; Make sure the file was not already loaded before.
799 (unless (or (assoc (car xs
) hist-orig
)
800 ;; Don't give both the "noruntime" and
801 ;; "cl-functions" warning for the same function.
802 ;; FIXME This seems incorrect - these are two
803 ;; independent warnings. For example, you may be
804 ;; choosing to see the cl warnings but ignore them.
805 ;; You probably don't want to ignore noruntime in the
807 (and (byte-compile-warning-enabled-p 'cl-functions
)
808 (byte-compile-cl-file-p (car xs
))))
812 (unless (memq s old-autoloads
)
813 (push s byte-compile-noruntime-functions
)))
814 ((and (consp s
) (eq t
(car s
)))
815 (push (cdr s
) old-autoloads
))
816 ((and (consp s
) (eq 'autoload
(car s
)))
817 (push (cdr s
) byte-compile-noruntime-functions
)))))))
818 ;; Go through current-load-list for the locally defined funs.
820 (while (and hist-nil-new
(not (eq hist-nil-new hist-nil-orig
)))
821 (let ((s (pop hist-nil-new
)))
822 (when (and (symbolp s
) (not (memq s old-autoloads
)))
823 (push s byte-compile-noruntime-functions
))
824 (when (and (consp s
) (eq t
(car s
)))
825 (push (cdr s
) old-autoloads
)))))))
826 (when (byte-compile-warning-enabled-p 'cl-functions
)
827 (let ((hist-new load-history
))
828 ;; Go through load-history, looking for the cl files.
829 ;; Since new files are added at the start of load-history,
830 ;; we scan the new history until the tail matches the old.
831 (while (and (not byte-compile-cl-functions
)
832 hist-new
(not (eq hist-new hist-orig
)))
833 ;; We used to check if the file had already been loaded,
834 ;; but it is better to check non-nil byte-compile-cl-functions.
835 (and (byte-compile-cl-file-p (car (pop hist-new
)))
836 (byte-compile-find-cl-functions))))))))
838 (defun byte-compile-eval-before-compile (form)
839 "Evaluate FORM for `eval-and-compile'."
840 (let ((hist-nil-orig current-load-list
))
842 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
843 ;; FIXME Why does it do that - just as a hack?
844 ;; There are other ways to do this nowadays.
845 (let ((tem current-load-list
))
846 (while (not (eq tem hist-nil-orig
))
847 (when (equal (car tem
) '(require . cl
))
848 (byte-compile-disable-warning 'cl-functions
))
849 (setq tem
(cdr tem
)))))))
851 ;;; byte compiler messages
853 (defvar byte-compile-current-form nil
)
854 (defvar byte-compile-dest-file nil
)
855 (defvar byte-compile-current-file nil
)
856 (defvar byte-compile-current-group nil
)
857 (defvar byte-compile-current-buffer nil
)
859 ;; Log something that isn't a warning.
860 (defmacro byte-compile-log
(format-string &rest args
)
863 (memq byte-optimize-log
'(t source
))
864 (let ((print-escape-newlines t
)
871 (lambda (x) (if (symbolp x
) (list 'prin1-to-string x
) x
))
874 ;; Log something that isn't a warning.
875 (defun byte-compile-log-1 (string)
876 (with-current-buffer "*Compile-Log*"
877 (let ((inhibit-read-only t
))
878 (goto-char (point-max))
879 (byte-compile-warning-prefix nil nil
)
880 (cond (noninteractive
881 (message " %s" string
))
883 (insert (format "%s\n" string
)))))))
885 (defvar byte-compile-read-position nil
886 "Character position we began the last `read' from.")
887 (defvar byte-compile-last-position nil
888 "Last known character position in the input.")
890 ;; copied from gnus-util.el
891 (defsubst byte-compile-delete-first
(elt list
)
892 (if (eq (car list
) elt
)
895 (while (and (cdr list
)
896 (not (eq (cadr list
) elt
)))
897 (setq list
(cdr list
)))
899 (setcdr list
(cddr list
)))
902 ;; The purpose of this function is to iterate through the
903 ;; `read-symbol-positions-list'. Each time we process, say, a
904 ;; function definition (`defun') we remove `defun' from
905 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
906 ;; to that symbol's character position. Similarly, if we encounter a
907 ;; variable reference, like in (1+ foo), we remove `foo' from the
908 ;; list. If our current position is after the symbol's position, we
909 ;; assume we've already passed that point, and look for the next
910 ;; occurrence of the symbol.
912 ;; This function should not be called twice for the same occurrence of
913 ;; a symbol, and it should not be called for symbols generated by the
914 ;; byte compiler itself; because rather than just fail looking up the
915 ;; symbol, we may find an occurrence of the symbol further ahead, and
916 ;; then `byte-compile-last-position' as advanced too far.
918 ;; So your're probably asking yourself: Isn't this function a
919 ;; gross hack? And the answer, of course, would be yes.
920 (defun byte-compile-set-symbol-position (sym &optional allow-previous
)
921 (when byte-compile-read-position
924 (setq last byte-compile-last-position
925 entry
(assq sym read-symbol-positions-list
))
927 (setq byte-compile-last-position
928 (+ byte-compile-read-position
(cdr entry
))
929 read-symbol-positions-list
930 (byte-compile-delete-first
931 entry read-symbol-positions-list
)))
932 (or (and allow-previous
(not (= last byte-compile-last-position
)))
933 (> last byte-compile-last-position
)))))))
935 (defvar byte-compile-last-warned-form nil
)
936 (defvar byte-compile-last-logged-file nil
)
938 ;; This is used as warning-prefix for the compiler.
939 ;; It is always called with the warnings buffer current.
940 (defun byte-compile-warning-prefix (level entry
)
941 (let* ((inhibit-read-only t
)
942 (dir default-directory
)
943 (file (cond ((stringp byte-compile-current-file
)
944 (format "%s:" (file-relative-name byte-compile-current-file dir
)))
945 ((bufferp byte-compile-current-file
)
947 (buffer-name byte-compile-current-file
)))
949 (pos (if (and byte-compile-current-file
950 (integerp byte-compile-read-position
))
951 (with-current-buffer byte-compile-current-buffer
954 (goto-char byte-compile-last-position
)
955 (1+ (count-lines (point-min) (point-at-bol))))
957 (goto-char byte-compile-last-position
)
958 (1+ (current-column)))))
960 (form (if (eq byte-compile-current-form
:end
) "end of data"
961 (or byte-compile-current-form
"toplevel form"))))
962 (when (or (and byte-compile-current-file
963 (not (equal byte-compile-current-file
964 byte-compile-last-logged-file
)))
965 (and byte-compile-current-form
966 (not (eq byte-compile-current-form
967 byte-compile-last-warned-form
))))
968 (insert (format "\nIn %s:\n" form
)))
970 (insert (format "%s%s" file pos
))))
971 (setq byte-compile-last-logged-file byte-compile-current-file
972 byte-compile-last-warned-form byte-compile-current-form
)
975 ;; This no-op function is used as the value of warning-series
976 ;; to tell inner calls to displaying-byte-compile-warnings
977 ;; not to bind warning-series.
978 (defun byte-compile-warning-series (&rest ignore
)
981 ;; (compile-mode) will cause this to be loaded.
982 (declare-function compilation-forget-errors
"compile" ())
984 ;; Log the start of a file in *Compile-Log*, and mark it as done.
985 ;; Return the position of the start of the page in the log buffer.
986 ;; But do nothing in batch mode.
987 (defun byte-compile-log-file ()
988 (and (not (equal byte-compile-current-file byte-compile-last-logged-file
))
990 (with-current-buffer (get-buffer-create "*Compile-Log*")
991 (goto-char (point-max))
992 (let* ((inhibit-read-only t
)
993 (dir (and byte-compile-current-file
994 (file-name-directory byte-compile-current-file
)))
995 (was-same (equal default-directory dir
))
999 (insert (format "Leaving directory `%s'\n" default-directory
))))
1002 (setq pt
(point-marker))
1003 (if byte-compile-current-file
1004 (insert "\f\nCompiling "
1005 (if (stringp byte-compile-current-file
)
1006 (concat "file " byte-compile-current-file
)
1007 (concat "buffer " (buffer-name byte-compile-current-file
)))
1008 " at " (current-time-string) "\n")
1009 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1011 (setq default-directory dir
)
1013 (insert (format "Entering directory `%s'\n" default-directory
))))
1014 (setq byte-compile-last-logged-file byte-compile-current-file
1015 byte-compile-last-warned-form nil
)
1016 ;; Do this after setting default-directory.
1017 (unless (derived-mode-p 'compilation-mode
) (compilation-mode))
1018 (compilation-forget-errors)
1021 ;; Log a message STRING in *Compile-Log*.
1022 ;; Also log the current function and file if not already done.
1023 (defun byte-compile-log-warning (string &optional fill level
)
1024 (let ((warning-prefix-function 'byte-compile-warning-prefix
)
1025 (warning-type-format "")
1026 (warning-fill-prefix (if fill
" "))
1027 (inhibit-read-only t
))
1028 (display-warning 'bytecomp string level
"*Compile-Log*")))
1030 (defun byte-compile-warn (format &rest args
)
1031 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1032 (setq format
(apply 'format format args
))
1033 (if byte-compile-error-on-warn
1034 (error "%s" format
) ; byte-compile-file catches and logs it
1035 (byte-compile-log-warning format t
:warning
)))
1037 (defun byte-compile-warn-obsolete (symbol)
1038 "Warn that SYMBOL (a variable or function) is obsolete."
1039 (when (byte-compile-warning-enabled-p 'obsolete
)
1040 (let* ((funcp (get symbol
'byte-obsolete-info
))
1041 (obsolete (or funcp
(get symbol
'byte-obsolete-variable
)))
1042 (instead (car obsolete
))
1043 (asof (if funcp
(nth 2 obsolete
) (cdr obsolete
))))
1044 (unless (and funcp
(memq symbol byte-compile-not-obsolete-funcs
))
1045 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1046 (if funcp
"function" "variable")
1047 (if asof
(concat " (as of Emacs " asof
")") "")
1048 (cond ((stringp instead
)
1049 (concat "; " instead
))
1051 (format "; use `%s' instead." instead
))
1054 (defun byte-compile-report-error (error-info)
1055 "Report Lisp error in compilation. ERROR-INFO is the error data."
1056 (setq byte-compiler-error-flag t
)
1057 (byte-compile-log-warning
1058 (error-message-string error-info
)
1061 ;;; Used by make-obsolete.
1062 (defun byte-compile-obsolete (form)
1063 (byte-compile-set-symbol-position (car form
))
1064 (byte-compile-warn-obsolete (car form
))
1065 (funcall (or (cadr (get (car form
) 'byte-obsolete-info
)) ; handler
1066 'byte-compile-normal-call
) form
))
1068 ;;; sanity-checking arglists
1070 (defun byte-compile-fdefinition (name macro-p
)
1071 ;; If a function has an entry saying (FUNCTION . t).
1072 ;; that means we know it is defined but we don't know how.
1073 ;; If a function has an entry saying (FUNCTION . nil),
1074 ;; that means treat it as not defined.
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 (let ((advertised (gethash (if (and (symbolp fn
) (fboundp fn
))
1090 (symbol-function fn
)
1092 advertised-signature-table t
)))
1096 `(macro lambda
,advertised
)
1097 `(lambda ,advertised
)))
1098 ((and (not macro-p
) (byte-code-function-p fn
)) fn
)
1099 ((not (consp fn
)) nil
)
1100 ((eq 'macro
(car fn
)) (cdr fn
))
1102 ((eq 'autoload
(car fn
)) nil
)
1105 (defun byte-compile-arglist-signature (arglist)
1110 (cond ((eq (car arglist
) '&optional
)
1111 (or opts
(setq opts
0)))
1112 ((eq (car arglist
) '&rest
)
1118 (setq opts
(1+ opts
))
1119 (setq args
(1+ args
)))))
1120 (setq arglist
(cdr arglist
)))
1121 (cons args
(if restp nil
(if opts
(+ args opts
) args
)))))
1124 (defun byte-compile-arglist-signatures-congruent-p (old new
)
1126 (> (car new
) (car old
)) ; requires more args now
1127 (and (null (cdr old
)) ; took rest-args, doesn't any more
1129 (and (cdr new
) (cdr old
) ; can't take as many args now
1130 (< (cdr new
) (cdr old
)))
1133 (defun byte-compile-arglist-signature-string (signature)
1134 (cond ((null (cdr signature
))
1135 (format "%d+" (car signature
)))
1136 ((= (car signature
) (cdr signature
))
1137 (format "%d" (car signature
)))
1138 (t (format "%d-%d" (car signature
) (cdr signature
)))))
1141 ;; Warn if the form is calling a function with the wrong number of arguments.
1142 (defun byte-compile-callargs-warn (form)
1143 (let* ((def (or (byte-compile-fdefinition (car form
) nil
)
1144 (byte-compile-fdefinition (car form
) t
)))
1145 (sig (if (and def
(not (eq def t
)))
1147 (and (eq (car-safe def
) 'macro
)
1148 (eq (car-safe (cdr-safe def
)) 'lambda
)
1149 (setq def
(cdr def
)))
1150 (byte-compile-arglist-signature
1151 (if (memq (car-safe def
) '(declared lambda
))
1153 (if (byte-code-function-p def
)
1156 (if (and (fboundp (car form
))
1157 (subrp (symbol-function (car form
))))
1158 (subr-arity (symbol-function (car form
))))))
1159 (ncall (length (cdr form
))))
1160 ;; Check many or unevalled from subr-arity.
1161 (if (and (cdr-safe sig
)
1162 (not (numberp (cdr sig
))))
1165 (when (or (< ncall
(car sig
))
1166 (and (cdr sig
) (> ncall
(cdr sig
))))
1167 (byte-compile-set-symbol-position (car form
))
1169 "%s called with %d argument%s, but %s %s"
1171 (if (= 1 ncall
) "" "s")
1172 (if (< ncall
(car sig
))
1175 (byte-compile-arglist-signature-string sig
))))
1176 (byte-compile-format-warn form
)
1177 ;; Check to see if the function will be available at runtime
1178 ;; and/or remember its arity if it's unknown.
1179 (or (and (or def
(fboundp (car form
))) ; might be a subr or autoload.
1180 (not (memq (car form
) byte-compile-noruntime-functions
)))
1181 (eq (car form
) byte-compile-current-form
) ; ## this doesn't work
1183 ;; It's a currently-undefined function.
1184 ;; Remember number of args in call.
1185 (let ((cons (assq (car form
) byte-compile-unresolved-functions
))
1186 (n (length (cdr form
))))
1188 (or (memq n
(cdr cons
))
1189 (setcdr cons
(cons n
(cdr cons
))))
1190 (push (list (car form
) n
)
1191 byte-compile-unresolved-functions
))))))
1193 (defun byte-compile-format-warn (form)
1194 "Warn if FORM is `format'-like with inconsistent args.
1195 Applies if head of FORM is a symbol with non-nil property
1196 `byte-compile-format-like' and first arg is a constant string.
1197 Then check the number of format fields matches the number of
1199 (when (and (symbolp (car form
))
1200 (stringp (nth 1 form
))
1201 (get (car form
) 'byte-compile-format-like
))
1202 (let ((nfields (with-temp-buffer
1203 (insert (nth 1 form
))
1204 (goto-char (point-min))
1206 (while (re-search-forward "%." nil t
)
1207 (unless (eq ?%
(char-after (1+ (match-beginning 0))))
1210 (nargs (- (length form
) 2)))
1211 (unless (= nargs nfields
)
1213 "`%s' called with %d args to fill %d format field(s)" (car form
)
1216 (dolist (elt '(format message error
))
1217 (put elt
'byte-compile-format-like t
))
1219 ;; Warn if a custom definition fails to specify :group.
1220 (defun byte-compile-nogroup-warn (form)
1221 (if (and (memq (car form
) '(custom-declare-face custom-declare-variable
))
1222 byte-compile-current-group
)
1223 ;; The group will be provided implicitly.
1225 (let ((keyword-args (cdr (cdr (cdr (cdr form
)))))
1227 (or (not (eq (car-safe name
) 'quote
))
1228 (and (eq (car form
) 'custom-declare-group
)
1229 (equal name
''emacs
))
1230 (plist-get keyword-args
:group
)
1231 (not (and (consp name
) (eq (car name
) 'quote
)))
1233 "%s for `%s' fails to specify containing group"
1234 (cdr (assq (car form
)
1235 '((custom-declare-group . defgroup
)
1236 (custom-declare-face . defface
)
1237 (custom-declare-variable . defcustom
))))
1239 ;; Update the current group, if needed.
1240 (if (and byte-compile-current-file
;Only when byte-compiling a whole file.
1241 (eq (car form
) 'custom-declare-group
)
1242 (eq (car-safe name
) 'quote
))
1243 (setq byte-compile-current-group
(cadr name
))))))
1245 ;; Warn if the function or macro is being redefined with a different
1246 ;; number of arguments.
1247 (defun byte-compile-arglist-warn (form macrop
)
1248 (let ((old (byte-compile-fdefinition (nth 1 form
) macrop
)))
1249 (if (and old
(not (eq old t
)))
1251 (and (eq 'macro
(car-safe old
))
1252 (eq 'lambda
(car-safe (cdr-safe old
)))
1253 (setq old
(cdr old
)))
1254 (let ((sig1 (byte-compile-arglist-signature
1255 (if (eq 'lambda
(car-safe old
))
1257 (if (byte-code-function-p old
)
1260 (sig2 (byte-compile-arglist-signature (nth 2 form
))))
1261 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2
)
1262 (byte-compile-set-symbol-position (nth 1 form
))
1264 "%s %s used to take %s %s, now takes %s"
1265 (if (eq (car form
) 'defun
) "function" "macro")
1267 (byte-compile-arglist-signature-string sig1
)
1268 (if (equal sig1
'(1 .
1)) "argument" "arguments")
1269 (byte-compile-arglist-signature-string sig2
)))))
1270 ;; This is the first definition. See if previous calls are compatible.
1271 (let ((calls (assq (nth 1 form
) byte-compile-unresolved-functions
))
1275 (setq sig
(byte-compile-arglist-signature (nth 2 form
))
1276 nums
(sort (copy-sequence (cdr calls
)) (function <))
1278 max
(car (nreverse nums
)))
1279 (when (or (< min
(car sig
))
1280 (and (cdr sig
) (> max
(cdr sig
))))
1281 (byte-compile-set-symbol-position (nth 1 form
))
1283 "%s being defined to take %s%s, but was previously called with %s"
1285 (byte-compile-arglist-signature-string sig
)
1286 (if (equal sig
'(1 .
1)) " arg" " args")
1287 (byte-compile-arglist-signature-string (cons min max
))))
1289 (setq byte-compile-unresolved-functions
1290 (delq calls byte-compile-unresolved-functions
)))))
1293 (defvar byte-compile-cl-functions nil
1294 "List of functions defined in CL.")
1296 ;; Can't just add this to cl-load-hook, because that runs just before
1297 ;; the forms from cl.el get added to load-history.
1298 (defun byte-compile-find-cl-functions ()
1299 (unless byte-compile-cl-functions
1300 (dolist (elt load-history
)
1301 (and (byte-compile-cl-file-p (car elt
))
1302 (dolist (e (cdr elt
))
1303 ;; Includes the cl-foo functions that cl autoloads.
1304 (when (memq (car-safe e
) '(autoload defun
))
1305 (push (cdr e
) byte-compile-cl-functions
)))))))
1307 (defun byte-compile-cl-warn (form)
1308 "Warn if FORM is a call of a function from the CL package."
1309 (let ((func (car-safe form
)))
1310 (if (and byte-compile-cl-functions
1311 (memq func byte-compile-cl-functions
)
1312 ;; Aliases which won't have been expanded at this point.
1313 ;; These aren't all aliases of subrs, so not trivial to
1314 ;; avoid hardwiring the list.
1316 '(cl-block-wrapper cl-block-throw
1317 multiple-value-call nth-value
1318 copy-seq first second rest endp cl-member
1319 ;; These are included in generated code
1320 ;; that can't be called except at compile time
1321 ;; or unless cl is loaded anyway.
1322 cl-defsubst-expand cl-struct-setf-expander
1323 ;; These would sometimes be warned about
1324 ;; but such warnings are never useful,
1325 ;; so don't warn about them.
1326 macroexpand cl-macroexpand-all
1327 cl-compiling-file
)))
1328 ;; Avoid warnings for things which are safe because they
1329 ;; have suitable compiler macros, but those aren't
1330 ;; expanded at this stage. There should probably be more
1331 ;; here than caaar and friends.
1332 (not (and (eq (get func
'byte-compile
)
1333 'cl-byte-compile-compiler-macro
)
1334 (string-match "\\`c[ad]+r\\'" (symbol-name func
)))))
1335 (byte-compile-warn "Function `%s' from cl package called at runtime"
1339 (defun byte-compile-print-syms (str1 strn syms
)
1341 (byte-compile-set-symbol-position (car syms
) t
))
1342 (cond ((and (cdr syms
) (not noninteractive
))
1347 (setq s
(symbol-name (pop syms
))
1348 L
(+ L
(length s
) 2))
1349 (if (< L
(1- fill-column
))
1350 (setq str
(concat str
" " s
(and syms
",")))
1351 (setq str
(concat str
"\n " s
(and syms
","))
1352 L
(+ (length s
) 4))))
1353 (byte-compile-warn "%s" str
)))
1355 (byte-compile-warn "%s %s"
1357 (mapconcat #'symbol-name syms
", ")))
1360 (byte-compile-warn str1
(car syms
)))))
1362 ;; If we have compiled any calls to functions which are not known to be
1363 ;; defined, issue a warning enumerating them.
1364 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1365 (defun byte-compile-warn-about-unresolved-functions ()
1366 (when (byte-compile-warning-enabled-p 'unresolved
)
1367 (let ((byte-compile-current-form :end
)
1370 ;; Separate the functions that will not be available at runtime
1371 ;; from the truly unresolved ones.
1372 (dolist (f byte-compile-unresolved-functions
)
1374 (if (fboundp f
) (push f noruntime
) (push f unresolved
)))
1375 ;; Complain about the no-run-time functions
1376 (byte-compile-print-syms
1377 "the function `%s' might not be defined at runtime."
1378 "the following functions might not be defined at runtime:"
1380 ;; Complain about the unresolved functions
1381 (byte-compile-print-syms
1382 "the function `%s' is not known to be defined."
1383 "the following functions are not known to be defined:"
1388 (defsubst byte-compile-const-symbol-p
(symbol &optional any-value
)
1389 "Non-nil if SYMBOL is constant.
1390 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1392 (or (memq symbol
'(nil t
))
1395 (or (memq symbol byte-compile-const-variables
)
1396 ;; FIXME: We should provide a less intrusive way to find out
1397 ;; is a variable is "constant".
1398 (and (boundp symbol
)
1400 (progn (set symbol
(symbol-value symbol
)) nil
)
1401 (setting-constant t
)))))))
1403 (defmacro byte-compile-constp
(form)
1404 "Return non-nil if FORM is a constant."
1405 `(cond ((consp ,form
) (eq (car ,form
) 'quote
))
1406 ((not (symbolp ,form
)))
1407 ((byte-compile-const-symbol-p ,form
))))
1409 (defmacro byte-compile-close-variables
(&rest body
)
1412 ;; Close over these variables to encapsulate the
1413 ;; compilation state
1415 (byte-compile-macro-environment
1416 ;; Copy it because the compiler may patch into the
1417 ;; macroenvironment.
1418 (copy-alist byte-compile-initial-macro-environment
))
1419 (byte-compile-function-environment nil
)
1420 (byte-compile-bound-variables nil
)
1421 (byte-compile-const-variables nil
)
1422 (byte-compile-free-references nil
)
1423 (byte-compile-free-assignments nil
)
1425 ;; Close over these variables so that `byte-compiler-options'
1426 ;; can change them on a per-file basis.
1428 (byte-compile-verbose byte-compile-verbose
)
1429 (byte-optimize byte-optimize
)
1430 (byte-compile-dynamic byte-compile-dynamic
)
1431 (byte-compile-dynamic-docstrings
1432 byte-compile-dynamic-docstrings
)
1433 ;; (byte-compile-generate-emacs19-bytecodes
1434 ;; byte-compile-generate-emacs19-bytecodes)
1435 (byte-compile-warnings byte-compile-warnings
)
1439 (defmacro displaying-byte-compile-warnings
(&rest body
)
1440 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body
))
1441 (warning-series-started
1442 (and (markerp warning-series
)
1443 (eq (marker-buffer warning-series
)
1444 (get-buffer "*Compile-Log*")))))
1445 (byte-compile-find-cl-functions)
1446 (if (or (eq warning-series
'byte-compile-warning-series
)
1447 warning-series-started
)
1448 ;; warning-series does come from compilation,
1449 ;; so don't bind it, but maybe do set it.
1451 ;; Log the file name. Record position of that text.
1452 (setq tem
(byte-compile-log-file))
1453 (unless warning-series-started
1454 (setq warning-series
(or tem
'byte-compile-warning-series
)))
1455 (if byte-compile-debug
1456 (funcall --displaying-byte-compile-warnings-fn
)
1457 (condition-case error-info
1458 (funcall --displaying-byte-compile-warnings-fn
)
1459 (error (byte-compile-report-error error-info
)))))
1460 ;; warning-series does not come from compilation, so bind it.
1461 (let ((warning-series
1462 ;; Log the file name. Record position of that text.
1463 (or (byte-compile-log-file) 'byte-compile-warning-series
)))
1464 (if byte-compile-debug
1465 (funcall --displaying-byte-compile-warnings-fn
)
1466 (condition-case error-info
1467 (funcall --displaying-byte-compile-warnings-fn
)
1468 (error (byte-compile-report-error error-info
))))))))
1471 (defun byte-force-recompile (directory)
1472 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1473 Files in subdirectories of DIRECTORY are processed also."
1474 (interactive "DByte force recompile (directory): ")
1475 (byte-recompile-directory directory nil t
))
1477 ;; The `bytecomp-' prefix is applied to all local variables with
1478 ;; otherwise common names in this and similar functions for the sake
1479 ;; of the boundp test in byte-compile-variable-ref.
1480 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg00237.html
1481 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00134.html
1482 ;; Note that similar considerations apply to command-line-1 in startup.el.
1484 (defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
1486 "Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
1487 This happens when a `.elc' file exists but is older than the `.el' file.
1488 Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
1490 If the `.elc' file does not exist, normally this function *does not*
1491 compile the corresponding `.el' file. However, if the prefix argument
1492 BYTECOMP-ARG is 0, that means do compile all those files. A nonzero
1493 BYTECOMP-ARG means ask the user, for each such `.el' file, whether to
1494 compile it. A nonzero BYTECOMP-ARG also means ask about each subdirectory
1497 If the third argument BYTECOMP-FORCE is non-nil, recompile every `.el' file
1498 that already has a `.elc' file."
1499 (interactive "DByte recompile directory: \nP")
1501 (setq bytecomp-arg
(prefix-numeric-value bytecomp-arg
)))
1505 (force-mode-line-update))
1506 (with-current-buffer (get-buffer-create "*Compile-Log*")
1507 (setq default-directory
(expand-file-name bytecomp-directory
))
1508 ;; compilation-mode copies value of default-directory.
1509 (unless (eq major-mode
'compilation-mode
)
1511 (let ((bytecomp-directories (list default-directory
))
1512 (default-directory default-directory
)
1518 (displaying-byte-compile-warnings
1519 (while bytecomp-directories
1520 (setq bytecomp-directory
(car bytecomp-directories
))
1521 (message "Checking %s..." bytecomp-directory
)
1522 (let ((bytecomp-files (directory-files bytecomp-directory
))
1523 bytecomp-source bytecomp-dest
)
1524 (dolist (bytecomp-file bytecomp-files
)
1525 (setq bytecomp-source
1526 (expand-file-name bytecomp-file bytecomp-directory
))
1527 (if (and (not (member bytecomp-file
'("RCS" "CVS")))
1528 (not (eq ?\.
(aref bytecomp-file
0)))
1529 (file-directory-p bytecomp-source
)
1530 (not (file-symlink-p bytecomp-source
)))
1531 ;; This file is a subdirectory. Handle them differently.
1532 (when (or (null bytecomp-arg
)
1534 (y-or-n-p (concat "Check " bytecomp-source
"? ")))
1535 (setq bytecomp-directories
1536 (nconc bytecomp-directories
(list bytecomp-source
))))
1537 ;; It is an ordinary file. Decide whether to compile it.
1538 (if (and (string-match emacs-lisp-file-regexp bytecomp-source
)
1539 (file-readable-p bytecomp-source
)
1540 (not (auto-save-file-name-p bytecomp-source
))
1542 (byte-compile-dest-file bytecomp-source
))
1543 (if (file-exists-p bytecomp-dest
)
1544 ;; File was already compiled.
1546 (file-newer-than-file-p bytecomp-source
1548 ;; No compiled file exists yet.
1550 (or (eq 0 bytecomp-arg
)
1551 (y-or-n-p (concat "Compile "
1552 bytecomp-source
"? "))))))
1553 (progn (if (and noninteractive
(not byte-compile-verbose
))
1554 (message "Compiling %s..." bytecomp-source
))
1555 (let ((bytecomp-res (byte-compile-file
1557 (cond ((eq bytecomp-res
'no-byte-compile
)
1558 (setq skip-count
(1+ skip-count
)))
1559 ((eq bytecomp-res t
)
1560 (setq file-count
(1+ file-count
)))
1561 ((eq bytecomp-res nil
)
1562 (setq fail-count
(1+ fail-count
)))))
1564 (message "Checking %s..." bytecomp-directory
))
1565 (if (not (eq last-dir bytecomp-directory
))
1566 (setq last-dir bytecomp-directory
1567 dir-count
(1+ dir-count
)))
1569 (setq bytecomp-directories
(cdr bytecomp-directories
))))
1570 (message "Done (Total of %d file%s compiled%s%s%s)"
1571 file-count
(if (= file-count
1) "" "s")
1572 (if (> fail-count
0) (format ", %d failed" fail-count
) "")
1573 (if (> skip-count
0) (format ", %d skipped" skip-count
) "")
1575 (format " in %d directories" dir-count
) "")))))
1577 (defvar no-byte-compile nil
1578 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1579 This is normally set in local file variables at the end of the elisp file:
1581 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1582 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1585 (defun byte-compile-file (bytecomp-filename &optional load
)
1586 "Compile a file of Lisp code named BYTECOMP-FILENAME into a file of byte code.
1587 The output file's name is generated by passing BYTECOMP-FILENAME to the
1588 function `byte-compile-dest-file' (which see).
1589 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1590 The value is non-nil if there were no errors, nil if errors."
1591 ;; (interactive "fByte compile file: \nP")
1593 (let ((bytecomp-file buffer-file-name
)
1594 (bytecomp-file-name nil
)
1595 (bytecomp-file-dir nil
))
1597 (eq (cdr (assq 'major-mode
(buffer-local-variables)))
1599 (setq bytecomp-file-name
(file-name-nondirectory bytecomp-file
)
1600 bytecomp-file-dir
(file-name-directory bytecomp-file
)))
1601 (list (read-file-name (if current-prefix-arg
1602 "Byte compile and load file: "
1603 "Byte compile file: ")
1604 bytecomp-file-dir bytecomp-file-name nil
)
1605 current-prefix-arg
)))
1606 ;; Expand now so we get the current buffer's defaults
1607 (setq bytecomp-filename
(expand-file-name bytecomp-filename
))
1609 ;; If we're compiling a file that's in a buffer and is modified, offer
1610 ;; to save it first.
1612 (let ((b (get-file-buffer (expand-file-name bytecomp-filename
))))
1613 (if (and b
(buffer-modified-p b
)
1614 (y-or-n-p (format "Save buffer %s first? " (buffer-name b
))))
1615 (with-current-buffer b
(save-buffer)))))
1617 ;; Force logging of the file name for each file compiled.
1618 (setq byte-compile-last-logged-file nil
)
1619 (let ((byte-compile-current-file bytecomp-filename
)
1620 (byte-compile-current-group nil
)
1621 (set-auto-coding-for-load t
)
1622 target-file input-buffer output-buffer
1623 byte-compile-dest-file
)
1624 (setq target-file
(byte-compile-dest-file bytecomp-filename
))
1625 (setq byte-compile-dest-file target-file
)
1626 (with-current-buffer
1627 (setq input-buffer
(get-buffer-create " *Compiler Input*"))
1629 (setq buffer-file-coding-system nil
)
1630 ;; Always compile an Emacs Lisp file as multibyte
1631 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1632 (set-buffer-multibyte t
)
1633 (insert-file-contents bytecomp-filename
)
1634 ;; Mimic the way after-insert-file-set-coding can make the
1635 ;; buffer unibyte when visiting this file.
1636 (when (or (eq last-coding-system-used
'no-conversion
)
1637 (eq (coding-system-type last-coding-system-used
) 5))
1638 ;; For coding systems no-conversion and raw-text...,
1639 ;; edit the buffer as unibyte.
1640 (set-buffer-multibyte nil
))
1641 ;; Run hooks including the uncompression hook.
1642 ;; If they change the file name, then change it for the output also.
1643 (letf ((buffer-file-name bytecomp-filename
)
1644 ((default-value 'major-mode
) 'emacs-lisp-mode
)
1645 ;; Ignore unsafe local variables.
1646 ;; We only care about a few of them for our purposes.
1647 (enable-local-variables :safe
)
1648 (enable-local-eval nil
))
1649 ;; Arg of t means don't alter enable-local-variables.
1651 (setq bytecomp-filename buffer-file-name
))
1652 ;; Set the default directory, in case an eval-when-compile uses it.
1653 (setq default-directory
(file-name-directory bytecomp-filename
)))
1654 ;; Check if the file's local variables explicitly specify not to
1655 ;; compile this file.
1656 (if (with-current-buffer input-buffer no-byte-compile
)
1658 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1659 ;; (file-relative-name bytecomp-filename)
1660 ;; (with-current-buffer input-buffer no-byte-compile))
1661 (when (file-exists-p target-file
)
1662 (message "%s deleted because of `no-byte-compile: %s'"
1663 (file-relative-name target-file
)
1664 (buffer-local-value 'no-byte-compile input-buffer
))
1665 (condition-case nil
(delete-file target-file
) (error nil
)))
1666 ;; We successfully didn't compile this file.
1668 (when byte-compile-verbose
1669 (message "Compiling %s..." bytecomp-filename
))
1670 (setq byte-compiler-error-flag nil
)
1671 ;; It is important that input-buffer not be current at this call,
1672 ;; so that the value of point set in input-buffer
1673 ;; within byte-compile-from-buffer lingers in that buffer.
1675 (save-current-buffer
1676 (byte-compile-from-buffer input-buffer bytecomp-filename
)))
1677 (if byte-compiler-error-flag
1679 (when byte-compile-verbose
1680 (message "Compiling %s...done" bytecomp-filename
))
1681 (kill-buffer input-buffer
)
1682 (with-current-buffer output-buffer
1683 (goto-char (point-max))
1684 (insert "\n") ; aaah, unix.
1685 (if (file-writable-p target-file
)
1686 ;; We must disable any code conversion here.
1687 (let ((coding-system-for-write 'no-conversion
))
1688 (if (memq system-type
'(ms-dos 'windows-nt
))
1689 (setq buffer-file-type t
))
1690 (when (file-exists-p target-file
)
1691 ;; Remove the target before writing it, so that any
1692 ;; hard-links continue to point to the old file (this makes
1693 ;; it possible for installed files to share disk space with
1694 ;; the build tree, without causing problems when emacs-lisp
1695 ;; files in the build tree are recompiled).
1696 (delete-file target-file
))
1697 (write-region (point-min) (point-max) target-file
))
1698 ;; This is just to give a better error message than write-region
1700 (list "Opening output file"
1701 (if (file-exists-p target-file
)
1702 "cannot overwrite file"
1703 "directory not writable or nonexistent")
1705 (kill-buffer (current-buffer)))
1706 (if (and byte-compile-generate-call-tree
1707 (or (eq t byte-compile-generate-call-tree
)
1708 (y-or-n-p (format "Report call tree for %s? "
1709 bytecomp-filename
))))
1711 (display-call-tree bytecomp-filename
)))
1716 ;;; compiling a single function
1718 (defun compile-defun (&optional arg
)
1719 "Compile and evaluate the current top-level form.
1720 Print the result in the echo area.
1721 With argument ARG, insert value in current buffer after the form."
1725 (beginning-of-defun)
1726 (let* ((byte-compile-current-file nil
)
1727 (byte-compile-current-buffer (current-buffer))
1728 (byte-compile-read-position (point))
1729 (byte-compile-last-position byte-compile-read-position
)
1730 (byte-compile-last-warned-form 'nothing
)
1732 (let ((read-with-symbol-positions (current-buffer))
1733 (read-symbol-positions-list nil
))
1734 (displaying-byte-compile-warnings
1735 (byte-compile-sexp (read (current-buffer))))))))
1737 (message "Compiling from buffer... done.")
1738 (prin1 value
(current-buffer))
1740 ((message "%s" (prin1-to-string value
)))))))
1743 (defun byte-compile-from-buffer (bytecomp-inbuffer &optional bytecomp-filename
)
1744 ;; Filename is used for the loading-into-Emacs-18 error message.
1745 (let (bytecomp-outbuffer
1746 (byte-compile-current-buffer bytecomp-inbuffer
)
1747 (byte-compile-read-position nil
)
1748 (byte-compile-last-position nil
)
1749 ;; Prevent truncation of flonums and lists as we read and print them
1750 (float-output-format nil
)
1751 (case-fold-search nil
)
1754 ;; Prevent edebug from interfering when we compile
1755 ;; and put the output into a file.
1756 ;; (edebug-all-defs nil)
1757 ;; (edebug-all-forms nil)
1758 ;; Simulate entry to byte-compile-top-level
1759 (byte-compile-constants nil
)
1760 (byte-compile-variables nil
)
1761 (byte-compile-tag-number 0)
1762 (byte-compile-depth 0)
1763 (byte-compile-maxdepth 0)
1764 (byte-compile-output nil
)
1765 ;; This allows us to get the positions of symbols read; it's
1766 ;; new in Emacs 22.1.
1767 (read-with-symbol-positions bytecomp-inbuffer
)
1768 (read-symbol-positions-list nil
)
1769 ;; #### This is bound in b-c-close-variables.
1770 ;; (byte-compile-warnings byte-compile-warnings)
1772 (byte-compile-close-variables
1773 (with-current-buffer
1774 (setq bytecomp-outbuffer
(get-buffer-create " *Compiler Output*"))
1775 (set-buffer-multibyte t
)
1777 ;; (emacs-lisp-mode)
1778 (setq case-fold-search nil
)
1779 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1780 ;; write files containing binary information specially.
1781 ;; Under most circumstances, such files will be in binary
1782 ;; overwrite mode, so those OS's use that flag to guess how
1783 ;; they should write their data. Advise them that .elc files
1784 ;; need to be written carefully.
1785 (setq overwrite-mode
'overwrite-mode-binary
))
1786 (displaying-byte-compile-warnings
1787 (with-current-buffer bytecomp-inbuffer
1788 (and bytecomp-filename
1789 (byte-compile-insert-header bytecomp-filename bytecomp-outbuffer
))
1790 (goto-char (point-min))
1791 ;; Should we always do this? When calling multiple files, it
1792 ;; would be useful to delay this warning until all have been
1793 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1794 ;; previous byte-compile.
1795 (setq byte-compile-unresolved-functions nil
)
1797 ;; Compile the forms from the input buffer.
1799 (while (progn (skip-chars-forward " \t\n\^l")
1803 (setq byte-compile-read-position
(point)
1804 byte-compile-last-position byte-compile-read-position
)
1805 (let* ((old-style-backquotes nil
)
1806 (form (read bytecomp-inbuffer
)))
1807 ;; Warn about the use of old-style backquotes.
1808 (when old-style-backquotes
1809 (byte-compile-warn "!! The file uses old-style backquotes !!
1810 This functionality has been obsolete for more than 10 years already
1811 and will be removed soon. See (elisp)Backquote in the manual."))
1812 (byte-compile-file-form form
)))
1813 ;; Compile pending forms at end of file.
1814 (byte-compile-flush-pending)
1815 ;; Make warnings about unresolved functions
1816 ;; give the end of the file as their position.
1817 (setq byte-compile-last-position
(point-max))
1818 (byte-compile-warn-about-unresolved-functions))
1819 ;; Fix up the header at the front of the output
1820 ;; if the buffer contains multibyte characters.
1821 (and bytecomp-filename
1822 (with-current-buffer bytecomp-outbuffer
1823 (byte-compile-fix-header bytecomp-filename
)))))
1824 bytecomp-outbuffer
))
1826 (defun byte-compile-fix-header (filename)
1827 "If the current buffer has any multibyte characters, insert a version test."
1828 (when (< (point-max) (position-bytes (point-max)))
1829 (goto-char (point-min))
1830 ;; Find the comment that describes the version condition.
1831 (search-forward "\n;;; This file uses")
1832 (narrow-to-region (line-beginning-position) (point-max))
1833 ;; Find the first line of ballast semicolons.
1834 (search-forward ";;;;;;;;;;")
1836 (narrow-to-region (point-min) (point))
1837 (let ((old-header-end (point))
1838 (minimum-version "23")
1840 (delete-region (point-min) (point-max))
1842 ";;; This file contains utf-8 non-ASCII characters,\n"
1843 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1844 ;; Have to check if emacs-version is bound so that this works
1845 ;; in files loaded early in loadup.el.
1846 "(and (boundp 'emacs-version)\n"
1847 ;; If there is a name at the end of emacs-version,
1848 ;; don't try to check the version number.
1849 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1850 (format " (string-lessp emacs-version \"%s\")\n" minimum-version
)
1852 ;; prin1-to-string is used to quote backslashes.
1853 (substring (prin1-to-string (file-name-nondirectory filename
))
1855 (format "' was compiled for Emacs %s or later\"))\n\n"
1857 ;; Now compensate for any change in size, to make sure all
1858 ;; positions in the file remain valid.
1859 (setq delta
(- (point-max) old-header-end
))
1860 (goto-char (point-max))
1862 (delete-char delta
))))
1864 (defun byte-compile-insert-header (filename outbuffer
)
1865 "Insert a header at the start of OUTBUFFER.
1866 Call from the source buffer."
1867 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
)
1868 (dynamic byte-compile-dynamic
)
1869 (optimize byte-optimize
))
1870 (with-current-buffer outbuffer
1871 (goto-char (point-min))
1872 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1873 ;; that is the file-format version number (18, 19, 20, or 23) as a
1874 ;; byte, followed by some nulls. The primary motivation for doing
1875 ;; this is to get some binary characters up in the first line of
1876 ;; the file so that `diff' will simply say "Binary files differ"
1877 ;; instead of actually doing a diff of two .elc files. An extra
1878 ;; benefit is that you can add this to /etc/magic:
1879 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1880 ;; >4 byte x version %d
1882 ";ELC" 23 "\000\000\000\n"
1884 (or (and (boundp 'user-mail-address
) user-mail-address
)
1885 (concat (user-login-name) "@" (system-name)))
1886 " on " (current-time-string) "\n"
1887 ";;; from file " filename
"\n"
1888 ";;; in Emacs version " emacs-version
"\n"
1891 ((eq optimize
'source
) " source-level optimization only")
1892 ((eq optimize
'byte
) " byte-level optimization only")
1893 (optimize " all optimizations")
1894 (t "out optimization"))
1896 (if dynamic
";;; Function definitions are lazy-loaded.\n"
1898 "\n;;; This file uses "
1899 (if dynamic-docstrings
1900 "dynamic docstrings, first added in Emacs 19.29"
1901 "opcodes that do not exist in Emacs 18")
1903 ;; Note that byte-compile-fix-header may change this.
1904 ";;; This file does not contain utf-8 non-ASCII characters,\n"
1905 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
1906 ;; Insert semicolons as ballast, so that byte-compile-fix-header
1907 ;; can delete them so as to keep the buffer positions
1908 ;; constant for the actual compiled code.
1909 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
1910 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
1912 ;; Dynamically bound in byte-compile-from-buffer.
1913 ;; NB also used in cl.el and cl-macs.el.
1914 (defvar bytecomp-outbuffer
)
1916 (defun byte-compile-output-file-form (form)
1917 ;; writes the given form to the output buffer, being careful of docstrings
1918 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
1919 ;; custom-declare-variable because make-docfile is so amazingly stupid.
1920 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
1921 ;; it does not pay to first build the defalias in defmumble and then parse
1923 (if (and (memq (car-safe form
) '(defun defmacro defvar defvaralias defconst autoload
1924 custom-declare-variable
))
1925 (stringp (nth 3 form
)))
1926 (byte-compile-output-docform nil nil
'("\n(" 3 ")") form nil
1928 '(defvaralias autoload
1929 custom-declare-variable
)))
1930 (let ((print-escape-newlines t
)
1935 (print-circle ; handle circular data structures
1936 (not byte-compile-disable-print-circle
)))
1937 (princ "\n" bytecomp-outbuffer
)
1938 (prin1 form bytecomp-outbuffer
)
1941 (defvar print-gensym-alist
) ;Used before print-circle existed.
1943 (defun byte-compile-output-docform (preface name info form specindex quoted
)
1944 "Print a form with a doc string. INFO is (prefix doc-index postfix).
1945 If PREFACE and NAME are non-nil, print them too,
1946 before INFO and the FORM but after the doc string itself.
1947 If SPECINDEX is non-nil, it is the index in FORM
1948 of the function bytecode string. In that case,
1949 we output that argument and the following argument
1950 \(the constants vector) together, for lazy loading.
1951 QUOTED says that we have to put a quote before the
1952 list that represents a doc string reference.
1953 `defvaralias', `autoload' and `custom-declare-variable' need that."
1954 ;; We need to examine byte-compile-dynamic-docstrings
1955 ;; in the input buffer (now current), not in the output buffer.
1956 (let ((dynamic-docstrings byte-compile-dynamic-docstrings
))
1957 (with-current-buffer bytecomp-outbuffer
1960 ;; Insert the doc string, and make it a comment with #@LENGTH.
1961 (and (>= (nth 1 info
) 0)
1964 ;; Make the doc string start at beginning of line
1965 ;; for make-docfile's sake.
1968 (byte-compile-output-as-comment
1969 (nth (nth 1 info
) form
) nil
))
1970 (setq position
(- (position-bytes position
) (point-min) -
1))
1971 ;; If the doc string starts with * (a user variable),
1973 (if (and (stringp (nth (nth 1 info
) form
))
1974 (> (length (nth (nth 1 info
) form
)) 0)
1975 (eq (aref (nth (nth 1 info
) form
) 0) ?
*))
1976 (setq position
(- position
)))))
1981 (prin1 name bytecomp-outbuffer
)))
1983 (let ((print-escape-newlines t
)
1985 ;; For compatibility with code before print-circle,
1986 ;; use a cons cell to say that we want
1987 ;; print-gensym-alist not to be cleared
1988 ;; between calls to print functions.
1990 (print-circle ; handle circular data structures
1991 (not byte-compile-disable-print-circle
))
1992 print-gensym-alist
; was used before print-circle existed.
1993 (print-continuous-numbering t
)
1996 (prin1 (car form
) bytecomp-outbuffer
)
1997 (while (setq form
(cdr form
))
1998 (setq index
(1+ index
))
2000 (cond ((and (numberp specindex
) (= index specindex
)
2001 ;; Don't handle the definition dynamically
2002 ;; if it refers (or might refer)
2003 ;; to objects already output
2004 ;; (for instance, gensyms in the arg list).
2006 (dotimes (i (length print-number-table
))
2007 (if (aref print-number-table i
)
2010 ;; Output the byte code and constants specially
2011 ;; for lazy dynamic loading.
2013 (byte-compile-output-as-comment
2014 (cons (car form
) (nth 1 form
))
2016 (setq position
(- (position-bytes position
) (point-min) -
1))
2017 (princ (format "(#$ . %d) nil" position
) bytecomp-outbuffer
)
2018 (setq form
(cdr form
))
2019 (setq index
(1+ index
))))
2020 ((= index
(nth 1 info
))
2022 (princ (format (if quoted
"'(#$ . %d)" "(#$ . %d)")
2025 (let ((print-escape-newlines nil
))
2026 (goto-char (prog1 (1+ (point))
2027 (prin1 (car form
) bytecomp-outbuffer
)))
2029 (goto-char (point-max)))))
2031 (prin1 (car form
) bytecomp-outbuffer
)))))
2032 (insert (nth 2 info
)))))
2035 (defun byte-compile-keep-pending (form &optional bytecomp-handler
)
2036 (if (memq byte-optimize
'(t source
))
2037 (setq form
(byte-optimize-form form t
)))
2038 (if bytecomp-handler
2039 (let ((for-effect t
))
2040 ;; To avoid consing up monstrously large forms at load time, we split
2041 ;; the output regularly.
2042 (and (memq (car-safe form
) '(fset defalias
))
2043 (nthcdr 300 byte-compile-output
)
2044 (byte-compile-flush-pending))
2045 (funcall bytecomp-handler form
)
2047 (byte-compile-discard)))
2048 (byte-compile-form form t
))
2051 (defun byte-compile-flush-pending ()
2052 (if byte-compile-output
2053 (let ((form (byte-compile-out-toplevel t
'file
)))
2054 (cond ((eq (car-safe form
) 'progn
)
2055 (mapc 'byte-compile-output-file-form
(cdr form
)))
2057 (byte-compile-output-file-form form
)))
2058 (setq byte-compile-constants nil
2059 byte-compile-variables nil
2060 byte-compile-depth
0
2061 byte-compile-maxdepth
0
2062 byte-compile-output nil
))))
2064 (defun byte-compile-file-form (form)
2065 (let ((byte-compile-current-form nil
) ; close over this for warnings.
2069 (byte-compile-keep-pending form
))
2070 ((and (symbolp (car form
))
2071 (setq bytecomp-handler
(get (car form
) 'byte-hunk-handler
)))
2072 (cond ((setq form
(funcall bytecomp-handler form
))
2073 (byte-compile-flush-pending)
2074 (byte-compile-output-file-form form
))))
2075 ((eq form
(setq form
(macroexpand form byte-compile-macro-environment
)))
2076 (byte-compile-keep-pending form
))
2078 (byte-compile-file-form form
)))))
2080 ;; Functions and variables with doc strings must be output separately,
2081 ;; so make-docfile can recognise them. Most other things can be output
2084 (put 'defsubst
'byte-hunk-handler
'byte-compile-file-form-defsubst
)
2085 (defun byte-compile-file-form-defsubst (form)
2086 (when (assq (nth 1 form
) byte-compile-unresolved-functions
)
2087 (setq byte-compile-current-form
(nth 1 form
))
2088 (byte-compile-warn "defsubst `%s' was used before it was defined"
2090 (byte-compile-file-form
2091 (macroexpand form byte-compile-macro-environment
))
2092 ;; Return nil so the form is not output twice.
2095 (put 'autoload
'byte-hunk-handler
'byte-compile-file-form-autoload
)
2096 (defun byte-compile-file-form-autoload (form)
2097 (and (let ((form form
))
2098 (while (if (setq form
(cdr form
)) (byte-compile-constp (car form
))))
2099 (null form
)) ;Constants only
2100 (eval (nth 5 form
)) ;Macro
2101 (eval form
)) ;Define the autoload.
2102 ;; Avoid undefined function warnings for the autoload.
2103 (when (and (consp (nth 1 form
))
2104 (eq (car (nth 1 form
)) 'quote
)
2105 (consp (cdr (nth 1 form
)))
2106 (symbolp (nth 1 (nth 1 form
))))
2107 (push (cons (nth 1 (nth 1 form
))
2108 (cons 'autoload
(cdr (cdr form
))))
2109 byte-compile-function-environment
)
2110 ;; If an autoload occurs _before_ the first call to a function,
2111 ;; byte-compile-callargs-warn does not add an entry to
2112 ;; byte-compile-unresolved-functions. Here we mimic the logic
2113 ;; of byte-compile-callargs-warn so as not to warn if the
2114 ;; autoload comes _after_ the function call.
2115 ;; Alternatively, similar logic could go in
2116 ;; byte-compile-warn-about-unresolved-functions.
2117 (or (memq (nth 1 (nth 1 form
)) byte-compile-noruntime-functions
)
2118 (setq byte-compile-unresolved-functions
2119 (delq (assq (nth 1 (nth 1 form
))
2120 byte-compile-unresolved-functions
)
2121 byte-compile-unresolved-functions
))))
2122 (if (stringp (nth 3 form
))
2124 ;; No doc string, so we can compile this as a normal form.
2125 (byte-compile-keep-pending form
'byte-compile-normal-call
)))
2127 (put 'defvar
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2128 (put 'defconst
'byte-hunk-handler
'byte-compile-file-form-defvar
)
2129 (defun byte-compile-file-form-defvar (form)
2130 (if (null (nth 3 form
))
2131 ;; Since there is no doc string, we can compile this as a normal form,
2132 ;; and not do a file-boundary.
2133 (byte-compile-keep-pending form
)
2134 (push (nth 1 form
) byte-compile-bound-variables
)
2135 (if (eq (car form
) 'defconst
)
2136 (push (nth 1 form
) byte-compile-const-variables
))
2137 (cond ((consp (nth 2 form
))
2138 (setq form
(copy-sequence form
))
2139 (setcar (cdr (cdr form
))
2140 (byte-compile-top-level (nth 2 form
) nil
'file
))))
2143 (put 'define-abbrev-table
'byte-hunk-handler
'byte-compile-file-form-define-abbrev-table
)
2144 (defun byte-compile-file-form-define-abbrev-table (form)
2145 (if (eq 'quote
(car-safe (car-safe (cdr form
))))
2146 (push (car-safe (cdr (cadr form
))) byte-compile-bound-variables
))
2147 (byte-compile-keep-pending form
))
2149 (put 'custom-declare-variable
'byte-hunk-handler
2150 'byte-compile-file-form-custom-declare-variable
)
2151 (defun byte-compile-file-form-custom-declare-variable (form)
2152 (when (byte-compile-warning-enabled-p 'callargs
)
2153 (byte-compile-nogroup-warn form
))
2154 (push (nth 1 (nth 1 form
)) byte-compile-bound-variables
)
2155 ;; Don't compile the expression because it may be displayed to the user.
2156 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2157 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2158 ;; ;; final value already, we can byte-compile it.
2159 ;; (setcar (cdr (nth 2 form))
2160 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2161 (let ((tail (nthcdr 4 form
)))
2163 (unless (keywordp (car tail
)) ;No point optimizing keywords.
2164 ;; Compile the keyword arguments.
2165 (setcar tail
(byte-compile-top-level (car tail
) nil
'file
)))
2166 (setq tail
(cdr tail
))))
2169 (put 'require
'byte-hunk-handler
'byte-compile-file-form-require
)
2170 (defun byte-compile-file-form-require (form)
2171 (let ((args (mapcar 'eval
(cdr form
)))
2172 (hist-orig load-history
)
2174 (apply 'require args
)
2175 (when (byte-compile-warning-enabled-p 'cl-functions
)
2176 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2177 (if (member (car args
) '("cl" cl
))
2179 (byte-compile-warn "cl package required at runtime")
2180 (byte-compile-disable-warning 'cl-functions
))
2181 ;; We may have required something that causes cl to be loaded, eg
2182 ;; the uncompiled version of a file that requires cl when compiling.
2183 (setq hist-new load-history
)
2184 (while (and (not byte-compile-cl-functions
)
2185 hist-new
(not (eq hist-new hist-orig
)))
2186 (and (byte-compile-cl-file-p (car (pop hist-new
)))
2187 (byte-compile-find-cl-functions))))))
2188 (byte-compile-keep-pending form
'byte-compile-normal-call
))
2190 (put 'progn
'byte-hunk-handler
'byte-compile-file-form-progn
)
2191 (put 'prog1
'byte-hunk-handler
'byte-compile-file-form-progn
)
2192 (put 'prog2
'byte-hunk-handler
'byte-compile-file-form-progn
)
2193 (defun byte-compile-file-form-progn (form)
2194 (mapc 'byte-compile-file-form
(cdr form
))
2195 ;; Return nil so the forms are not output twice.
2198 (put 'with-no-warnings
'byte-hunk-handler
2199 'byte-compile-file-form-with-no-warnings
)
2200 (defun byte-compile-file-form-with-no-warnings (form)
2201 ;; cf byte-compile-file-form-progn.
2202 (let (byte-compile-warnings)
2203 (mapc 'byte-compile-file-form
(cdr form
))
2206 ;; This handler is not necessary, but it makes the output from dont-compile
2207 ;; and similar macros cleaner.
2208 (put 'eval
'byte-hunk-handler
'byte-compile-file-form-eval
)
2209 (defun byte-compile-file-form-eval (form)
2210 (if (eq (car-safe (nth 1 form
)) 'quote
)
2211 (nth 1 (nth 1 form
))
2212 (byte-compile-keep-pending form
)))
2214 (put 'defun
'byte-hunk-handler
'byte-compile-file-form-defun
)
2215 (defun byte-compile-file-form-defun (form)
2216 (byte-compile-file-form-defmumble form nil
))
2218 (put 'defmacro
'byte-hunk-handler
'byte-compile-file-form-defmacro
)
2219 (defun byte-compile-file-form-defmacro (form)
2220 (byte-compile-file-form-defmumble form t
))
2222 (defun byte-compile-defmacro-declaration (form)
2223 "Generate code for declarations in macro definitions.
2224 Remove declarations from the body of the macro definition
2226 (let ((tail (nthcdr 2 form
))
2228 (when (stringp (car (cdr tail
)))
2229 (setq tail
(cdr tail
)))
2230 (while (and (consp (car (cdr tail
)))
2231 (eq (car (car (cdr tail
))) 'declare
))
2232 (let ((declaration (car (cdr tail
))))
2233 (setcdr tail
(cdr (cdr tail
)))
2234 (push `(if macro-declaration-function
2235 (funcall macro-declaration-function
2236 ',(car (cdr form
)) ',declaration
))
2240 (defun byte-compile-file-form-defmumble (form macrop
)
2241 (let* ((bytecomp-name (car (cdr form
)))
2242 (bytecomp-this-kind (if macrop
'byte-compile-macro-environment
2243 'byte-compile-function-environment
))
2244 (bytecomp-that-kind (if macrop
'byte-compile-function-environment
2245 'byte-compile-macro-environment
))
2246 (bytecomp-this-one (assq bytecomp-name
2247 (symbol-value bytecomp-this-kind
)))
2248 (bytecomp-that-one (assq bytecomp-name
2249 (symbol-value bytecomp-that-kind
)))
2250 (byte-compile-free-references nil
)
2251 (byte-compile-free-assignments nil
))
2252 (byte-compile-set-symbol-position bytecomp-name
)
2253 ;; When a function or macro is defined, add it to the call tree so that
2254 ;; we can tell when functions are not used.
2255 (if byte-compile-generate-call-tree
2256 (or (assq bytecomp-name byte-compile-call-tree
)
2257 (setq byte-compile-call-tree
2258 (cons (list bytecomp-name nil nil
) byte-compile-call-tree
))))
2260 (setq byte-compile-current-form bytecomp-name
) ; for warnings
2261 (if (byte-compile-warning-enabled-p 'redefine
)
2262 (byte-compile-arglist-warn form macrop
))
2263 (if byte-compile-verbose
2264 ;; bytecomp-filename is from byte-compile-from-buffer.
2265 (message "Compiling %s... (%s)" (or bytecomp-filename
"") (nth 1 form
)))
2266 (cond (bytecomp-that-one
2267 (if (and (byte-compile-warning-enabled-p 'redefine
)
2268 ;; don't warn when compiling the stubs in byte-run...
2269 (not (assq (nth 1 form
)
2270 byte-compile-initial-macro-environment
)))
2272 "`%s' defined multiple times, as both function and macro"
2274 (setcdr bytecomp-that-one nil
))
2276 (when (and (byte-compile-warning-enabled-p 'redefine
)
2277 ;; hack: don't warn when compiling the magic internal
2278 ;; byte-compiler macros in byte-run.el...
2279 (not (assq (nth 1 form
)
2280 byte-compile-initial-macro-environment
)))
2281 (byte-compile-warn "%s `%s' defined multiple times in this file"
2282 (if macrop
"macro" "function")
2284 ((and (fboundp bytecomp-name
)
2285 (eq (car-safe (symbol-function bytecomp-name
))
2286 (if macrop
'lambda
'macro
)))
2287 (when (byte-compile-warning-enabled-p 'redefine
)
2288 (byte-compile-warn "%s `%s' being redefined as a %s"
2289 (if macrop
"function" "macro")
2291 (if macrop
"macro" "function")))
2292 ;; shadow existing definition
2293 (set bytecomp-this-kind
2294 (cons (cons bytecomp-name nil
)
2295 (symbol-value bytecomp-this-kind
))))
2297 (let ((body (nthcdr 3 form
)))
2298 (when (and (stringp (car body
))
2299 (symbolp (car-safe (cdr-safe body
)))
2300 (car-safe (cdr-safe body
))
2301 (stringp (car-safe (cdr-safe (cdr-safe body
)))))
2302 (byte-compile-set-symbol-position (nth 1 form
))
2303 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2306 ;; Generate code for declarations in macro definitions.
2307 ;; Remove declarations from the body of the macro definition.
2309 (dolist (decl (byte-compile-defmacro-declaration form
))
2310 (prin1 decl bytecomp-outbuffer
)))
2312 (let* ((new-one (byte-compile-lambda (nthcdr 2 form
) t
))
2313 (code (byte-compile-byte-code-maker new-one
)))
2314 (if bytecomp-this-one
2315 (setcdr bytecomp-this-one new-one
)
2316 (set bytecomp-this-kind
2317 (cons (cons bytecomp-name new-one
)
2318 (symbol-value bytecomp-this-kind
))))
2319 (if (and (stringp (nth 3 form
))
2320 (eq 'quote
(car-safe code
))
2321 (eq 'lambda
(car-safe (nth 1 code
))))
2323 (cons bytecomp-name
(cdr (nth 1 code
))))
2324 (byte-compile-flush-pending)
2325 (if (not (stringp (nth 3 form
)))
2326 ;; No doc string. Provide -1 as the "doc string index"
2327 ;; so that no element will be treated as a doc string.
2328 (byte-compile-output-docform
2332 (if macrop
'(" '(macro . #[" -
1 "])") '(" #[" -
1 "]")))
2333 ((eq (car code
) 'quote
)
2335 (if macrop
'(" '(macro " -
1 ")") '(" '(" -
1 ")")))
2336 ((if macrop
'(" (cons 'macro (" -
1 "))") '(" (" -
1 ")"))))
2338 (and (atom code
) byte-compile-dynamic
2341 ;; Output the form by hand, that's much simpler than having
2342 ;; b-c-output-file-form analyze the defalias.
2343 (byte-compile-output-docform
2347 (if macrop
'(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2348 ((eq (car code
) 'quote
)
2350 (if macrop
'(" '(macro " 2 ")") '(" '(" 2 ")")))
2351 ((if macrop
'(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2353 (and (atom code
) byte-compile-dynamic
2356 (princ ")" bytecomp-outbuffer
)
2359 ;; Print Lisp object EXP in the output file, inside a comment,
2360 ;; and return the file position it will have.
2361 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2362 (defun byte-compile-output-as-comment (exp quoted
)
2363 (let ((position (point)))
2364 (with-current-buffer bytecomp-outbuffer
2366 ;; Insert EXP, and make it a comment with #@LENGTH.
2369 (prin1 exp bytecomp-outbuffer
)
2370 (princ exp bytecomp-outbuffer
))
2371 (goto-char position
)
2372 ;; Quote certain special characters as needed.
2373 ;; get_doc_string in doc.c does the unquoting.
2374 (while (search-forward "\^A" nil t
)
2375 (replace-match "\^A\^A" t t
))
2376 (goto-char position
)
2377 (while (search-forward "\000" nil t
)
2378 (replace-match "\^A0" t t
))
2379 (goto-char position
)
2380 (while (search-forward "\037" nil t
)
2381 (replace-match "\^A_" t t
))
2382 (goto-char (point-max))
2384 (goto-char position
)
2385 (insert "#@" (format "%d" (- (position-bytes (point-max))
2386 (position-bytes position
))))
2388 ;; Save the file position of the object.
2389 ;; Note we should add 1 to skip the space
2390 ;; that we inserted before the actual doc string,
2391 ;; and subtract 1 to convert from an 1-origin Emacs position
2392 ;; to a file position; they cancel.
2393 (setq position
(point))
2394 (goto-char (point-max)))
2400 (defun byte-compile (form)
2401 "If FORM is a symbol, byte-compile its function definition.
2402 If FORM is a lambda or a macro, byte-compile it as a function."
2403 (displaying-byte-compile-warnings
2404 (byte-compile-close-variables
2405 (let* ((fun (if (symbolp form
)
2406 (and (fboundp form
) (symbol-function form
))
2408 (macro (eq (car-safe fun
) 'macro
)))
2410 (setq fun
(cdr fun
)))
2411 (cond ((eq (car-safe fun
) 'lambda
)
2413 (cons 'macro
(byte-compile-lambda fun
))
2414 (byte-compile-lambda fun
)))
2419 (defun byte-compile-sexp (sexp)
2420 "Compile and return SEXP."
2421 (displaying-byte-compile-warnings
2422 (byte-compile-close-variables
2423 (byte-compile-top-level sexp
))))
2425 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2426 (defun byte-compile-byte-code-maker (fun)
2428 ;; ## atom is faster than compiled-func-p.
2429 ((atom fun
) ; compiled function.
2430 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2431 ;; would have produced a lambda.
2433 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2434 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2436 (if (and (setq tmp
(assq 'byte-code
(cdr-safe (cdr fun
))))
2437 (null (cdr (memq tmp fun
))))
2438 ;; Generate a make-byte-code call.
2439 (let* ((interactive (assq 'interactive
(cdr (cdr fun
)))))
2440 (nconc (list 'make-byte-code
2441 (list 'quote
(nth 1 fun
)) ;arglist
2445 (cond ((stringp (nth 2 fun
))
2446 (list (nth 2 fun
))) ;doc
2450 (list (if (or (null (nth 1 interactive
))
2451 (stringp (nth 1 interactive
)))
2453 ;; Interactive spec is a list or a variable
2454 ;; (if it is correct).
2455 (list 'quote
(nth 1 interactive
))))))))
2456 ;; a non-compiled function (probably trivial)
2457 (list 'quote fun
))))))
2459 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2460 (defun byte-compile-byte-code-unmake (function)
2461 (if (consp function
)
2462 function
;;It already is a lambda.
2463 (setq function
(append function nil
)) ; turn it into a list
2464 (nconc (list 'lambda
(nth 0 function
))
2465 (and (nth 4 function
) (list (nth 4 function
)))
2466 (if (nthcdr 5 function
)
2467 (list (cons 'interactive
(if (nth 5 function
)
2468 (nthcdr 5 function
)))))
2469 (list (list 'byte-code
2470 (nth 1 function
) (nth 2 function
)
2471 (nth 3 function
))))))
2474 (defun byte-compile-check-lambda-list (list)
2475 "Check lambda-list LIST for errors."
2478 (let ((arg (car list
)))
2480 (byte-compile-set-symbol-position arg
))
2481 (cond ((or (not (symbolp arg
))
2482 (byte-compile-const-symbol-p arg t
))
2483 (error "Invalid lambda variable %s" arg
))
2486 (error "&rest without variable name"))
2488 (error "Garbage following &rest VAR in lambda-list")))
2489 ((eq arg
'&optional
)
2491 (error "Variable name missing after &optional")))
2493 (byte-compile-warn "repeated variable %s in lambda-list" arg
))
2496 (setq list
(cdr list
)))))
2499 ;; Byte-compile a lambda-expression and return a valid function.
2500 ;; The value is usually a compiled function but may be the original
2501 ;; lambda-expression.
2502 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2503 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2504 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2505 ;; for symbols generated by the byte compiler itself.
2506 (defun byte-compile-lambda (bytecomp-fun &optional add-lambda
)
2508 (setq bytecomp-fun
(cons 'lambda bytecomp-fun
))
2509 (unless (eq 'lambda
(car-safe bytecomp-fun
))
2510 (error "Not a lambda list: %S" bytecomp-fun
))
2511 (byte-compile-set-symbol-position 'lambda
))
2512 (byte-compile-check-lambda-list (nth 1 bytecomp-fun
))
2513 (let* ((bytecomp-arglist (nth 1 bytecomp-fun
))
2514 (byte-compile-bound-variables
2515 (nconc (and (byte-compile-warning-enabled-p 'free-vars
)
2517 (delq '&optional
(copy-sequence bytecomp-arglist
))))
2518 byte-compile-bound-variables
))
2519 (bytecomp-body (cdr (cdr bytecomp-fun
)))
2520 (bytecomp-doc (if (stringp (car bytecomp-body
))
2521 (prog1 (car bytecomp-body
)
2522 ;; Discard the doc string
2523 ;; unless it is the last element of the body.
2524 (if (cdr bytecomp-body
)
2525 (setq bytecomp-body
(cdr bytecomp-body
))))))
2526 (bytecomp-int (assq 'interactive bytecomp-body
)))
2527 ;; Process the interactive spec.
2529 (byte-compile-set-symbol-position 'interactive
)
2530 ;; Skip (interactive) if it is in front (the most usual location).
2531 (if (eq bytecomp-int
(car bytecomp-body
))
2532 (setq bytecomp-body
(cdr bytecomp-body
)))
2533 (cond ((consp (cdr bytecomp-int
))
2534 (if (cdr (cdr bytecomp-int
))
2535 (byte-compile-warn "malformed interactive spec: %s"
2536 (prin1-to-string bytecomp-int
)))
2537 ;; If the interactive spec is a call to `list', don't
2538 ;; compile it, because `call-interactively' looks at the
2539 ;; args of `list'. Actually, compile it to get warnings,
2540 ;; but don't use the result.
2541 (let ((form (nth 1 bytecomp-int
)))
2542 (while (memq (car-safe form
) '(let let
* progn save-excursion
))
2543 (while (consp (cdr form
))
2544 (setq form
(cdr form
)))
2545 (setq form
(car form
)))
2546 (if (eq (car-safe form
) 'list
)
2547 (byte-compile-top-level (nth 1 bytecomp-int
))
2548 (setq bytecomp-int
(list 'interactive
2549 (byte-compile-top-level
2550 (nth 1 bytecomp-int
)))))))
2552 (byte-compile-warn "malformed interactive spec: %s"
2553 (prin1-to-string bytecomp-int
)))))
2554 ;; Process the body.
2555 (let ((compiled (byte-compile-top-level
2556 (cons 'progn bytecomp-body
) nil
'lambda
)))
2557 ;; Build the actual byte-coded function.
2558 (if (eq 'byte-code
(car-safe compiled
))
2559 (apply 'make-byte-code
2560 (append (list bytecomp-arglist
)
2561 ;; byte-string, constants-vector, stack depth
2563 ;; optionally, the doc string.
2564 (if (or bytecomp-doc bytecomp-int
)
2565 (list bytecomp-doc
))
2566 ;; optionally, the interactive spec.
2568 (list (nth 1 bytecomp-int
)))))
2570 (nconc (if bytecomp-int
(list bytecomp-int
))
2571 (cond ((eq (car-safe compiled
) 'progn
) (cdr compiled
))
2572 (compiled (list compiled
)))))
2573 (nconc (list 'lambda bytecomp-arglist
)
2574 (if (or bytecomp-doc
(stringp (car compiled
)))
2575 (cons bytecomp-doc
(cond (compiled)
2576 (bytecomp-body (list nil
))))
2579 (defun byte-compile-constants-vector ()
2580 ;; Builds the constants-vector from the current variables and constants.
2581 ;; This modifies the constants from (const . nil) to (const . offset).
2582 ;; To keep the byte-codes to look up the vector as short as possible:
2583 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2584 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2585 ;; Next variables again, to get 2-byte codes for variable lookup.
2586 ;; The rest of the constants and variables need 3-byte byte-codes.
2588 (rest (nreverse byte-compile-variables
)) ; nreverse because the first
2589 (other (nreverse byte-compile-constants
)) ; vars often are used most.
2591 (limits '(5 ; Use the 1-byte varref codes,
2592 63 ; 1-constlim ; 1-byte byte-constant codes,
2593 255 ; 2-byte varref codes,
2594 65535)) ; 3-byte codes for the rest.
2596 (while (or rest other
)
2597 (setq limit
(car limits
))
2598 (while (and rest
(not (eq i limit
)))
2599 (if (setq tmp
(assq (car (car rest
)) ret
))
2600 (setcdr (car rest
) (cdr tmp
))
2601 (setcdr (car rest
) (setq i
(1+ i
)))
2602 (setq ret
(cons (car rest
) ret
)))
2603 (setq rest
(cdr rest
)))
2604 (setq limits
(cdr limits
)
2606 (setq other rest
))))
2607 (apply 'vector
(nreverse (mapcar 'car ret
)))))
2609 ;; Given an expression FORM, compile it and return an equivalent byte-code
2610 ;; expression (a call to the function byte-code).
2611 (defun byte-compile-top-level (form &optional for-effect output-type
)
2612 ;; OUTPUT-TYPE advises about how form is expected to be used:
2613 ;; 'eval or nil -> a single form,
2614 ;; 'progn or t -> a list of forms,
2615 ;; 'lambda -> body of a lambda,
2616 ;; 'file -> used at file-level.
2617 (let ((byte-compile-constants nil
)
2618 (byte-compile-variables nil
)
2619 (byte-compile-tag-number 0)
2620 (byte-compile-depth 0)
2621 (byte-compile-maxdepth 0)
2622 (byte-compile-output nil
))
2623 (if (memq byte-optimize
'(t source
))
2624 (setq form
(byte-optimize-form form for-effect
)))
2625 (while (and (eq (car-safe form
) 'progn
) (null (cdr (cdr form
))))
2626 (setq form
(nth 1 form
)))
2627 (if (and (eq 'byte-code
(car-safe form
))
2628 (not (memq byte-optimize
'(t byte
)))
2629 (stringp (nth 1 form
)) (vectorp (nth 2 form
))
2630 (natnump (nth 3 form
)))
2632 (byte-compile-form form for-effect
)
2633 (byte-compile-out-toplevel for-effect output-type
))))
2635 (defun byte-compile-out-toplevel (&optional for-effect output-type
)
2637 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2638 (if (eq (car (car byte-compile-output
)) 'byte-discard
)
2639 (setq byte-compile-output
(cdr byte-compile-output
))
2640 (byte-compile-push-constant
2641 ;; Push any constant - preferably one which already is used, and
2642 ;; a number or symbol - ie not some big sequence. The return value
2643 ;; isn't returned, but it would be a shame if some textually large
2644 ;; constant was not optimized away because we chose to return it.
2645 (and (not (assq nil byte-compile-constants
)) ; Nil is often there.
2646 (let ((tmp (reverse byte-compile-constants
)))
2647 (while (and tmp
(not (or (symbolp (caar tmp
))
2648 (numberp (caar tmp
)))))
2649 (setq tmp
(cdr tmp
)))
2651 (byte-compile-out 'byte-return
0)
2652 (setq byte-compile-output
(nreverse byte-compile-output
))
2653 (if (memq byte-optimize
'(t byte
))
2654 (setq byte-compile-output
2655 (byte-optimize-lapcode byte-compile-output for-effect
)))
2657 ;; Decompile trivial functions:
2658 ;; only constants and variables, or a single funcall except in lambdas.
2659 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2660 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2661 ;; Note that even (quote foo) must be parsed just as any subr by the
2662 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2663 ;; What to leave uncompiled:
2664 ;; lambda -> never. we used to leave it uncompiled if the body was
2665 ;; a single atom, but that causes confusion if the docstring
2666 ;; uses the (file . pos) syntax. Besides, now that we have
2667 ;; the Lisp_Compiled type, the compiled form is faster.
2668 ;; eval -> atom, quote or (function atom atom atom)
2669 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2670 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2672 (maycall (not (eq output-type
'lambda
))) ; t if we may make a funcall.
2675 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2676 ((or (eq output-type
'lambda
)
2677 (nthcdr (if (eq output-type
'file
) 50 8) byte-compile-output
)
2678 (assq 'TAG byte-compile-output
) ; Not necessary, but speeds up a bit.
2679 (not (setq tmp
(assq 'byte-return byte-compile-output
)))
2681 (setq rest
(nreverse
2682 (cdr (memq tmp
(reverse byte-compile-output
)))))
2684 ((memq (car (car rest
)) '(byte-varref byte-constant
))
2685 (setq tmp
(car (cdr (car rest
))))
2686 (if (if (eq (car (car rest
)) 'byte-constant
)
2689 (not (byte-compile-const-symbol-p tmp
)))))
2691 (setq body
(cons (list 'quote tmp
) body
)))
2692 (setq body
(cons tmp body
))))
2694 ;; Allow a funcall if at most one atom follows it.
2695 (null (nthcdr 3 rest
))
2696 (setq tmp
(get (car (car rest
)) 'byte-opcode-invert
))
2697 (or (null (cdr rest
))
2698 (and (memq output-type
'(file progn t
))
2700 (eq (car (nth 1 rest
)) 'byte-discard
)
2701 (progn (setq rest
(cdr rest
)) t
))))
2702 (setq maycall nil
) ; Only allow one real function call.
2703 (setq body
(nreverse body
))
2705 (if (and (eq tmp
'funcall
)
2706 (eq (car-safe (car body
)) 'quote
))
2707 (cons (nth 1 (car body
)) (cdr body
))
2709 (or (eq output-type
'file
)
2710 (not (delq nil
(mapcar 'consp
(cdr (car body
))))))))
2711 (setq rest
(cdr rest
)))
2713 (let ((byte-compile-vector (byte-compile-constants-vector)))
2714 (list 'byte-code
(byte-compile-lapcode byte-compile-output
)
2715 byte-compile-vector byte-compile-maxdepth
)))
2716 ;; it's a trivial function
2717 ((cdr body
) (cons 'progn
(nreverse body
)))
2720 ;; Given BYTECOMP-BODY, compile it and return a new body.
2721 (defun byte-compile-top-level-body (bytecomp-body &optional for-effect
)
2723 (byte-compile-top-level (cons 'progn bytecomp-body
) for-effect t
))
2724 (cond ((eq (car-safe bytecomp-body
) 'progn
)
2725 (cdr bytecomp-body
))
2727 (list bytecomp-body
))))
2729 (put 'declare-function
'byte-hunk-handler
'byte-compile-declare-function
)
2730 (defun byte-compile-declare-function (form)
2731 (push (cons (nth 1 form
)
2732 (if (and (> (length form
) 3)
2733 (listp (nth 3 form
)))
2734 (list 'declared
(nth 3 form
))
2735 t
)) ; arglist not specified
2736 byte-compile-function-environment
)
2737 ;; We are stating that it _will_ be defined at runtime.
2738 (setq byte-compile-noruntime-functions
2739 (delq (nth 1 form
) byte-compile-noruntime-functions
))
2743 ;; This is the recursive entry point for compiling each subform of an
2745 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2746 ;; before terminating (ie no value will be left on the stack).
2747 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2748 ;; which does not leave a value on the stack, and then set for-effect to nil
2749 ;; (to prevent byte-compile-form from outputting the byte-discard).
2750 ;; If a handler wants to call another handler, it should do so via
2751 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2752 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2754 (defun byte-compile-form (form &optional for-effect
)
2755 (setq form
(macroexpand form byte-compile-macro-environment
))
2756 (cond ((not (consp form
))
2757 (cond ((or (not (symbolp form
)) (byte-compile-const-symbol-p form
))
2758 (when (symbolp form
)
2759 (byte-compile-set-symbol-position form
))
2760 (byte-compile-constant form
))
2761 ((and for-effect byte-compile-delete-errors
)
2762 (when (symbolp form
)
2763 (byte-compile-set-symbol-position form
))
2764 (setq for-effect nil
))
2765 (t (byte-compile-variable-ref 'byte-varref form
))))
2766 ((symbolp (car form
))
2767 (let* ((bytecomp-fn (car form
))
2768 (bytecomp-handler (get bytecomp-fn
'byte-compile
)))
2769 (when (byte-compile-const-symbol-p bytecomp-fn
)
2770 (byte-compile-warn "`%s' called as a function" bytecomp-fn
))
2771 (and (byte-compile-warning-enabled-p 'interactive-only
)
2772 (memq bytecomp-fn byte-compile-interactive-only-functions
)
2773 (byte-compile-warn "`%s' used from Lisp code\n\
2774 That command is designed for interactive use only" bytecomp-fn
))
2775 (when (byte-compile-warning-enabled-p 'callargs
)
2776 (if (memq bytecomp-fn
2777 '(custom-declare-group custom-declare-variable
2778 custom-declare-face
))
2779 (byte-compile-nogroup-warn form
))
2780 (byte-compile-callargs-warn form
))
2781 (if (and bytecomp-handler
2782 ;; Make sure that function exists. This is important
2783 ;; for CL compiler macros since the symbol may be
2784 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2785 ;; loaded, this function doesn't exist.
2786 (or (not (memq bytecomp-handler
2787 '(cl-byte-compile-compiler-macro)))
2788 (functionp bytecomp-handler
)))
2789 (funcall bytecomp-handler form
)
2790 (byte-compile-normal-call form
))
2791 (if (byte-compile-warning-enabled-p 'cl-functions
)
2792 (byte-compile-cl-warn form
))))
2793 ((and (or (byte-code-function-p (car form
))
2794 (eq (car-safe (car form
)) 'lambda
))
2795 ;; if the form comes out the same way it went in, that's
2796 ;; because it was malformed, and we couldn't unfold it.
2797 (not (eq form
(setq form
(byte-compile-unfold-lambda form
)))))
2798 (byte-compile-form form for-effect
)
2799 (setq for-effect nil
))
2800 ((byte-compile-normal-call form
)))
2802 (byte-compile-discard)))
2804 (defun byte-compile-normal-call (form)
2805 (if byte-compile-generate-call-tree
2806 (byte-compile-annotate-call-tree form
))
2807 (when (and for-effect
(eq (car form
) 'mapcar
)
2808 (byte-compile-warning-enabled-p 'mapcar
))
2809 (byte-compile-set-symbol-position 'mapcar
)
2811 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
2812 (byte-compile-push-constant (car form
))
2813 (mapc 'byte-compile-form
(cdr form
)) ; wasteful, but faster.
2814 (byte-compile-out 'byte-call
(length (cdr form
))))
2816 (defun byte-compile-variable-ref (base-op bytecomp-var
)
2817 (when (symbolp bytecomp-var
)
2818 (byte-compile-set-symbol-position bytecomp-var
))
2819 (if (or (not (symbolp bytecomp-var
))
2820 (byte-compile-const-symbol-p bytecomp-var
2821 (not (eq base-op
'byte-varref
))))
2822 (if (byte-compile-warning-enabled-p 'constants
)
2824 (cond ((eq base-op
'byte-varbind
) "attempt to let-bind %s `%s'")
2825 ((eq base-op
'byte-varset
) "variable assignment to %s `%s'")
2826 (t "variable reference to %s `%s'"))
2827 (if (symbolp bytecomp-var
) "constant" "nonvariable")
2828 (prin1-to-string bytecomp-var
)))
2829 (and (get bytecomp-var
'byte-obsolete-variable
)
2830 (not (memq bytecomp-var byte-compile-not-obsolete-vars
))
2831 (byte-compile-warn-obsolete bytecomp-var
))
2832 (if (eq base-op
'byte-varbind
)
2833 (push bytecomp-var byte-compile-bound-variables
)
2834 (or (not (byte-compile-warning-enabled-p 'free-vars
))
2835 (boundp bytecomp-var
)
2836 (memq bytecomp-var byte-compile-bound-variables
)
2837 (if (eq base-op
'byte-varset
)
2838 (or (memq bytecomp-var byte-compile-free-assignments
)
2840 (byte-compile-warn "assignment to free variable `%s'"
2842 (push bytecomp-var byte-compile-free-assignments
)))
2843 (or (memq bytecomp-var byte-compile-free-references
)
2845 (byte-compile-warn "reference to free variable `%s'"
2847 (push bytecomp-var byte-compile-free-references
)))))))
2848 (let ((tmp (assq bytecomp-var byte-compile-variables
)))
2850 (setq tmp
(list bytecomp-var
))
2851 (push tmp byte-compile-variables
))
2852 (byte-compile-out base-op tmp
)))
2854 (defmacro byte-compile-get-constant
(const)
2855 `(or (if (stringp ,const
)
2856 ;; In a string constant, treat properties as significant.
2858 (dolist (elt byte-compile-constants
)
2859 (if (equal-including-properties (car elt
) ,const
)
2862 (assq ,const byte-compile-constants
))
2863 (car (setq byte-compile-constants
2864 (cons (list ,const
) byte-compile-constants
)))))
2866 ;; Use this when the value of a form is a constant. This obeys for-effect.
2867 (defun byte-compile-constant (const)
2869 (setq for-effect nil
)
2870 (when (symbolp const
)
2871 (byte-compile-set-symbol-position const
))
2872 (byte-compile-out 'byte-constant
(byte-compile-get-constant const
))))
2874 ;; Use this for a constant that is not the value of its containing form.
2875 ;; This ignores for-effect.
2876 (defun byte-compile-push-constant (const)
2877 (let ((for-effect nil
))
2878 (inline (byte-compile-constant const
))))
2881 ;; Compile those primitive ordinary functions
2882 ;; which have special byte codes just for speed.
2884 (defmacro byte-defop-compiler
(function &optional compile-handler
)
2885 "Add a compiler-form for FUNCTION.
2886 If function is a symbol, then the variable \"byte-SYMBOL\" must name
2887 the opcode to be used. If function is a list, the first element
2888 is the function and the second element is the bytecode-symbol.
2889 The second element may be nil, meaning there is no opcode.
2890 COMPILE-HANDLER is the function to use to compile this byte-op, or
2891 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2892 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
2894 (if (symbolp function
)
2895 (setq opcode
(intern (concat "byte-" (symbol-name function
))))
2896 (setq opcode
(car (cdr function
))
2897 function
(car function
)))
2899 (list 'put
(list 'quote function
) ''byte-compile
2901 (or (cdr (assq compile-handler
2902 '((0 . byte-compile-no-args
)
2903 (1 . byte-compile-one-arg
)
2904 (2 . byte-compile-two-args
)
2905 (3 . byte-compile-three-args
)
2906 (0-1 . byte-compile-zero-or-one-arg
)
2907 (1-2 . byte-compile-one-or-two-args
)
2908 (2-3 . byte-compile-two-or-three-args
)
2911 (intern (concat "byte-compile-"
2912 (symbol-name function
))))))))
2915 (list 'put
(list 'quote function
)
2916 ''byte-opcode
(list 'quote opcode
))
2917 (list 'put
(list 'quote opcode
)
2918 ''byte-opcode-invert
(list 'quote function
)))
2921 (defmacro byte-defop-compiler-1
(function &optional compile-handler
)
2922 (list 'byte-defop-compiler
(list function nil
) compile-handler
))
2925 (put 'byte-call
'byte-opcode-invert
'funcall
)
2926 (put 'byte-list1
'byte-opcode-invert
'list
)
2927 (put 'byte-list2
'byte-opcode-invert
'list
)
2928 (put 'byte-list3
'byte-opcode-invert
'list
)
2929 (put 'byte-list4
'byte-opcode-invert
'list
)
2930 (put 'byte-listN
'byte-opcode-invert
'list
)
2931 (put 'byte-concat2
'byte-opcode-invert
'concat
)
2932 (put 'byte-concat3
'byte-opcode-invert
'concat
)
2933 (put 'byte-concat4
'byte-opcode-invert
'concat
)
2934 (put 'byte-concatN
'byte-opcode-invert
'concat
)
2935 (put 'byte-insertN
'byte-opcode-invert
'insert
)
2937 (byte-defop-compiler point
0)
2938 ;;(byte-defop-compiler mark 0) ;; obsolete
2939 (byte-defop-compiler point-max
0)
2940 (byte-defop-compiler point-min
0)
2941 (byte-defop-compiler following-char
0)
2942 (byte-defop-compiler preceding-char
0)
2943 (byte-defop-compiler current-column
0)
2944 (byte-defop-compiler eolp
0)
2945 (byte-defop-compiler eobp
0)
2946 (byte-defop-compiler bolp
0)
2947 (byte-defop-compiler bobp
0)
2948 (byte-defop-compiler current-buffer
0)
2949 ;;(byte-defop-compiler read-char 0) ;; obsolete
2950 (byte-defop-compiler interactive-p
0)
2951 (byte-defop-compiler widen
0)
2952 (byte-defop-compiler end-of-line
0-
1)
2953 (byte-defop-compiler forward-char
0-
1)
2954 (byte-defop-compiler forward-line
0-
1)
2955 (byte-defop-compiler symbolp
1)
2956 (byte-defop-compiler consp
1)
2957 (byte-defop-compiler stringp
1)
2958 (byte-defop-compiler listp
1)
2959 (byte-defop-compiler not
1)
2960 (byte-defop-compiler (null byte-not
) 1)
2961 (byte-defop-compiler car
1)
2962 (byte-defop-compiler cdr
1)
2963 (byte-defop-compiler length
1)
2964 (byte-defop-compiler symbol-value
1)
2965 (byte-defop-compiler symbol-function
1)
2966 (byte-defop-compiler (1+ byte-add1
) 1)
2967 (byte-defop-compiler (1- byte-sub1
) 1)
2968 (byte-defop-compiler goto-char
1)
2969 (byte-defop-compiler char-after
0-
1)
2970 (byte-defop-compiler set-buffer
1)
2971 ;;(byte-defop-compiler set-mark 1) ;; obsolete
2972 (byte-defop-compiler forward-word
0-
1)
2973 (byte-defop-compiler char-syntax
1)
2974 (byte-defop-compiler nreverse
1)
2975 (byte-defop-compiler car-safe
1)
2976 (byte-defop-compiler cdr-safe
1)
2977 (byte-defop-compiler numberp
1)
2978 (byte-defop-compiler integerp
1)
2979 (byte-defop-compiler skip-chars-forward
1-
2)
2980 (byte-defop-compiler skip-chars-backward
1-
2)
2981 (byte-defop-compiler eq
2)
2982 (byte-defop-compiler memq
2)
2983 (byte-defop-compiler cons
2)
2984 (byte-defop-compiler aref
2)
2985 (byte-defop-compiler set
2)
2986 (byte-defop-compiler (= byte-eqlsign
) 2)
2987 (byte-defop-compiler (< byte-lss
) 2)
2988 (byte-defop-compiler (> byte-gtr
) 2)
2989 (byte-defop-compiler (<= byte-leq
) 2)
2990 (byte-defop-compiler (>= byte-geq
) 2)
2991 (byte-defop-compiler get
2)
2992 (byte-defop-compiler nth
2)
2993 (byte-defop-compiler substring
2-
3)
2994 (byte-defop-compiler (move-marker byte-set-marker
) 2-
3)
2995 (byte-defop-compiler set-marker
2-
3)
2996 (byte-defop-compiler match-beginning
1)
2997 (byte-defop-compiler match-end
1)
2998 (byte-defop-compiler upcase
1)
2999 (byte-defop-compiler downcase
1)
3000 (byte-defop-compiler string
= 2)
3001 (byte-defop-compiler string
< 2)
3002 (byte-defop-compiler (string-equal byte-string
=) 2)
3003 (byte-defop-compiler (string-lessp byte-string
<) 2)
3004 (byte-defop-compiler equal
2)
3005 (byte-defop-compiler nthcdr
2)
3006 (byte-defop-compiler elt
2)
3007 (byte-defop-compiler member
2)
3008 (byte-defop-compiler assq
2)
3009 (byte-defop-compiler (rplaca byte-setcar
) 2)
3010 (byte-defop-compiler (rplacd byte-setcdr
) 2)
3011 (byte-defop-compiler setcar
2)
3012 (byte-defop-compiler setcdr
2)
3013 (byte-defop-compiler buffer-substring
2)
3014 (byte-defop-compiler delete-region
2)
3015 (byte-defop-compiler narrow-to-region
2)
3016 (byte-defop-compiler (% byte-rem
) 2)
3017 (byte-defop-compiler aset
3)
3019 (byte-defop-compiler max byte-compile-associative
)
3020 (byte-defop-compiler min byte-compile-associative
)
3021 (byte-defop-compiler (+ byte-plus
) byte-compile-associative
)
3022 (byte-defop-compiler (* byte-mult
) byte-compile-associative
)
3024 ;;####(byte-defop-compiler move-to-column 1)
3025 (byte-defop-compiler-1 interactive byte-compile-noop
)
3028 (defun byte-compile-subr-wrong-args (form n
)
3029 (byte-compile-set-symbol-position (car form
))
3030 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3031 (car form
) (length (cdr form
))
3032 (if (= 1 (length (cdr form
))) "" "s") n
)
3033 ;; get run-time wrong-number-of-args error.
3034 (byte-compile-normal-call form
))
3036 (defun byte-compile-no-args (form)
3037 (if (not (= (length form
) 1))
3038 (byte-compile-subr-wrong-args form
"none")
3039 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3041 (defun byte-compile-one-arg (form)
3042 (if (not (= (length form
) 2))
3043 (byte-compile-subr-wrong-args form
1)
3044 (byte-compile-form (car (cdr form
))) ;; Push the argument
3045 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3047 (defun byte-compile-two-args (form)
3048 (if (not (= (length form
) 3))
3049 (byte-compile-subr-wrong-args form
2)
3050 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3051 (byte-compile-form (nth 2 form
))
3052 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3054 (defun byte-compile-three-args (form)
3055 (if (not (= (length form
) 4))
3056 (byte-compile-subr-wrong-args form
3)
3057 (byte-compile-form (car (cdr form
))) ;; Push the arguments
3058 (byte-compile-form (nth 2 form
))
3059 (byte-compile-form (nth 3 form
))
3060 (byte-compile-out (get (car form
) 'byte-opcode
) 0)))
3062 (defun byte-compile-zero-or-one-arg (form)
3063 (let ((len (length form
)))
3064 (cond ((= len
1) (byte-compile-one-arg (append form
'(nil))))
3065 ((= len
2) (byte-compile-one-arg form
))
3066 (t (byte-compile-subr-wrong-args form
"0-1")))))
3068 (defun byte-compile-one-or-two-args (form)
3069 (let ((len (length form
)))
3070 (cond ((= len
2) (byte-compile-two-args (append form
'(nil))))
3071 ((= len
3) (byte-compile-two-args form
))
3072 (t (byte-compile-subr-wrong-args form
"1-2")))))
3074 (defun byte-compile-two-or-three-args (form)
3075 (let ((len (length form
)))
3076 (cond ((= len
3) (byte-compile-three-args (append form
'(nil))))
3077 ((= len
4) (byte-compile-three-args form
))
3078 (t (byte-compile-subr-wrong-args form
"2-3")))))
3080 (defun byte-compile-noop (form)
3081 (byte-compile-constant nil
))
3083 (defun byte-compile-discard ()
3084 (byte-compile-out 'byte-discard
0))
3087 ;; Compile a function that accepts one or more args and is right-associative.
3088 ;; We do it by left-associativity so that the operations
3089 ;; are done in the same order as in interpreted code.
3090 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3091 ;; in order to convert markers to numbers, and trigger expected errors.
3092 (defun byte-compile-associative (form)
3094 (let ((opcode (get (car form
) 'byte-opcode
))
3096 (if (and (< 3 (length form
))
3097 (memq opcode
(list (get '+ 'byte-opcode
)
3098 (get '* 'byte-opcode
))))
3099 ;; Don't use binary operations for > 2 operands, as that
3100 ;; may cause overflow/truncation in float operations.
3101 (byte-compile-normal-call form
)
3102 (setq args
(copy-sequence (cdr form
)))
3103 (byte-compile-form (car args
))
3104 (setq args
(cdr args
))
3105 (or args
(setq args
'(0)
3106 opcode
(get '+ 'byte-opcode
)))
3108 (byte-compile-form arg
)
3109 (byte-compile-out opcode
0))))
3110 (byte-compile-constant (eval form
))))
3113 ;; more complicated compiler macros
3115 (byte-defop-compiler char-before
)
3116 (byte-defop-compiler backward-char
)
3117 (byte-defop-compiler backward-word
)
3118 (byte-defop-compiler list
)
3119 (byte-defop-compiler concat
)
3120 (byte-defop-compiler fset
)
3121 (byte-defop-compiler (indent-to-column byte-indent-to
) byte-compile-indent-to
)
3122 (byte-defop-compiler indent-to
)
3123 (byte-defop-compiler insert
)
3124 (byte-defop-compiler-1 function byte-compile-function-form
)
3125 (byte-defop-compiler-1 - byte-compile-minus
)
3126 (byte-defop-compiler (/ byte-quo
) byte-compile-quo
)
3127 (byte-defop-compiler nconc
)
3129 (defun byte-compile-char-before (form)
3130 (cond ((= 2 (length form
))
3131 (byte-compile-form (list 'char-after
(if (numberp (nth 1 form
))
3133 `(1- ,(nth 1 form
))))))
3134 ((= 1 (length form
))
3135 (byte-compile-form '(char-after (1- (point)))))
3136 (t (byte-compile-subr-wrong-args form
"0-1"))))
3138 ;; backward-... ==> forward-... with negated argument.
3139 (defun byte-compile-backward-char (form)
3140 (cond ((= 2 (length form
))
3141 (byte-compile-form (list 'forward-char
(if (numberp (nth 1 form
))
3143 `(- ,(nth 1 form
))))))
3144 ((= 1 (length form
))
3145 (byte-compile-form '(forward-char -
1)))
3146 (t (byte-compile-subr-wrong-args form
"0-1"))))
3148 (defun byte-compile-backward-word (form)
3149 (cond ((= 2 (length form
))
3150 (byte-compile-form (list 'forward-word
(if (numberp (nth 1 form
))
3152 `(- ,(nth 1 form
))))))
3153 ((= 1 (length form
))
3154 (byte-compile-form '(forward-word -
1)))
3155 (t (byte-compile-subr-wrong-args form
"0-1"))))
3157 (defun byte-compile-list (form)
3158 (let ((count (length (cdr form
))))
3160 (byte-compile-constant nil
))
3162 (mapc 'byte-compile-form
(cdr form
))
3164 (aref [byte-list1 byte-list2 byte-list3 byte-list4
] (1- count
)) 0))
3166 (mapc 'byte-compile-form
(cdr form
))
3167 (byte-compile-out 'byte-listN count
))
3168 (t (byte-compile-normal-call form
)))))
3170 (defun byte-compile-concat (form)
3171 (let ((count (length (cdr form
))))
3172 (cond ((and (< 1 count
) (< count
5))
3173 (mapc 'byte-compile-form
(cdr form
))
3175 (aref [byte-concat2 byte-concat3 byte-concat4
] (- count
2))
3177 ;; Concat of one arg is not a no-op if arg is not a string.
3179 (byte-compile-form ""))
3181 (mapc 'byte-compile-form
(cdr form
))
3182 (byte-compile-out 'byte-concatN count
))
3183 ((byte-compile-normal-call form
)))))
3185 (defun byte-compile-minus (form)
3186 (let ((len (length form
)))
3188 ((= 1 len
) (byte-compile-constant 0))
3190 (byte-compile-form (cadr form
))
3191 (byte-compile-out 'byte-negate
0))
3193 (byte-compile-form (nth 1 form
))
3194 (byte-compile-form (nth 2 form
))
3195 (byte-compile-out 'byte-diff
0))
3196 ;; Don't use binary operations for > 2 operands, as that may
3197 ;; cause overflow/truncation in float operations.
3198 (t (byte-compile-normal-call form
)))))
3200 (defun byte-compile-quo (form)
3201 (let ((len (length form
)))
3203 (byte-compile-subr-wrong-args form
"2 or more"))
3205 (byte-compile-two-args form
))
3207 ;; Don't use binary operations for > 2 operands, as that
3208 ;; may cause overflow/truncation in float operations.
3209 (byte-compile-normal-call form
)))))
3211 (defun byte-compile-nconc (form)
3212 (let ((len (length form
)))
3214 (byte-compile-constant nil
))
3216 ;; nconc of one arg is a noop, even if that arg isn't a list.
3217 (byte-compile-form (nth 1 form
)))
3219 (byte-compile-form (car (setq form
(cdr form
))))
3220 (while (setq form
(cdr form
))
3221 (byte-compile-form (car form
))
3222 (byte-compile-out 'byte-nconc
0))))))
3224 (defun byte-compile-fset (form)
3225 ;; warn about forms like (fset 'foo '(lambda () ...))
3226 ;; (where the lambda expression is non-trivial...)
3227 (let ((fn (nth 2 form
))
3229 (if (and (eq (car-safe fn
) 'quote
)
3230 (eq (car-safe (setq fn
(nth 1 fn
))) 'lambda
))
3232 (setq body
(cdr (cdr fn
)))
3233 (if (stringp (car body
)) (setq body
(cdr body
)))
3234 (if (eq 'interactive
(car-safe (car body
))) (setq body
(cdr body
)))
3235 (if (and (consp (car body
))
3236 (not (eq 'byte-code
(car (car body
)))))
3238 "A quoted lambda form is the second argument of `fset'. This is probably
3239 not what you want, as that lambda cannot be compiled. Consider using
3240 the syntax (function (lambda (...) ...)) instead.")))))
3241 (byte-compile-two-args form
))
3243 (defun byte-compile-funarg (form)
3244 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3245 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3246 (byte-compile-normal-call
3247 (let ((fn (nth 1 form
)))
3248 (if (and (eq (car-safe fn
) 'quote
)
3249 (eq (car-safe (nth 1 fn
)) 'lambda
))
3251 (cons (cons 'function
(cdr fn
))
3255 (defun byte-compile-funarg-2 (form)
3256 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3257 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3258 (byte-compile-normal-call
3259 (let ((fn (nth 2 form
)))
3260 (if (and (eq (car-safe fn
) 'quote
)
3261 (eq (car-safe (nth 1 fn
)) 'lambda
))
3264 (cons (cons 'function
(cdr fn
))
3265 (cdr (cdr (cdr form
))))))
3268 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3269 ;; Otherwise it will be incompatible with the interpreter,
3270 ;; and (funcall (function foo)) will lose with autoloads.
3272 (defun byte-compile-function-form (form)
3273 (byte-compile-constant
3274 (cond ((symbolp (nth 1 form
))
3276 ((byte-compile-lambda (nth 1 form
))))))
3278 (defun byte-compile-indent-to (form)
3279 (let ((len (length form
)))
3281 (byte-compile-form (car (cdr form
)))
3282 (byte-compile-out 'byte-indent-to
0))
3284 ;; no opcode for 2-arg case.
3285 (byte-compile-normal-call form
))
3287 (byte-compile-subr-wrong-args form
"1-2")))))
3289 (defun byte-compile-insert (form)
3290 (cond ((null (cdr form
))
3291 (byte-compile-constant nil
))
3292 ((<= (length form
) 256)
3293 (mapc 'byte-compile-form
(cdr form
))
3294 (if (cdr (cdr form
))
3295 (byte-compile-out 'byte-insertN
(length (cdr form
)))
3296 (byte-compile-out 'byte-insert
0)))
3297 ((memq t
(mapcar 'consp
(cdr (cdr form
))))
3298 (byte-compile-normal-call form
))
3299 ;; We can split it; there is no function call after inserting 1st arg.
3301 (while (setq form
(cdr form
))
3302 (byte-compile-form (car form
))
3303 (byte-compile-out 'byte-insert
0)
3305 (byte-compile-discard))))))
3308 (byte-defop-compiler-1 setq
)
3309 (byte-defop-compiler-1 setq-default
)
3310 (byte-defop-compiler-1 quote
)
3311 (byte-defop-compiler-1 quote-form
)
3313 (defun byte-compile-setq (form)
3314 (let ((bytecomp-args (cdr form
)))
3316 (while bytecomp-args
3317 (byte-compile-form (car (cdr bytecomp-args
)))
3318 (or for-effect
(cdr (cdr bytecomp-args
))
3319 (byte-compile-out 'byte-dup
0))
3320 (byte-compile-variable-ref 'byte-varset
(car bytecomp-args
))
3321 (setq bytecomp-args
(cdr (cdr bytecomp-args
))))
3322 ;; (setq), with no arguments.
3323 (byte-compile-form nil for-effect
))
3324 (setq for-effect nil
)))
3326 (defun byte-compile-setq-default (form)
3327 (let ((bytecomp-args (cdr form
))
3329 (while bytecomp-args
3330 (let ((var (car bytecomp-args
)))
3331 (and (or (not (symbolp var
))
3332 (byte-compile-const-symbol-p var t
))
3333 (byte-compile-warning-enabled-p 'constants
)
3335 "variable assignment to %s `%s'"
3336 (if (symbolp var
) "constant" "nonvariable")
3337 (prin1-to-string var
)))
3338 (push (list 'set-default
(list 'quote var
) (car (cdr bytecomp-args
)))
3340 (setq bytecomp-args
(cdr (cdr bytecomp-args
))))
3341 (byte-compile-form (cons 'progn
(nreverse setters
)))))
3343 (defun byte-compile-quote (form)
3344 (byte-compile-constant (car (cdr form
))))
3346 (defun byte-compile-quote-form (form)
3347 (byte-compile-constant (byte-compile-top-level (nth 1 form
))))
3350 ;;; control structures
3352 (defun byte-compile-body (bytecomp-body &optional for-effect
)
3353 (while (cdr bytecomp-body
)
3354 (byte-compile-form (car bytecomp-body
) t
)
3355 (setq bytecomp-body
(cdr bytecomp-body
)))
3356 (byte-compile-form (car bytecomp-body
) for-effect
))
3358 (defsubst byte-compile-body-do-effect
(bytecomp-body)
3359 (byte-compile-body bytecomp-body for-effect
)
3360 (setq for-effect nil
))
3362 (defsubst byte-compile-form-do-effect
(form)
3363 (byte-compile-form form for-effect
)
3364 (setq for-effect nil
))
3366 (byte-defop-compiler-1 inline byte-compile-progn
)
3367 (byte-defop-compiler-1 progn
)
3368 (byte-defop-compiler-1 prog1
)
3369 (byte-defop-compiler-1 prog2
)
3370 (byte-defop-compiler-1 if
)
3371 (byte-defop-compiler-1 cond
)
3372 (byte-defop-compiler-1 and
)
3373 (byte-defop-compiler-1 or
)
3374 (byte-defop-compiler-1 while
)
3375 (byte-defop-compiler-1 funcall
)
3376 (byte-defop-compiler-1 apply byte-compile-funarg
)
3377 (byte-defop-compiler-1 mapcar byte-compile-funarg
)
3378 (byte-defop-compiler-1 mapatoms byte-compile-funarg
)
3379 (byte-defop-compiler-1 mapconcat byte-compile-funarg
)
3380 (byte-defop-compiler-1 mapc byte-compile-funarg
)
3381 (byte-defop-compiler-1 maphash byte-compile-funarg
)
3382 (byte-defop-compiler-1 map-char-table byte-compile-funarg
)
3383 (byte-defop-compiler-1 map-char-table byte-compile-funarg-2
)
3384 ;; map-charset-chars should be funarg but has optional third arg
3385 (byte-defop-compiler-1 sort byte-compile-funarg-2
)
3386 (byte-defop-compiler-1 let
)
3387 (byte-defop-compiler-1 let
*)
3389 (defun byte-compile-progn (form)
3390 (byte-compile-body-do-effect (cdr form
)))
3392 (defun byte-compile-prog1 (form)
3393 (byte-compile-form-do-effect (car (cdr form
)))
3394 (byte-compile-body (cdr (cdr form
)) t
))
3396 (defun byte-compile-prog2 (form)
3397 (byte-compile-form (nth 1 form
) t
)
3398 (byte-compile-form-do-effect (nth 2 form
))
3399 (byte-compile-body (cdr (cdr (cdr form
))) t
))
3401 (defmacro byte-compile-goto-if
(cond discard tag
)
3404 (if ,discard
'byte-goto-if-not-nil
'byte-goto-if-not-nil-else-pop
)
3405 (if ,discard
'byte-goto-if-nil
'byte-goto-if-nil-else-pop
))
3408 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3409 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3410 (defun byte-compile-find-bound-condition (condition-param
3412 &optional only-if-not-present
)
3416 (if (memq (car-safe condition-param
) pred-list
)
3417 ;; The condition appears by itself.
3418 (list condition-param
)
3419 ;; If the condition is an `and', look for matches among the
3421 (when (eq 'and
(car-safe condition-param
))
3422 (cdr condition-param
)))))
3424 (dolist (crt cond-list
)
3425 (when (and (memq (car-safe crt
) pred-list
)
3426 (eq 'quote
(car-safe (setq nth-one
(nth 1 crt
))))
3427 ;; Ignore if the symbol is already on the unresolved
3429 (not (assq (nth 1 nth-one
) ; the relevant symbol
3430 only-if-not-present
)))
3431 (push (nth 1 (nth 1 crt
)) result
)))
3434 (defmacro byte-compile-maybe-guarded
(condition &rest body
)
3435 "Execute forms in BODY, potentially guarded by CONDITION.
3436 CONDITION is a variable whose value is a test in an `if' or `cond'.
3437 BODY is the code to compile in the first arm of the if or the body of
3438 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3439 or (boundp 'foo), the relevant warnings from BODY about foo's
3440 being undefined (or obsolete) will be suppressed.
3442 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3443 that suppresses all warnings during execution of BODY."
3444 (declare (indent 1) (debug t
))
3445 `(let* ((fbound-list (byte-compile-find-bound-condition
3446 ,condition
(list 'fboundp
)
3447 byte-compile-unresolved-functions
))
3448 (bound-list (byte-compile-find-bound-condition
3449 ,condition
(list 'boundp
'default-boundp
)))
3450 ;; Maybe add to the bound list.
3451 (byte-compile-bound-variables
3453 (append bound-list byte-compile-bound-variables
)
3454 byte-compile-bound-variables
)))
3456 ;; If things not being bound at all is ok, so must them being obsolete.
3457 ;; Note that we add to the existing lists since Tramp (ab)uses
3459 (let ((byte-compile-not-obsolete-vars
3460 (append byte-compile-not-obsolete-vars bound-list
))
3461 (byte-compile-not-obsolete-funcs
3462 (append byte-compile-not-obsolete-funcs fbound-list
)))
3464 ;; Maybe remove the function symbol from the unresolved list.
3465 (dolist (fbound fbound-list
)
3467 (setq byte-compile-unresolved-functions
3468 (delq (assq fbound byte-compile-unresolved-functions
)
3469 byte-compile-unresolved-functions
)))))))
3471 (defun byte-compile-if (form)
3472 (byte-compile-form (car (cdr form
)))
3473 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3474 ;; and avoid warnings about the relevent symbols in the consequent.
3475 (let ((clause (nth 1 form
))
3476 (donetag (byte-compile-make-tag)))
3477 (if (null (nthcdr 3 form
))
3480 (byte-compile-goto-if nil for-effect donetag
)
3481 (byte-compile-maybe-guarded clause
3482 (byte-compile-form (nth 2 form
) for-effect
))
3483 (byte-compile-out-tag donetag
))
3484 (let ((elsetag (byte-compile-make-tag)))
3485 (byte-compile-goto 'byte-goto-if-nil elsetag
)
3486 (byte-compile-maybe-guarded clause
3487 (byte-compile-form (nth 2 form
) for-effect
))
3488 (byte-compile-goto 'byte-goto donetag
)
3489 (byte-compile-out-tag elsetag
)
3490 (byte-compile-maybe-guarded (list 'not clause
)
3491 (byte-compile-body (cdr (cdr (cdr form
))) for-effect
))
3492 (byte-compile-out-tag donetag
))))
3493 (setq for-effect nil
))
3495 (defun byte-compile-cond (clauses)
3496 (let ((donetag (byte-compile-make-tag))
3498 (while (setq clauses
(cdr clauses
))
3499 (setq clause
(car clauses
))
3500 (cond ((or (eq (car clause
) t
)
3501 (and (eq (car-safe (car clause
)) 'quote
)
3502 (car-safe (cdr-safe (car clause
)))))
3503 ;; Unconditional clause
3504 (setq clause
(cons t clause
)
3507 (byte-compile-form (car clause
))
3508 (if (null (cdr clause
))
3509 ;; First clause is a singleton.
3510 (byte-compile-goto-if t for-effect donetag
)
3511 (setq nexttag
(byte-compile-make-tag))
3512 (byte-compile-goto 'byte-goto-if-nil nexttag
)
3513 (byte-compile-maybe-guarded (car clause
)
3514 (byte-compile-body (cdr clause
) for-effect
))
3515 (byte-compile-goto 'byte-goto donetag
)
3516 (byte-compile-out-tag nexttag
)))))
3518 (let ((guard (car clause
)))
3519 (and (cdr clause
) (not (eq guard t
))
3520 (progn (byte-compile-form guard
)
3521 (byte-compile-goto-if nil for-effect donetag
)
3522 (setq clause
(cdr clause
))))
3523 (byte-compile-maybe-guarded guard
3524 (byte-compile-body-do-effect clause
)))
3525 (byte-compile-out-tag donetag
)))
3527 (defun byte-compile-and (form)
3528 (let ((failtag (byte-compile-make-tag))
3529 (bytecomp-args (cdr form
)))
3530 (if (null bytecomp-args
)
3531 (byte-compile-form-do-effect t
)
3532 (byte-compile-and-recursion bytecomp-args failtag
))))
3534 ;; Handle compilation of a nontrivial `and' call.
3535 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3536 (defun byte-compile-and-recursion (rest failtag
)
3539 (byte-compile-form (car rest
))
3540 (byte-compile-goto-if nil for-effect failtag
)
3541 (byte-compile-maybe-guarded (car rest
)
3542 (byte-compile-and-recursion (cdr rest
) failtag
)))
3543 (byte-compile-form-do-effect (car rest
))
3544 (byte-compile-out-tag failtag
)))
3546 (defun byte-compile-or (form)
3547 (let ((wintag (byte-compile-make-tag))
3548 (bytecomp-args (cdr form
)))
3549 (if (null bytecomp-args
)
3550 (byte-compile-form-do-effect nil
)
3551 (byte-compile-or-recursion bytecomp-args wintag
))))
3553 ;; Handle compilation of a nontrivial `or' call.
3554 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3555 (defun byte-compile-or-recursion (rest wintag
)
3558 (byte-compile-form (car rest
))
3559 (byte-compile-goto-if t for-effect wintag
)
3560 (byte-compile-maybe-guarded (list 'not
(car rest
))
3561 (byte-compile-or-recursion (cdr rest
) wintag
)))
3562 (byte-compile-form-do-effect (car rest
))
3563 (byte-compile-out-tag wintag
)))
3565 (defun byte-compile-while (form)
3566 (let ((endtag (byte-compile-make-tag))
3567 (looptag (byte-compile-make-tag)))
3568 (byte-compile-out-tag looptag
)
3569 (byte-compile-form (car (cdr form
)))
3570 (byte-compile-goto-if nil for-effect endtag
)
3571 (byte-compile-body (cdr (cdr form
)) t
)
3572 (byte-compile-goto 'byte-goto looptag
)
3573 (byte-compile-out-tag endtag
)
3574 (setq for-effect nil
)))
3576 (defun byte-compile-funcall (form)
3577 (mapc 'byte-compile-form
(cdr form
))
3578 (byte-compile-out 'byte-call
(length (cdr (cdr form
)))))
3581 (defun byte-compile-let (form)
3582 ;; First compute the binding values in the old scope.
3583 (let ((varlist (car (cdr form
))))
3584 (dolist (var varlist
)
3586 (byte-compile-form (car (cdr var
)))
3587 (byte-compile-push-constant nil
))))
3588 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3589 (varlist (reverse (car (cdr form
)))))
3590 (dolist (var varlist
)
3591 (byte-compile-variable-ref 'byte-varbind
3592 (if (consp var
) (car var
) var
)))
3593 (byte-compile-body-do-effect (cdr (cdr form
)))
3594 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3596 (defun byte-compile-let* (form)
3597 (let ((byte-compile-bound-variables byte-compile-bound-variables
) ;new scope
3598 (varlist (copy-sequence (car (cdr form
)))))
3599 (dolist (var varlist
)
3601 (byte-compile-push-constant nil
)
3602 (byte-compile-form (car (cdr var
)))
3603 (setq var
(car var
)))
3604 (byte-compile-variable-ref 'byte-varbind var
))
3605 (byte-compile-body-do-effect (cdr (cdr form
)))
3606 (byte-compile-out 'byte-unbind
(length (car (cdr form
))))))
3609 (byte-defop-compiler-1 /= byte-compile-negated
)
3610 (byte-defop-compiler-1 atom byte-compile-negated
)
3611 (byte-defop-compiler-1 nlistp byte-compile-negated
)
3613 (put '/= 'byte-compile-negated-op
'=)
3614 (put 'atom
'byte-compile-negated-op
'consp
)
3615 (put 'nlistp
'byte-compile-negated-op
'listp
)
3617 (defun byte-compile-negated (form)
3618 (byte-compile-form-do-effect (byte-compile-negation-optimizer form
)))
3620 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3621 (defun byte-compile-negation-optimizer (form)
3622 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3623 (byte-compile-set-symbol-position (car form
))
3625 (cons (or (get (car form
) 'byte-compile-negated-op
)
3627 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3631 ;;; other tricky macro-like special-forms
3633 (byte-defop-compiler-1 catch
)
3634 (byte-defop-compiler-1 unwind-protect
)
3635 (byte-defop-compiler-1 condition-case
)
3636 (byte-defop-compiler-1 save-excursion
)
3637 (byte-defop-compiler-1 save-current-buffer
)
3638 (byte-defop-compiler-1 save-restriction
)
3639 (byte-defop-compiler-1 save-window-excursion
)
3640 (byte-defop-compiler-1 with-output-to-temp-buffer
)
3641 (byte-defop-compiler-1 track-mouse
)
3643 (defun byte-compile-catch (form)
3644 (byte-compile-form (car (cdr form
)))
3645 (byte-compile-push-constant
3646 (byte-compile-top-level (cons 'progn
(cdr (cdr form
))) for-effect
))
3647 (byte-compile-out 'byte-catch
0))
3649 (defun byte-compile-unwind-protect (form)
3650 (byte-compile-push-constant
3651 (byte-compile-top-level-body (cdr (cdr form
)) t
))
3652 (byte-compile-out 'byte-unwind-protect
0)
3653 (byte-compile-form-do-effect (car (cdr form
)))
3654 (byte-compile-out 'byte-unbind
1))
3656 (defun byte-compile-track-mouse (form)
3658 `(funcall '(lambda nil
3659 (track-mouse ,@(byte-compile-top-level-body (cdr form
)))))))
3661 (defun byte-compile-condition-case (form)
3662 (let* ((var (nth 1 form
))
3663 (byte-compile-bound-variables
3664 (if var
(cons var byte-compile-bound-variables
)
3665 byte-compile-bound-variables
)))
3666 (byte-compile-set-symbol-position 'condition-case
)
3667 (unless (symbolp var
)
3669 "`%s' is not a variable-name or nil (in condition-case)" var
))
3670 (byte-compile-push-constant var
)
3671 (byte-compile-push-constant (byte-compile-top-level
3672 (nth 2 form
) for-effect
))
3673 (let ((clauses (cdr (cdr (cdr form
))))
3676 (let* ((clause (car clauses
))
3677 (condition (car clause
)))
3678 (cond ((not (or (symbolp condition
)
3679 (and (listp condition
)
3680 (let ((syms condition
) (ok t
))
3682 (if (not (symbolp (car syms
)))
3684 (setq syms
(cdr syms
)))
3687 "`%s' is not a condition name or list of such (in condition-case)"
3688 (prin1-to-string condition
)))
3689 ;; ((not (or (eq condition 't)
3690 ;; (and (stringp (get condition 'error-message))
3691 ;; (consp (get condition 'error-conditions)))))
3692 ;; (byte-compile-warn
3693 ;; "`%s' is not a known condition name (in condition-case)"
3696 (setq compiled-clauses
3697 (cons (cons condition
3698 (byte-compile-top-level-body
3699 (cdr clause
) for-effect
))
3701 (setq clauses
(cdr clauses
)))
3702 (byte-compile-push-constant (nreverse compiled-clauses
)))
3703 (byte-compile-out 'byte-condition-case
0)))
3706 (defun byte-compile-save-excursion (form)
3707 (if (and (eq 'set-buffer
(car-safe (car-safe (cdr form
))))
3708 (byte-compile-warning-enabled-p 'suspicious
))
3709 (byte-compile-warn "`save-excursion' defeated by `set-buffer'"))
3710 (byte-compile-out 'byte-save-excursion
0)
3711 (byte-compile-body-do-effect (cdr form
))
3712 (byte-compile-out 'byte-unbind
1))
3714 (defun byte-compile-save-restriction (form)
3715 (byte-compile-out 'byte-save-restriction
0)
3716 (byte-compile-body-do-effect (cdr form
))
3717 (byte-compile-out 'byte-unbind
1))
3719 (defun byte-compile-save-current-buffer (form)
3720 (byte-compile-out 'byte-save-current-buffer
0)
3721 (byte-compile-body-do-effect (cdr form
))
3722 (byte-compile-out 'byte-unbind
1))
3724 (defun byte-compile-save-window-excursion (form)
3725 (byte-compile-push-constant
3726 (byte-compile-top-level-body (cdr form
) for-effect
))
3727 (byte-compile-out 'byte-save-window-excursion
0))
3729 (defun byte-compile-with-output-to-temp-buffer (form)
3730 (byte-compile-form (car (cdr form
)))
3731 (byte-compile-out 'byte-temp-output-buffer-setup
0)
3732 (byte-compile-body (cdr (cdr form
)))
3733 (byte-compile-out 'byte-temp-output-buffer-show
0))
3735 ;;; top-level forms elsewhere
3737 (byte-defop-compiler-1 defun
)
3738 (byte-defop-compiler-1 defmacro
)
3739 (byte-defop-compiler-1 defvar
)
3740 (byte-defop-compiler-1 defconst byte-compile-defvar
)
3741 (byte-defop-compiler-1 autoload
)
3742 (byte-defop-compiler-1 lambda byte-compile-lambda-form
)
3744 (defun byte-compile-defun (form)
3745 ;; This is not used for file-level defuns with doc strings.
3746 (if (symbolp (car form
))
3747 (byte-compile-set-symbol-position (car form
))
3748 (byte-compile-set-symbol-position 'defun
)
3749 (error "defun name must be a symbol, not %s" (car form
)))
3750 ;; We prefer to generate a defalias form so it will record the function
3751 ;; definition just like interpreting a defun.
3754 (list 'quote
(nth 1 form
))
3755 (byte-compile-byte-code-maker
3756 (byte-compile-lambda (cdr (cdr form
)) t
)))
3758 (byte-compile-constant (nth 1 form
)))
3760 (defun byte-compile-defmacro (form)
3761 ;; This is not used for file-level defmacros with doc strings.
3762 (byte-compile-body-do-effect
3763 (let ((decls (byte-compile-defmacro-declaration form
))
3764 (code (byte-compile-byte-code-maker
3765 (byte-compile-lambda (cdr (cdr form
)) t
))))
3766 `((defalias ',(nth 1 form
)
3767 ,(if (eq (car-safe code
) 'make-byte-code
)
3768 `(cons 'macro
,code
)
3769 `'(macro .
,(eval code
))))
3773 (defun byte-compile-defvar (form)
3774 ;; This is not used for file-level defvar/consts with doc strings.
3775 (let ((fun (nth 0 form
))
3777 (value (nth 2 form
))
3778 (string (nth 3 form
)))
3779 (byte-compile-set-symbol-position fun
)
3780 (when (or (> (length form
) 4)
3781 (and (eq fun
'defconst
) (null (cddr form
))))
3782 (let ((ncall (length (cdr form
))))
3784 "`%s' called with %d argument%s, but %s %s"
3786 (if (= 1 ncall
) "" "s")
3787 (if (< ncall
2) "requires" "accepts only")
3789 (push var byte-compile-bound-variables
)
3790 (if (eq fun
'defconst
)
3791 (push var byte-compile-const-variables
))
3792 (byte-compile-body-do-effect
3794 ;; Put the defined variable in this library's load-history entry
3795 ;; just as a real defvar would, but only in top-level forms.
3796 (when (and (cddr form
) (null byte-compile-current-form
))
3797 `(push ',var current-load-list
))
3798 (when (> (length form
) 3)
3799 (when (and string
(not (stringp string
)))
3800 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3802 `(put ',var
'variable-documentation
,string
))
3803 (if (cddr form
) ; `value' provided
3804 (let ((byte-compile-not-obsolete-vars (list var
)))
3805 (if (eq fun
'defconst
)
3806 ;; `defconst' sets `var' unconditionally.
3807 (let ((tmp (make-symbol "defconst-tmp-var")))
3808 `(funcall '(lambda (,tmp
) (defconst ,var
,tmp
))
3810 ;; `defvar' sets `var' only when unbound.
3811 `(if (not (default-boundp ',var
)) (setq-default ,var
,value
))))
3812 (when (eq fun
'defconst
)
3813 ;; This will signal an appropriate error at runtime.
3817 (defun byte-compile-autoload (form)
3818 (byte-compile-set-symbol-position 'autoload
)
3819 (and (byte-compile-constp (nth 1 form
))
3820 (byte-compile-constp (nth 5 form
))
3821 (eval (nth 5 form
)) ; macro-p
3822 (not (fboundp (eval (nth 1 form
))))
3824 "The compiler ignores `autoload' except at top level. You should
3825 probably put the autoload of the macro `%s' at top-level."
3826 (eval (nth 1 form
))))
3827 (byte-compile-normal-call form
))
3829 ;; Lambdas in valid places are handled as special cases by various code.
3830 ;; The ones that remain are errors.
3831 (defun byte-compile-lambda-form (form)
3832 (byte-compile-set-symbol-position 'lambda
)
3833 (error "`lambda' used as function name is invalid"))
3835 ;; Compile normally, but deal with warnings for the function being defined.
3836 (put 'defalias
'byte-hunk-handler
'byte-compile-file-form-defalias
)
3837 (defun byte-compile-file-form-defalias (form)
3838 (if (and (consp (cdr form
)) (consp (nth 1 form
))
3839 (eq (car (nth 1 form
)) 'quote
)
3840 (consp (cdr (nth 1 form
)))
3841 (symbolp (nth 1 (nth 1 form
))))
3843 (and (consp (nthcdr 2 form
))
3844 (consp (nth 2 form
))
3845 (eq (car (nth 2 form
)) 'quote
)
3846 (consp (cdr (nth 2 form
)))
3847 (symbolp (nth 1 (nth 2 form
))))))
3848 (byte-compile-defalias-warn (nth 1 (nth 1 form
)))
3849 (push (cons (nth 1 (nth 1 form
))
3850 (if constant
(nth 1 (nth 2 form
)) t
))
3851 byte-compile-function-environment
)))
3852 ;; We used to just do: (byte-compile-normal-call form)
3853 ;; But it turns out that this fails to optimize the code.
3854 ;; So instead we now do the same as what other byte-hunk-handlers do,
3855 ;; which is to call back byte-compile-file-form and then return nil.
3856 ;; Except that we can't just call byte-compile-file-form since it would
3857 ;; call us right back.
3858 (byte-compile-keep-pending form
)
3859 ;; Return nil so the form is not output twice.
3862 ;; Turn off warnings about prior calls to the function being defalias'd.
3863 ;; This could be smarter and compare those calls with
3864 ;; the function it is being aliased to.
3865 (defun byte-compile-defalias-warn (new)
3866 (let ((calls (assq new byte-compile-unresolved-functions
)))
3868 (setq byte-compile-unresolved-functions
3869 (delq calls byte-compile-unresolved-functions
)))))
3871 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings
)
3872 (defun byte-compile-no-warnings (form)
3873 (let (byte-compile-warnings)
3874 (byte-compile-form (cons 'progn
(cdr form
)))))
3876 ;; Warn about misuses of make-variable-buffer-local.
3877 (byte-defop-compiler-1 make-variable-buffer-local
3878 byte-compile-make-variable-buffer-local
)
3879 (defun byte-compile-make-variable-buffer-local (form)
3880 (if (and (eq (car-safe (car-safe (cdr-safe form
))) 'quote
)
3881 (byte-compile-warning-enabled-p 'make-local
))
3883 "`make-variable-buffer-local' should be called at toplevel"))
3884 (byte-compile-normal-call form
))
3885 (put 'make-variable-buffer-local
3886 'byte-hunk-handler
'byte-compile-form-make-variable-buffer-local
)
3887 (defun byte-compile-form-make-variable-buffer-local (form)
3888 (byte-compile-keep-pending form
'byte-compile-normal-call
))
3893 ;; Note: Most operations will strip off the 'TAG, but it speeds up
3894 ;; optimization to have the 'TAG as a part of the tag.
3895 ;; Tags will be (TAG . (tag-number . stack-depth)).
3896 (defun byte-compile-make-tag ()
3897 (list 'TAG
(setq byte-compile-tag-number
(1+ byte-compile-tag-number
))))
3900 (defun byte-compile-out-tag (tag)
3901 (setq byte-compile-output
(cons tag byte-compile-output
))
3904 ;; ## remove this someday
3905 (and byte-compile-depth
3906 (not (= (cdr (cdr tag
)) byte-compile-depth
))
3907 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag
))))
3908 (setq byte-compile-depth
(cdr (cdr tag
))))
3909 (setcdr (cdr tag
) byte-compile-depth
)))
3911 (defun byte-compile-goto (opcode tag
)
3912 (push (cons opcode tag
) byte-compile-output
)
3913 (setcdr (cdr tag
) (if (memq opcode byte-goto-always-pop-ops
)
3914 (1- byte-compile-depth
)
3915 byte-compile-depth
))
3916 (setq byte-compile-depth
(and (not (eq opcode
'byte-goto
))
3917 (1- byte-compile-depth
))))
3919 (defun byte-compile-out (opcode offset
)
3920 (push (cons opcode offset
) byte-compile-output
)
3921 (cond ((eq opcode
'byte-call
)
3922 (setq byte-compile-depth
(- byte-compile-depth offset
)))
3923 ((eq opcode
'byte-return
)
3924 ;; This is actually an unnecessary case, because there should be
3925 ;; no more opcodes behind byte-return.
3926 (setq byte-compile-depth nil
))
3928 (setq byte-compile-depth
(+ byte-compile-depth
3929 (or (aref byte-stack
+-info
3930 (symbol-value opcode
))
3932 byte-compile-maxdepth
(max byte-compile-depth
3933 byte-compile-maxdepth
))))
3934 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
3940 (defun byte-compile-annotate-call-tree (form)
3942 ;; annotate the current call
3943 (if (setq entry
(assq (car form
) byte-compile-call-tree
))
3944 (or (memq byte-compile-current-form
(nth 1 entry
)) ;callers
3946 (cons byte-compile-current-form
(nth 1 entry
))))
3947 (setq byte-compile-call-tree
3948 (cons (list (car form
) (list byte-compile-current-form
) nil
)
3949 byte-compile-call-tree
)))
3950 ;; annotate the current function
3951 (if (setq entry
(assq byte-compile-current-form byte-compile-call-tree
))
3952 (or (memq (car form
) (nth 2 entry
)) ;called
3953 (setcar (cdr (cdr entry
))
3954 (cons (car form
) (nth 2 entry
))))
3955 (setq byte-compile-call-tree
3956 (cons (list byte-compile-current-form nil
(list (car form
)))
3957 byte-compile-call-tree
)))
3960 ;; Renamed from byte-compile-report-call-tree
3961 ;; to avoid interfering with completion of byte-compile-file.
3963 (defun display-call-tree (&optional filename
)
3964 "Display a call graph of a specified file.
3965 This lists which functions have been called, what functions called
3966 them, and what functions they call. The list includes all functions
3967 whose definitions have been compiled in this Emacs session, as well as
3968 all functions called by those functions.
3970 The call graph does not include macros, inline functions, or
3971 primitives that the byte-code interpreter knows about directly \(eq,
3974 The call tree also lists those functions which are not known to be called
3975 \(that is, to which no calls have been compiled\), and which cannot be
3976 invoked interactively."
3978 (message "Generating call tree...")
3979 (with-output-to-temp-buffer "*Call-Tree*"
3980 (set-buffer "*Call-Tree*")
3982 (message "Generating call tree... (sorting on %s)"
3983 byte-compile-call-tree-sort
)
3984 (insert "Call tree for "
3985 (cond ((null byte-compile-current-file
) (or filename
"???"))
3986 ((stringp byte-compile-current-file
)
3987 byte-compile-current-file
)
3988 (t (buffer-name byte-compile-current-file
)))
3990 (prin1-to-string byte-compile-call-tree-sort
)
3992 (if byte-compile-call-tree-sort
3993 (setq byte-compile-call-tree
3994 (sort byte-compile-call-tree
3995 (cond ((eq byte-compile-call-tree-sort
'callers
)
3996 (function (lambda (x y
) (< (length (nth 1 x
))
3997 (length (nth 1 y
))))))
3998 ((eq byte-compile-call-tree-sort
'calls
)
3999 (function (lambda (x y
) (< (length (nth 2 x
))
4000 (length (nth 2 y
))))))
4001 ((eq byte-compile-call-tree-sort
'calls
+callers
)
4002 (function (lambda (x y
) (< (+ (length (nth 1 x
))
4004 (+ (length (nth 1 y
))
4005 (length (nth 2 y
)))))))
4006 ((eq byte-compile-call-tree-sort
'name
)
4007 (function (lambda (x y
) (string< (car x
)
4009 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4010 byte-compile-call-tree-sort
))))))
4011 (message "Generating call tree...")
4012 (let ((rest byte-compile-call-tree
)
4013 (b (current-buffer))
4017 (prin1 (car (car rest
)) b
)
4018 (setq callers
(nth 1 (car rest
))
4019 calls
(nth 2 (car rest
)))
4021 (cond ((not (fboundp (setq f
(car (car rest
)))))
4023 " <top level>";; shouldn't insert nil then, actually -sk
4025 ((subrp (setq f
(symbol-function f
)))
4028 (format " ==> %s" f
))
4029 ((byte-code-function-p f
)
4030 "<compiled function>")
4032 "<malformed function>")
4033 ((eq 'macro
(car f
))
4034 (if (or (byte-code-function-p (cdr f
))
4035 (assq 'byte-code
(cdr (cdr (cdr f
)))))
4038 ((assq 'byte-code
(cdr (cdr f
)))
4039 "<compiled lambda>")
4040 ((eq 'lambda
(car f
))
4043 (format " (%d callers + %d calls = %d)"
4044 ;; Does the optimizer eliminate common subexpressions?-sk
4047 (+ (length callers
) (length calls
)))
4051 (insert " called by:\n")
4053 (insert " " (if (car callers
)
4054 (mapconcat 'symbol-name callers
", ")
4056 (let ((fill-prefix " "))
4057 (fill-region-as-paragraph p
(point)))
4058 (unless (= 0 (current-column))
4062 (insert " calls:\n")
4064 (insert " " (mapconcat 'symbol-name calls
", "))
4065 (let ((fill-prefix " "))
4066 (fill-region-as-paragraph p
(point)))
4067 (unless (= 0 (current-column))
4069 (setq rest
(cdr rest
)))
4071 (message "Generating call tree...(finding uncalled functions...)")
4072 (setq rest byte-compile-call-tree
)
4075 (or (nth 1 (car rest
))
4076 (null (setq f
(caar rest
)))
4078 (setq def
(byte-compile-fdefinition f t
))
4079 (and (eq (car-safe def
) 'macro
)
4080 (eq (car-safe (cdr-safe def
)) 'lambda
)
4081 (setq def
(cdr def
)))
4084 (setq def
(byte-compile-fdefinition f nil
))
4085 (and (eq (car-safe def
) 'macro
)
4086 (eq (car-safe (cdr-safe def
)) 'lambda
)
4087 (setq def
(cdr def
)))
4089 (setq uncalled
(cons f uncalled
)))
4090 (setq rest
(cdr rest
)))
4092 (let ((fill-prefix " "))
4093 (insert "Noninteractive functions not known to be called:\n ")
4095 (insert (mapconcat 'symbol-name
(nreverse uncalled
) ", "))
4096 (fill-region-as-paragraph p
(point))))))
4097 (message "Generating call tree...done.")))
4101 (defun batch-byte-compile-if-not-done ()
4102 "Like `byte-compile-file' but doesn't recompile if already up to date.
4103 Use this from the command line, with `-batch';
4104 it won't work in an interactive Emacs."
4105 (batch-byte-compile t
))
4107 ;;; by crl@newton.purdue.edu
4108 ;;; Only works noninteractively.
4110 (defun batch-byte-compile (&optional noforce
)
4111 "Run `byte-compile-file' on the files remaining on the command line.
4112 Use this from the command line, with `-batch';
4113 it won't work in an interactive Emacs.
4114 Each file is processed even if an error occurred previously.
4115 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4116 If NOFORCE is non-nil, don't recompile a file that seems to be
4117 already up-to-date."
4118 ;; command-line-args-left is what is left of the command line (from startup.el)
4119 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4120 (if (not noninteractive
)
4121 (error "`batch-byte-compile' is to be used only with -batch"))
4122 (let ((bytecomp-error nil
))
4123 (while command-line-args-left
4124 (if (file-directory-p (expand-file-name (car command-line-args-left
)))
4125 ;; Directory as argument.
4126 (let ((bytecomp-files (directory-files (car command-line-args-left
)))
4127 bytecomp-source bytecomp-dest
)
4128 (dolist (bytecomp-file bytecomp-files
)
4129 (if (and (string-match emacs-lisp-file-regexp bytecomp-file
)
4130 (not (auto-save-file-name-p bytecomp-file
))
4131 (setq bytecomp-source
4132 (expand-file-name bytecomp-file
4133 (car command-line-args-left
)))
4134 (setq bytecomp-dest
(byte-compile-dest-file
4136 (file-exists-p bytecomp-dest
)
4137 (file-newer-than-file-p bytecomp-source bytecomp-dest
))
4138 (if (null (batch-byte-compile-file bytecomp-source
))
4139 (setq bytecomp-error t
)))))
4140 ;; Specific file argument
4141 (if (or (not noforce
)
4142 (let* ((bytecomp-source (car command-line-args-left
))
4143 (bytecomp-dest (byte-compile-dest-file bytecomp-source
)))
4144 (or (not (file-exists-p bytecomp-dest
))
4145 (file-newer-than-file-p bytecomp-source bytecomp-dest
))))
4146 (if (null (batch-byte-compile-file (car command-line-args-left
)))
4147 (setq bytecomp-error t
))))
4148 (setq command-line-args-left
(cdr command-line-args-left
)))
4149 (kill-emacs (if bytecomp-error
1 0))))
4151 (defun batch-byte-compile-file (bytecomp-file)
4153 (byte-compile-file bytecomp-file
)
4155 (byte-compile-file bytecomp-file
)
4157 (message (if (cdr err
)
4158 ">>Error occurred processing %s: %s (%s)"
4159 ">>Error occurred processing %s: %s")
4161 (get (car err
) 'error-message
)
4162 (prin1-to-string (cdr err
)))
4163 (let ((bytecomp-destfile (byte-compile-dest-file bytecomp-file
)))
4164 (if (file-exists-p bytecomp-destfile
)
4165 (delete-file bytecomp-destfile
)))
4168 (message (if (cdr err
)
4169 ">>Error occurred processing %s: %s (%s)"
4170 ">>Error occurred processing %s: %s")
4172 (get (car err
) 'error-message
)
4173 (prin1-to-string (cdr err
)))
4176 (defun byte-compile-refresh-preloaded ()
4177 "Reload any Lisp file that was changed since Emacs was dumped.
4179 (let* ((argv0 (car command-line-args
))
4180 (emacs-file (executable-find argv0
)))
4181 (if (not (and emacs-file
(file-executable-p emacs-file
)))
4182 (message "Can't find %s to refresh preloaded Lisp files" argv0
)
4183 (dolist (f (reverse load-history
))
4185 (if (string-match "elc\\'" f
) (setq f
(substring f
0 -
1)))
4186 (when (and (file-readable-p f
)
4187 (file-newer-than-file-p f emacs-file
))
4188 (message "Reloading stale %s" (file-name-nondirectory f
))
4190 (load f
'noerror nil
'nosuffix
)
4191 ;; Probably shouldn't happen, but in case of an error, it seems
4192 ;; at least as useful to ignore it as it is to stop compilation.
4196 (defun batch-byte-recompile-directory (&optional arg
)
4197 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4198 Must be used only with `-batch', and kills Emacs on completion.
4199 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4201 Optional argument ARG is passed as second argument ARG to
4202 `byte-recompile-directory'; see there for its possible values
4203 and corresponding effects."
4204 ;; command-line-args-left is what is left of the command line (startup.el)
4205 (defvar command-line-args-left
) ;Avoid 'free variable' warning
4206 (if (not noninteractive
)
4207 (error "batch-byte-recompile-directory is to be used only with -batch"))
4208 (or command-line-args-left
4209 (setq command-line-args-left
'(".")))
4210 (while command-line-args-left
4211 (byte-recompile-directory (car command-line-args-left
) arg
)
4212 (setq command-line-args-left
(cdr command-line-args-left
)))
4215 (provide 'byte-compile
)
4219 ;;; report metering (see the hacks in bytecode.c)
4221 (defvar byte-code-meter
)
4222 (defun byte-compile-report-ops ()
4223 (with-output-to-temp-buffer "*Meter*"
4224 (set-buffer "*Meter*")
4225 (let ((i 0) n op off
)
4227 (setq n
(aref (aref byte-code-meter
0) i
)
4229 (if t
;(not (zerop n))
4233 (cond ((< op byte-nth
)
4234 (setq off
(logand op
7))
4235 (setq op
(logand op
248)))
4236 ((>= op byte-constant
)
4237 (setq off
(- op byte-constant
)
4239 (setq op
(aref byte-code-vector op
))
4240 (insert (format "%-4d" i
))
4241 (insert (symbol-name op
))
4242 (if off
(insert " [" (int-to-string off
) "]"))
4244 (insert (int-to-string n
) "\n")))
4247 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4248 ;; itself, compile some of its most used recursive functions (at load time).
4251 (or (byte-code-function-p (symbol-function 'byte-compile-form
))
4252 (assq 'byte-code
(symbol-function 'byte-compile-form
))
4253 (let ((byte-optimize nil
) ; do it fast
4254 (byte-compile-warnings nil
))
4256 (or noninteractive
(message "compiling %s..." x
))
4258 (or noninteractive
(message "compiling %s...done" x
)))
4259 '(byte-compile-normal-call
4262 ;; Inserted some more than necessary, to speed it up.
4263 byte-compile-top-level
4264 byte-compile-out-toplevel
4265 byte-compile-constant
4266 byte-compile-variable-ref
))))
4269 (run-hooks 'bytecomp-load-hook
)
4271 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4272 ;;; bytecomp.el ends here
