* doc/lispref/variables.texi (Scope): Mention the availability of lexbind.
[emacs.git] / lisp / emacs-lisp / bytecomp.el
blob3575b10e1f11eade706a04d54ccff48e2d014a0c
1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
8 ;; Maintainer: FSF
9 ;; Keywords: lisp
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
30 ;; of p-code (`lapcode') which takes up less space and can be interpreted
31 ;; faster. [`LAP' == `Lisp Assembly Program'.]
32 ;; The user entry points are byte-compile-file and byte-recompile-directory.
34 ;;; Code:
36 ;; ========================================================================
37 ;; Entry points:
38 ;; byte-recompile-directory, byte-compile-file,
39 ;; byte-recompile-file,
40 ;; batch-byte-compile, batch-byte-recompile-directory,
41 ;; byte-compile, compile-defun,
42 ;; display-call-tree
43 ;; (byte-compile-buffer and byte-compile-and-load-file were turned off
44 ;; because they are not terribly useful and get in the way of completion.)
46 ;; This version of the byte compiler has the following improvements:
47 ;; + optimization of compiled code:
48 ;; - removal of unreachable code;
49 ;; - removal of calls to side-effectless functions whose return-value
50 ;; is unused;
51 ;; - compile-time evaluation of safe constant forms, such as (consp nil)
52 ;; and (ash 1 6);
53 ;; - open-coding of literal lambdas;
54 ;; - peephole optimization of emitted code;
55 ;; - trivial functions are left uncompiled for speed.
56 ;; + support for inline functions;
57 ;; + compile-time evaluation of arbitrary expressions;
58 ;; + compile-time warning messages for:
59 ;; - functions being redefined with incompatible arglists;
60 ;; - functions being redefined as macros, or vice-versa;
61 ;; - functions or macros defined multiple times in the same file;
62 ;; - functions being called with the incorrect number of arguments;
63 ;; - functions being called which are not defined globally, in the
64 ;; file, or as autoloads;
65 ;; - assignment and reference of undeclared free variables;
66 ;; - various syntax errors;
67 ;; + correct compilation of nested defuns, defmacros, defvars and defsubsts;
68 ;; + correct compilation of top-level uses of macros;
69 ;; + the ability to generate a histogram of functions called.
71 ;; User customization variables: M-x customize-group bytecomp
73 ;; New Features:
75 ;; o The form `defsubst' is just like `defun', except that the function
76 ;; generated will be open-coded in compiled code which uses it. This
77 ;; means that no function call will be generated, it will simply be
78 ;; spliced in. Lisp functions calls are very slow, so this can be a
79 ;; big win.
81 ;; You can generally accomplish the same thing with `defmacro', but in
82 ;; that case, the defined procedure can't be used as an argument to
83 ;; mapcar, etc.
85 ;; o You can also open-code one particular call to a function without
86 ;; open-coding all calls. Use the 'inline' form to do this, like so:
88 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
89 ;; or...
90 ;; (inline ;; `foo' and `baz' will be
91 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
92 ;; (baz 0))
94 ;; o It is possible to open-code a function in the same file it is defined
95 ;; in without having to load that file before compiling it. The
96 ;; byte-compiler has been modified to remember function definitions in
97 ;; the compilation environment in the same way that it remembers macro
98 ;; definitions.
100 ;; o Forms like ((lambda ...) ...) are open-coded.
102 ;; o The form `eval-when-compile' is like progn, except that the body
103 ;; is evaluated at compile-time. When it appears at top-level, this
104 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
105 ;; When it does not appear at top-level, it is similar to the
106 ;; Common Lisp #. reader macro (but not in interpreted code).
108 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
109 ;; the whole form is evalled both at compile-time and at run-time.
111 ;; o The command compile-defun is analogous to eval-defun.
113 ;; o If you run byte-compile-file on a filename which is visited in a
114 ;; buffer, and that buffer is modified, you are asked whether you want
115 ;; to save the buffer before compiling.
117 ;; o byte-compiled files now start with the string `;ELC'.
118 ;; Some versions of `file' can be customized to recognize that.
120 (require 'backquote)
121 (require 'macroexp)
122 (require 'cconv)
123 (eval-when-compile (require 'cl))
125 (or (fboundp 'defsubst)
126 ;; This really ought to be loaded already!
127 (load "byte-run"))
129 ;; The feature of compiling in a specific target Emacs version
130 ;; has been turned off because compile time options are a bad idea.
131 (defmacro byte-compile-single-version () nil)
132 (defmacro byte-compile-version-cond (cond) cond)
135 (defgroup bytecomp nil
136 "Emacs Lisp byte-compiler."
137 :group 'lisp)
139 (defcustom emacs-lisp-file-regexp "\\.el\\'"
140 "Regexp which matches Emacs Lisp source files.
141 If you change this, you might want to set `byte-compile-dest-file-function'."
142 :group 'bytecomp
143 :type 'regexp)
145 (defcustom byte-compile-dest-file-function nil
146 "Function for the function `byte-compile-dest-file' to call.
147 It should take one argument, the name of an Emacs Lisp source
148 file name, and return the name of the compiled file."
149 :group 'bytecomp
150 :type '(choice (const nil) function)
151 :version "23.2")
153 ;; This enables file name handlers such as jka-compr
154 ;; to remove parts of the file name that should not be copied
155 ;; through to the output file name.
156 (defun byte-compiler-base-file-name (filename)
157 (let ((handler (find-file-name-handler filename
158 'byte-compiler-base-file-name)))
159 (if handler
160 (funcall handler 'byte-compiler-base-file-name filename)
161 filename)))
163 (or (fboundp 'byte-compile-dest-file)
164 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
165 ;; so only define it if it is undefined.
166 ;; Note - redefining this function is obsolete as of 23.2.
167 ;; Customize byte-compile-dest-file-function instead.
168 (defun byte-compile-dest-file (filename)
169 "Convert an Emacs Lisp source file name to a compiled file name.
170 If `byte-compile-dest-file-function' is non-nil, uses that
171 function to do the work. Otherwise, if FILENAME matches
172 `emacs-lisp-file-regexp' (by default, files with the extension `.el'),
173 adds `c' to it; otherwise adds `.elc'."
174 (if byte-compile-dest-file-function
175 (funcall byte-compile-dest-file-function filename)
176 (setq filename (file-name-sans-versions
177 (byte-compiler-base-file-name filename)))
178 (cond ((string-match emacs-lisp-file-regexp filename)
179 (concat (substring filename 0 (match-beginning 0)) ".elc"))
180 (t (concat filename ".elc"))))))
182 ;; This can be the 'byte-compile property of any symbol.
183 (autoload 'byte-compile-inline-expand "byte-opt")
185 ;; This is the entrypoint to the lapcode optimizer pass1.
186 (autoload 'byte-optimize-form "byte-opt")
187 ;; This is the entrypoint to the lapcode optimizer pass2.
188 (autoload 'byte-optimize-lapcode "byte-opt")
189 (autoload 'byte-compile-unfold-lambda "byte-opt")
191 ;; This is the entry point to the decompiler, which is used by the
192 ;; disassembler. The disassembler just requires 'byte-compile, but
193 ;; that doesn't define this function, so this seems to be a reasonable
194 ;; thing to do.
195 (autoload 'byte-decompile-bytecode "byte-opt")
197 (defcustom byte-compile-verbose
198 (and (not noninteractive) (> baud-rate search-slow-speed))
199 "Non-nil means print messages describing progress of byte-compiler."
200 :group 'bytecomp
201 :type 'boolean)
203 (defcustom byte-optimize t
204 "Enable optimization in the byte compiler.
205 Possible values are:
206 nil - no optimization
207 t - all optimizations
208 `source' - source-level optimizations only
209 `byte' - code-level optimizations only"
210 :group 'bytecomp
211 :type '(choice (const :tag "none" nil)
212 (const :tag "all" t)
213 (const :tag "source-level" source)
214 (const :tag "byte-level" byte)))
216 (defcustom byte-compile-delete-errors nil
217 "If non-nil, the optimizer may delete forms that may signal an error.
218 This includes variable references and calls to functions such as `car'."
219 :group 'bytecomp
220 :type 'boolean)
222 (defvar byte-compile-dynamic nil
223 "If non-nil, compile function bodies so they load lazily.
224 They are hidden in comments in the compiled file,
225 and each one is brought into core when the
226 function is called.
228 To enable this option, make it a file-local variable
229 in the source file you want it to apply to.
230 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
232 When this option is true, if you load the compiled file and then move it,
233 the functions you loaded will not be able to run.")
234 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
236 (defvar byte-compile-disable-print-circle nil
237 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
238 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
240 (defcustom byte-compile-dynamic-docstrings t
241 "If non-nil, compile doc strings for lazy access.
242 We bury the doc strings of functions and variables inside comments in
243 the file, and bring them into core only when they are actually needed.
245 When this option is true, if you load the compiled file and then move it,
246 you won't be able to find the documentation of anything in that file.
248 To disable this option for a certain file, make it a file-local variable
249 in the source file. For example, add this to the first line:
250 -*-byte-compile-dynamic-docstrings:nil;-*-
251 You can also set the variable globally.
253 This option is enabled by default because it reduces Emacs memory usage."
254 :group 'bytecomp
255 :type 'boolean)
256 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
258 (defconst byte-compile-log-buffer "*Compile-Log*"
259 "Name of the byte-compiler's log buffer.")
261 (defcustom byte-optimize-log nil
262 "If non-nil, the byte-compiler will log its optimizations.
263 If this is 'source, then only source-level optimizations will be logged.
264 If it is 'byte, then only byte-level optimizations will be logged.
265 The information is logged to `byte-compile-log-buffer'."
266 :group 'bytecomp
267 :type '(choice (const :tag "none" nil)
268 (const :tag "all" t)
269 (const :tag "source-level" source)
270 (const :tag "byte-level" byte)))
272 (defcustom byte-compile-error-on-warn nil
273 "If true, the byte-compiler reports warnings with `error'."
274 :group 'bytecomp
275 :type 'boolean)
277 (defconst byte-compile-warning-types
278 '(redefine callargs free-vars unresolved
279 obsolete noruntime cl-functions interactive-only
280 make-local mapcar constants suspicious lexical)
281 "The list of warning types used when `byte-compile-warnings' is t.")
282 (defcustom byte-compile-warnings t
283 "List of warnings that the byte-compiler should issue (t for all).
285 Elements of the list may be:
287 free-vars references to variables not in the current lexical scope.
288 unresolved calls to unknown functions.
289 callargs function calls with args that don't match the definition.
290 redefine function name redefined from a macro to ordinary function or vice
291 versa, or redefined to take a different number of arguments.
292 obsolete obsolete variables and functions.
293 noruntime functions that may not be defined at runtime (typically
294 defined only under `eval-when-compile').
295 cl-functions calls to runtime functions from the CL package (as
296 distinguished from macros and aliases).
297 interactive-only
298 commands that normally shouldn't be called from Lisp code.
299 make-local calls to make-variable-buffer-local that may be incorrect.
300 mapcar mapcar called for effect.
301 constants let-binding of, or assignment to, constants/nonvariables.
302 suspicious constructs that usually don't do what the coder wanted.
304 If the list begins with `not', then the remaining elements specify warnings to
305 suppress. For example, (not mapcar) will suppress warnings about mapcar."
306 :group 'bytecomp
307 :type `(choice (const :tag "All" t)
308 (set :menu-tag "Some"
309 ,@(mapcar (lambda (x) `(const ,x))
310 byte-compile-warning-types))))
312 ;;;###autoload
313 (put 'byte-compile-warnings 'safe-local-variable
314 (lambda (v)
315 (or (symbolp v)
316 (null (delq nil (mapcar (lambda (x) (not (symbolp x))) v))))))
318 (defun byte-compile-warning-enabled-p (warning)
319 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
320 (or (eq byte-compile-warnings t)
321 (if (eq (car byte-compile-warnings) 'not)
322 (not (memq warning byte-compile-warnings))
323 (memq warning byte-compile-warnings))))
325 ;;;###autoload
326 (defun byte-compile-disable-warning (warning)
327 "Change `byte-compile-warnings' to disable WARNING.
328 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
329 Otherwise, if the first element is `not', add WARNING, else remove it.
330 Normally you should let-bind `byte-compile-warnings' before calling this,
331 else the global value will be modified."
332 (setq byte-compile-warnings
333 (cond ((eq byte-compile-warnings t)
334 (list 'not warning))
335 ((eq (car byte-compile-warnings) 'not)
336 (if (memq warning byte-compile-warnings)
337 byte-compile-warnings
338 (append byte-compile-warnings (list warning))))
340 (delq warning byte-compile-warnings)))))
342 ;;;###autoload
343 (defun byte-compile-enable-warning (warning)
344 "Change `byte-compile-warnings' to enable WARNING.
345 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
346 first element is `not', remove WARNING, else add it.
347 Normally you should let-bind `byte-compile-warnings' before calling this,
348 else the global value will be modified."
349 (or (eq byte-compile-warnings t)
350 (setq byte-compile-warnings
351 (cond ((eq (car byte-compile-warnings) 'not)
352 (delq warning byte-compile-warnings))
353 ((memq warning byte-compile-warnings)
354 byte-compile-warnings)
356 (append byte-compile-warnings (list warning)))))))
358 (defvar byte-compile-interactive-only-functions
359 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
360 insert-file insert-buffer insert-file-literally previous-line next-line
361 goto-line comint-run delete-backward-char)
362 "List of commands that are not meant to be called from Lisp.")
364 (defvar byte-compile-not-obsolete-vars nil
365 "If non-nil, a list of variables that shouldn't be reported as obsolete.")
367 (defvar byte-compile-not-obsolete-funcs nil
368 "If non-nil, a list of functions that shouldn't be reported as obsolete.")
370 (defcustom byte-compile-generate-call-tree nil
371 "Non-nil means collect call-graph information when compiling.
372 This records which functions were called and from where.
373 If the value is t, compilation displays the call graph when it finishes.
374 If the value is neither t nor nil, compilation asks you whether to display
375 the graph.
377 The call tree only lists functions called, not macros used. Those functions
378 which the byte-code interpreter knows about directly (eq, cons, etc.) are
379 not reported.
381 The call tree also lists those functions which are not known to be called
382 \(that is, to which no calls have been compiled). Functions which can be
383 invoked interactively are excluded from this list."
384 :group 'bytecomp
385 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
386 (other :tag "Ask" lambda)))
388 (defvar byte-compile-call-tree nil
389 "Alist of functions and their call tree.
390 Each element looks like
392 \(FUNCTION CALLERS CALLS\)
394 where CALLERS is a list of functions that call FUNCTION, and CALLS
395 is a list of functions for which calls were generated while compiling
396 FUNCTION.")
398 (defcustom byte-compile-call-tree-sort 'name
399 "If non-nil, sort the call tree.
400 The values `name', `callers', `calls', `calls+callers'
401 specify different fields to sort on."
402 :group 'bytecomp
403 :type '(choice (const name) (const callers) (const calls)
404 (const calls+callers) (const nil)))
406 (defvar byte-compile-debug t)
407 (setq debug-on-error t)
409 (defvar byte-compile-constants nil
410 "List of all constants encountered during compilation of this form.")
411 (defvar byte-compile-variables nil
412 "List of all variables encountered during compilation of this form.")
413 (defvar byte-compile-bound-variables nil
414 "List of dynamic variables bound in the context of the current form.
415 This list lives partly on the stack.")
416 (defvar byte-compile-const-variables nil
417 "List of variables declared as constants during compilation of this file.")
418 (defvar byte-compile-free-references)
419 (defvar byte-compile-free-assignments)
421 (defvar byte-compiler-error-flag)
423 (defconst byte-compile-initial-macro-environment
425 ;; (byte-compiler-options . (lambda (&rest forms)
426 ;; (apply 'byte-compiler-options-handler forms)))
427 (declare-function . byte-compile-macroexpand-declare-function)
428 (eval-when-compile . (lambda (&rest body)
429 (list
430 'quote
431 (byte-compile-eval
432 (byte-compile-top-level
433 (macroexpand-all
434 (cons 'progn body)
435 byte-compile-initial-macro-environment))))))
436 (eval-and-compile . (lambda (&rest body)
437 (byte-compile-eval-before-compile (cons 'progn body))
438 (cons 'progn body))))
439 "The default macro-environment passed to macroexpand by the compiler.
440 Placing a macro here will cause a macro to have different semantics when
441 expanded by the compiler as when expanded by the interpreter.")
443 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
444 "Alist of macros defined in the file being compiled.
445 Each element looks like (MACRONAME . DEFINITION). It is
446 \(MACRONAME . nil) when a macro is redefined as a function.")
448 (defvar byte-compile-function-environment nil
449 "Alist of functions defined in the file being compiled.
450 This is so we can inline them when necessary.
451 Each element looks like (FUNCTIONNAME . DEFINITION). It is
452 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
453 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
454 and we don't know the definition. For an autoloaded function, DEFINITION
455 has the form (autoload . FILENAME).")
457 (defvar byte-compile-unresolved-functions nil
458 "Alist of undefined functions to which calls have been compiled.
459 This variable is only significant whilst compiling an entire buffer.
460 Used for warnings when a function is not known to be defined or is later
461 defined with incorrect args.")
463 (defvar byte-compile-noruntime-functions nil
464 "Alist of functions called that may not be defined when the compiled code is run.
465 Used for warnings about calling a function that is defined during compilation
466 but won't necessarily be defined when the compiled file is loaded.")
468 ;; Variables for lexical binding
469 (defvar byte-compile-lexical-environment nil
470 "The current lexical environment.")
472 (defvar byte-compile-tag-number 0)
473 (defvar byte-compile-output nil
474 "Alist describing contents to put in byte code string.
475 Each element is (INDEX . VALUE)")
476 (defvar byte-compile-depth 0 "Current depth of execution stack.")
477 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
480 ;;; The byte codes; this information is duplicated in bytecomp.c
482 (defvar byte-code-vector nil
483 "An array containing byte-code names indexed by byte-code values.")
485 (defvar byte-stack+-info nil
486 "An array with the stack adjustment for each byte-code.")
488 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
489 ;; This is a speed-hack for building the byte-code-vector at compile-time.
490 ;; We fill in the vector at macroexpand-time, and then after the last call
491 ;; to byte-defop, we write the vector out as a constant instead of writing
492 ;; out a bunch of calls to aset.
493 ;; Actually, we don't fill in the vector itself, because that could make
494 ;; it problematic to compile big changes to this compiler; we store the
495 ;; values on its plist, and remove them later in -extrude.
496 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
497 (put 'byte-code-vector 'tmp-compile-time-value
498 (make-vector 256 nil))))
499 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
500 (put 'byte-stack+-info 'tmp-compile-time-value
501 (make-vector 256 nil)))))
502 (aset v1 opcode opname)
503 (aset v2 opcode stack-adjust))
504 (if docstring
505 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
506 (list 'defconst opname opcode)))
508 (defmacro byte-extrude-byte-code-vectors ()
509 (prog1 (list 'setq 'byte-code-vector
510 (get 'byte-code-vector 'tmp-compile-time-value)
511 'byte-stack+-info
512 (get 'byte-stack+-info 'tmp-compile-time-value))
513 (put 'byte-code-vector 'tmp-compile-time-value nil)
514 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
517 ;; These opcodes are special in that they pack their argument into the
518 ;; opcode word.
520 (byte-defop 0 1 byte-stack-ref "for stack reference")
521 (byte-defop 8 1 byte-varref "for variable reference")
522 (byte-defop 16 -1 byte-varset "for setting a variable")
523 (byte-defop 24 -1 byte-varbind "for binding a variable")
524 (byte-defop 32 0 byte-call "for calling a function")
525 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
526 ;; codes 8-47 are consumed by the preceding opcodes
528 ;; unused: 48-55
530 (byte-defop 56 -1 byte-nth)
531 (byte-defop 57 0 byte-symbolp)
532 (byte-defop 58 0 byte-consp)
533 (byte-defop 59 0 byte-stringp)
534 (byte-defop 60 0 byte-listp)
535 (byte-defop 61 -1 byte-eq)
536 (byte-defop 62 -1 byte-memq)
537 (byte-defop 63 0 byte-not)
538 (byte-defop 64 0 byte-car)
539 (byte-defop 65 0 byte-cdr)
540 (byte-defop 66 -1 byte-cons)
541 (byte-defop 67 0 byte-list1)
542 (byte-defop 68 -1 byte-list2)
543 (byte-defop 69 -2 byte-list3)
544 (byte-defop 70 -3 byte-list4)
545 (byte-defop 71 0 byte-length)
546 (byte-defop 72 -1 byte-aref)
547 (byte-defop 73 -2 byte-aset)
548 (byte-defop 74 0 byte-symbol-value)
549 (byte-defop 75 0 byte-symbol-function) ; this was commented out
550 (byte-defop 76 -1 byte-set)
551 (byte-defop 77 -1 byte-fset) ; this was commented out
552 (byte-defop 78 -1 byte-get)
553 (byte-defop 79 -2 byte-substring)
554 (byte-defop 80 -1 byte-concat2)
555 (byte-defop 81 -2 byte-concat3)
556 (byte-defop 82 -3 byte-concat4)
557 (byte-defop 83 0 byte-sub1)
558 (byte-defop 84 0 byte-add1)
559 (byte-defop 85 -1 byte-eqlsign)
560 (byte-defop 86 -1 byte-gtr)
561 (byte-defop 87 -1 byte-lss)
562 (byte-defop 88 -1 byte-leq)
563 (byte-defop 89 -1 byte-geq)
564 (byte-defop 90 -1 byte-diff)
565 (byte-defop 91 0 byte-negate)
566 (byte-defop 92 -1 byte-plus)
567 (byte-defop 93 -1 byte-max)
568 (byte-defop 94 -1 byte-min)
569 (byte-defop 95 -1 byte-mult) ; v19 only
570 (byte-defop 96 1 byte-point)
571 (byte-defop 98 0 byte-goto-char)
572 (byte-defop 99 0 byte-insert)
573 (byte-defop 100 1 byte-point-max)
574 (byte-defop 101 1 byte-point-min)
575 (byte-defop 102 0 byte-char-after)
576 (byte-defop 103 1 byte-following-char)
577 (byte-defop 104 1 byte-preceding-char)
578 (byte-defop 105 1 byte-current-column)
579 (byte-defop 106 0 byte-indent-to)
580 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
581 (byte-defop 108 1 byte-eolp)
582 (byte-defop 109 1 byte-eobp)
583 (byte-defop 110 1 byte-bolp)
584 (byte-defop 111 1 byte-bobp)
585 (byte-defop 112 1 byte-current-buffer)
586 (byte-defop 113 0 byte-set-buffer)
587 (byte-defop 114 0 byte-save-current-buffer
588 "To make a binding to record the current buffer")
589 (byte-defop 115 0 byte-set-mark-OBSOLETE)
591 ;; These ops are new to v19
592 (byte-defop 117 0 byte-forward-char)
593 (byte-defop 118 0 byte-forward-word)
594 (byte-defop 119 -1 byte-skip-chars-forward)
595 (byte-defop 120 -1 byte-skip-chars-backward)
596 (byte-defop 121 0 byte-forward-line)
597 (byte-defop 122 0 byte-char-syntax)
598 (byte-defop 123 -1 byte-buffer-substring)
599 (byte-defop 124 -1 byte-delete-region)
600 (byte-defop 125 -1 byte-narrow-to-region)
601 (byte-defop 126 1 byte-widen)
602 (byte-defop 127 0 byte-end-of-line)
604 ;; unused: 128
606 ;; These store their argument in the next two bytes
607 (byte-defop 129 1 byte-constant2
608 "for reference to a constant with vector index >= byte-constant-limit")
609 (byte-defop 130 0 byte-goto "for unconditional jump")
610 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
611 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
612 (byte-defop 133 -1 byte-goto-if-nil-else-pop
613 "to examine top-of-stack, jump and don't pop it if it's nil,
614 otherwise pop it")
615 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
616 "to examine top-of-stack, jump and don't pop it if it's non nil,
617 otherwise pop it")
619 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
620 (byte-defop 136 -1 byte-discard "to discard one value from stack")
621 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
623 (byte-defop 138 0 byte-save-excursion
624 "to make a binding to record the buffer, point and mark")
625 (byte-defop 140 0 byte-save-restriction
626 "to make a binding to record the current buffer clipping restrictions")
627 (byte-defop 141 -1 byte-catch
628 "for catch. Takes, on stack, the tag and an expression for the body")
629 (byte-defop 142 -1 byte-unwind-protect
630 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
632 ;; For condition-case. Takes, on stack, the variable to bind,
633 ;; an expression for the body, and a list of clauses.
634 (byte-defop 143 -2 byte-condition-case)
636 ;; For entry to with-output-to-temp-buffer.
637 ;; Takes, on stack, the buffer name.
638 ;; Binds standard-output and does some other things.
639 ;; Returns with temp buffer on the stack in place of buffer name.
640 ;; (byte-defop 144 0 byte-temp-output-buffer-setup)
642 ;; For exit from with-output-to-temp-buffer.
643 ;; Expects the temp buffer on the stack underneath value to return.
644 ;; Pops them both, then pushes the value back on.
645 ;; Unbinds standard-output and makes the temp buffer visible.
646 ;; (byte-defop 145 -1 byte-temp-output-buffer-show)
648 ;; these ops are new to v19
650 ;; To unbind back to the beginning of this frame.
651 ;; Not used yet, but will be needed for tail-recursion elimination.
652 (byte-defop 146 0 byte-unbind-all)
654 ;; these ops are new to v19
655 (byte-defop 147 -2 byte-set-marker)
656 (byte-defop 148 0 byte-match-beginning)
657 (byte-defop 149 0 byte-match-end)
658 (byte-defop 150 0 byte-upcase)
659 (byte-defop 151 0 byte-downcase)
660 (byte-defop 152 -1 byte-string=)
661 (byte-defop 153 -1 byte-string<)
662 (byte-defop 154 -1 byte-equal)
663 (byte-defop 155 -1 byte-nthcdr)
664 (byte-defop 156 -1 byte-elt)
665 (byte-defop 157 -1 byte-member)
666 (byte-defop 158 -1 byte-assq)
667 (byte-defop 159 0 byte-nreverse)
668 (byte-defop 160 -1 byte-setcar)
669 (byte-defop 161 -1 byte-setcdr)
670 (byte-defop 162 0 byte-car-safe)
671 (byte-defop 163 0 byte-cdr-safe)
672 (byte-defop 164 -1 byte-nconc)
673 (byte-defop 165 -1 byte-quo)
674 (byte-defop 166 -1 byte-rem)
675 (byte-defop 167 0 byte-numberp)
676 (byte-defop 168 0 byte-integerp)
678 ;; unused: 169-174
680 (byte-defop 175 nil byte-listN)
681 (byte-defop 176 nil byte-concatN)
682 (byte-defop 177 nil byte-insertN)
684 (byte-defop 178 -1 byte-stack-set) ; stack offset in following one byte
685 (byte-defop 179 -1 byte-stack-set2) ; stack offset in following two bytes
687 ;; if (following one byte & 0x80) == 0
688 ;; discard (following one byte & 0x7F) stack entries
689 ;; else
690 ;; discard (following one byte & 0x7F) stack entries _underneath_ the top of stack
691 ;; (that is, if the operand = 0x83, ... X Y Z T => ... T)
692 (byte-defop 182 nil byte-discardN)
693 ;; `byte-discardN-preserve-tos' is a pseudo-op that gets turned into
694 ;; `byte-discardN' with the high bit in the operand set (by
695 ;; `byte-compile-lapcode').
696 (defconst byte-discardN-preserve-tos byte-discardN)
698 ;; unused: 182-191
700 (byte-defop 192 1 byte-constant "for reference to a constant")
701 ;; codes 193-255 are consumed by byte-constant.
702 (defconst byte-constant-limit 64
703 "Exclusive maximum index usable in the `byte-constant' opcode.")
705 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
706 byte-goto-if-nil-else-pop
707 byte-goto-if-not-nil-else-pop)
708 "List of byte-codes whose offset is a pc.")
710 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
712 (byte-extrude-byte-code-vectors)
714 ;;; lapcode generator
716 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
717 ;; source -> bytecode, because it's a lot easier to make optimizations
718 ;; on lapcode than on bytecode.
720 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
721 ;; where instruction is a symbol naming a byte-code instruction,
722 ;; and parameter is an argument to that instruction, if any.
724 ;; The instruction can be the pseudo-op TAG, which means that this position
725 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
726 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
727 ;; parameter for some goto op.
729 ;; If the operation is varbind, varref, varset or push-constant, then the
730 ;; parameter is (variable/constant . index_in_constant_vector).
732 ;; First, the source code is macroexpanded and optimized in various ways.
733 ;; Then the resultant code is compiled into lapcode. Another set of
734 ;; optimizations are then run over the lapcode. Then the variables and
735 ;; constants referenced by the lapcode are collected and placed in the
736 ;; constants-vector. (This happens now so that variables referenced by dead
737 ;; code don't consume space.) And finally, the lapcode is transformed into
738 ;; compacted byte-code.
740 ;; A distinction is made between variables and constants because the variable-
741 ;; referencing instructions are more sensitive to the variables being near the
742 ;; front of the constants-vector than the constant-referencing instructions.
743 ;; Also, this lets us notice references to free variables.
745 (defmacro byte-compile-push-bytecodes (&rest args)
746 "Push BYTE... onto BYTES, and increment PC by the number of bytes pushed.
747 ARGS is of the form (BYTE... BYTES PC), where BYTES and PC are variable names.
748 BYTES and PC are updated after evaluating all the arguments."
749 (let ((byte-exprs (butlast args 2))
750 (bytes-var (car (last args 2)))
751 (pc-var (car (last args))))
752 `(setq ,bytes-var ,(if (null (cdr byte-exprs))
753 `(progn (assert (<= 0 ,(car byte-exprs)))
754 (cons ,@byte-exprs ,bytes-var))
755 `(nconc (list ,@(reverse byte-exprs)) ,bytes-var))
756 ,pc-var (+ ,(length byte-exprs) ,pc-var))))
758 (defmacro byte-compile-push-bytecode-const2 (opcode const2 bytes pc)
759 "Push OPCODE and the two-byte constant CONST2 onto BYTES, and add 3 to PC.
760 CONST2 may be evaulated multiple times."
761 `(byte-compile-push-bytecodes ,opcode (logand ,const2 255) (lsh ,const2 -8)
762 ,bytes ,pc))
764 (defun byte-compile-lapcode (lap)
765 "Turns lapcode into bytecode. The lapcode is destroyed."
766 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
767 (let ((pc 0) ; Program counter
768 op off ; Operation & offset
769 opcode ; numeric value of OP
770 (bytes '()) ; Put the output bytes here
771 (patchlist nil)) ; List of gotos to patch
772 (dolist (lap-entry lap)
773 (setq op (car lap-entry)
774 off (cdr lap-entry))
775 (cond
776 ((not (symbolp op))
777 (error "Non-symbolic opcode `%s'" op))
778 ((eq op 'TAG)
779 (setcar off pc))
780 ((null op)
781 ;; a no-op added by `byte-compile-delay-out'
782 (unless (zerop off)
783 (error
784 "Placeholder added by `byte-compile-delay-out' not filled in.")
787 (setq opcode
788 (if (eq op 'byte-discardN-preserve-tos)
789 ;; byte-discardN-preserve-tos is a pseudo op, which
790 ;; is actually the same as byte-discardN
791 ;; with a modified argument.
792 byte-discardN
793 (symbol-value op)))
794 (cond ((memq op byte-goto-ops)
795 ;; goto
796 (byte-compile-push-bytecodes opcode nil (cdr off) bytes pc)
797 (push bytes patchlist))
798 ((or (and (consp off)
799 ;; Variable or constant reference
800 (progn
801 (setq off (cdr off))
802 (eq op 'byte-constant)))
803 (and (eq op 'byte-constant) ;; 'byte-closed-var
804 (integerp off)))
805 ;; constant ref
806 (if (< off byte-constant-limit)
807 (byte-compile-push-bytecodes (+ byte-constant off)
808 bytes pc)
809 (byte-compile-push-bytecode-const2 byte-constant2 off
810 bytes pc)))
811 ((and (= opcode byte-stack-set)
812 (> off 255))
813 ;; Use the two-byte version of byte-stack-set if the
814 ;; offset is too large for the normal version.
815 (byte-compile-push-bytecode-const2 byte-stack-set2 off
816 bytes pc))
817 ((and (>= opcode byte-listN)
818 (< opcode byte-discardN))
819 ;; These insns all put their operand into one extra byte.
820 (byte-compile-push-bytecodes opcode off bytes pc))
821 ((= opcode byte-discardN)
822 ;; byte-discardN is weird in that it encodes a flag in the
823 ;; top bit of its one-byte argument. If the argument is
824 ;; too large to fit in 7 bits, the opcode can be repeated.
825 (let ((flag (if (eq op 'byte-discardN-preserve-tos) #x80 0)))
826 (while (> off #x7f)
827 (byte-compile-push-bytecodes opcode (logior #x7f flag) bytes pc)
828 (setq off (- off #x7f)))
829 (byte-compile-push-bytecodes opcode (logior off flag) bytes pc)))
830 ((null off)
831 ;; opcode that doesn't use OFF
832 (byte-compile-push-bytecodes opcode bytes pc))
833 ((and (eq opcode byte-stack-ref) (eq off 0))
834 ;; (stack-ref 0) is really just another name for `dup'.
835 (debug) ;FIXME: When would this happen?
836 (byte-compile-push-bytecodes byte-dup bytes pc))
837 ;; The following three cases are for the special
838 ;; insns that encode their operand into 0, 1, or 2
839 ;; extra bytes depending on its magnitude.
840 ((< off 6)
841 (byte-compile-push-bytecodes (+ opcode off) bytes pc))
842 ((< off 256)
843 (byte-compile-push-bytecodes (+ opcode 6) off bytes pc))
845 (byte-compile-push-bytecode-const2 (+ opcode 7) off
846 bytes pc))))))
847 ;;(if (not (= pc (length bytes)))
848 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
850 ;; Patch tag PCs into absolute jumps
851 (dolist (bytes-tail patchlist)
852 (setq pc (caar bytes-tail)) ; Pick PC from goto's tag
853 (setcar (cdr bytes-tail) (logand pc 255))
854 (setcar bytes-tail (lsh pc -8))
855 ;; FIXME: Replace this by some workaround.
856 (if (> (car bytes) 255) (error "Bytecode overflow")))
858 (apply 'unibyte-string (nreverse bytes))))
861 ;;; compile-time evaluation
863 (defun byte-compile-cl-file-p (file)
864 "Return non-nil if FILE is one of the CL files."
865 (and (stringp file)
866 (string-match "^cl\\>" (file-name-nondirectory file))))
868 (defun byte-compile-eval (form)
869 "Eval FORM and mark the functions defined therein.
870 Each function's symbol gets added to `byte-compile-noruntime-functions'."
871 (let ((hist-orig load-history)
872 (hist-nil-orig current-load-list))
873 (prog1 (eval form)
874 (when (byte-compile-warning-enabled-p 'noruntime)
875 (let ((hist-new load-history)
876 (hist-nil-new current-load-list))
877 ;; Go through load-history, look for newly loaded files
878 ;; and mark all the functions defined therein.
879 (while (and hist-new (not (eq hist-new hist-orig)))
880 (let ((xs (pop hist-new))
881 old-autoloads)
882 ;; Make sure the file was not already loaded before.
883 (unless (or (assoc (car xs) hist-orig)
884 ;; Don't give both the "noruntime" and
885 ;; "cl-functions" warning for the same function.
886 ;; FIXME This seems incorrect - these are two
887 ;; independent warnings. For example, you may be
888 ;; choosing to see the cl warnings but ignore them.
889 ;; You probably don't want to ignore noruntime in the
890 ;; same way.
891 (and (byte-compile-warning-enabled-p 'cl-functions)
892 (byte-compile-cl-file-p (car xs))))
893 (dolist (s xs)
894 (cond
895 ((symbolp s)
896 (unless (memq s old-autoloads)
897 (push s byte-compile-noruntime-functions)))
898 ((and (consp s) (eq t (car s)))
899 (push (cdr s) old-autoloads))
900 ((and (consp s) (eq 'autoload (car s)))
901 (push (cdr s) byte-compile-noruntime-functions)))))))
902 ;; Go through current-load-list for the locally defined funs.
903 (let (old-autoloads)
904 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
905 (let ((s (pop hist-nil-new)))
906 (when (and (symbolp s) (not (memq s old-autoloads)))
907 (push s byte-compile-noruntime-functions))
908 (when (and (consp s) (eq t (car s)))
909 (push (cdr s) old-autoloads)))))))
910 (when (byte-compile-warning-enabled-p 'cl-functions)
911 (let ((hist-new load-history))
912 ;; Go through load-history, looking for the cl files.
913 ;; Since new files are added at the start of load-history,
914 ;; we scan the new history until the tail matches the old.
915 (while (and (not byte-compile-cl-functions)
916 hist-new (not (eq hist-new hist-orig)))
917 ;; We used to check if the file had already been loaded,
918 ;; but it is better to check non-nil byte-compile-cl-functions.
919 (and (byte-compile-cl-file-p (car (pop hist-new)))
920 (byte-compile-find-cl-functions))))))))
922 (defun byte-compile-eval-before-compile (form)
923 "Evaluate FORM for `eval-and-compile'."
924 (let ((hist-nil-orig current-load-list))
925 (prog1 (eval form)
926 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
927 ;; FIXME Why does it do that - just as a hack?
928 ;; There are other ways to do this nowadays.
929 (let ((tem current-load-list))
930 (while (not (eq tem hist-nil-orig))
931 (when (equal (car tem) '(require . cl))
932 (byte-compile-disable-warning 'cl-functions))
933 (setq tem (cdr tem)))))))
935 ;;; byte compiler messages
937 (defvar byte-compile-current-form nil)
938 (defvar byte-compile-dest-file nil)
939 (defvar byte-compile-current-file nil)
940 (defvar byte-compile-current-group nil)
941 (defvar byte-compile-current-buffer nil)
943 ;; Log something that isn't a warning.
944 (defmacro byte-compile-log (format-string &rest args)
945 `(and
946 byte-optimize
947 (memq byte-optimize-log '(t source))
948 (let ((print-escape-newlines t)
949 (print-level 4)
950 (print-length 4))
951 (byte-compile-log-1
952 (format
953 ,format-string
954 ,@(mapcar
955 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
956 args))))))
958 ;; Log something that isn't a warning.
959 (defun byte-compile-log-1 (string)
960 (with-current-buffer byte-compile-log-buffer
961 (let ((inhibit-read-only t))
962 (goto-char (point-max))
963 (byte-compile-warning-prefix nil nil)
964 (cond (noninteractive
965 (message " %s" string))
967 (insert (format "%s\n" string)))))))
969 (defvar byte-compile-read-position nil
970 "Character position we began the last `read' from.")
971 (defvar byte-compile-last-position nil
972 "Last known character position in the input.")
974 ;; copied from gnus-util.el
975 (defsubst byte-compile-delete-first (elt list)
976 (if (eq (car list) elt)
977 (cdr list)
978 (let ((total list))
979 (while (and (cdr list)
980 (not (eq (cadr list) elt)))
981 (setq list (cdr list)))
982 (when (cdr list)
983 (setcdr list (cddr list)))
984 total)))
986 ;; The purpose of this function is to iterate through the
987 ;; `read-symbol-positions-list'. Each time we process, say, a
988 ;; function definition (`defun') we remove `defun' from
989 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
990 ;; to that symbol's character position. Similarly, if we encounter a
991 ;; variable reference, like in (1+ foo), we remove `foo' from the
992 ;; list. If our current position is after the symbol's position, we
993 ;; assume we've already passed that point, and look for the next
994 ;; occurrence of the symbol.
996 ;; This function should not be called twice for the same occurrence of
997 ;; a symbol, and it should not be called for symbols generated by the
998 ;; byte compiler itself; because rather than just fail looking up the
999 ;; symbol, we may find an occurrence of the symbol further ahead, and
1000 ;; then `byte-compile-last-position' as advanced too far.
1002 ;; So your're probably asking yourself: Isn't this function a
1003 ;; gross hack? And the answer, of course, would be yes.
1004 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
1005 (when byte-compile-read-position
1006 (let (last entry)
1007 (while (progn
1008 (setq last byte-compile-last-position
1009 entry (assq sym read-symbol-positions-list))
1010 (when entry
1011 (setq byte-compile-last-position
1012 (+ byte-compile-read-position (cdr entry))
1013 read-symbol-positions-list
1014 (byte-compile-delete-first
1015 entry read-symbol-positions-list)))
1016 (or (and allow-previous (not (= last byte-compile-last-position)))
1017 (> last byte-compile-last-position)))))))
1019 (defvar byte-compile-last-warned-form nil)
1020 (defvar byte-compile-last-logged-file nil)
1022 ;; This is used as warning-prefix for the compiler.
1023 ;; It is always called with the warnings buffer current.
1024 (defun byte-compile-warning-prefix (level entry)
1025 (let* ((inhibit-read-only t)
1026 (dir default-directory)
1027 (file (cond ((stringp byte-compile-current-file)
1028 (format "%s:" (file-relative-name byte-compile-current-file dir)))
1029 ((bufferp byte-compile-current-file)
1030 (format "Buffer %s:"
1031 (buffer-name byte-compile-current-file)))
1032 (t "")))
1033 (pos (if (and byte-compile-current-file
1034 (integerp byte-compile-read-position))
1035 (with-current-buffer byte-compile-current-buffer
1036 (format "%d:%d:"
1037 (save-excursion
1038 (goto-char byte-compile-last-position)
1039 (1+ (count-lines (point-min) (point-at-bol))))
1040 (save-excursion
1041 (goto-char byte-compile-last-position)
1042 (1+ (current-column)))))
1043 ""))
1044 (form (if (eq byte-compile-current-form :end) "end of data"
1045 (or byte-compile-current-form "toplevel form"))))
1046 (when (or (and byte-compile-current-file
1047 (not (equal byte-compile-current-file
1048 byte-compile-last-logged-file)))
1049 (and byte-compile-current-form
1050 (not (eq byte-compile-current-form
1051 byte-compile-last-warned-form))))
1052 (insert (format "\nIn %s:\n" form)))
1053 (when level
1054 (insert (format "%s%s" file pos))))
1055 (setq byte-compile-last-logged-file byte-compile-current-file
1056 byte-compile-last-warned-form byte-compile-current-form)
1057 entry)
1059 ;; This no-op function is used as the value of warning-series
1060 ;; to tell inner calls to displaying-byte-compile-warnings
1061 ;; not to bind warning-series.
1062 (defun byte-compile-warning-series (&rest ignore)
1063 nil)
1065 ;; (compile-mode) will cause this to be loaded.
1066 (declare-function compilation-forget-errors "compile" ())
1068 ;; Log the start of a file in `byte-compile-log-buffer', and mark it as done.
1069 ;; Return the position of the start of the page in the log buffer.
1070 ;; But do nothing in batch mode.
1071 (defun byte-compile-log-file ()
1072 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1073 (not noninteractive)
1074 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1075 (goto-char (point-max))
1076 (let* ((inhibit-read-only t)
1077 (dir (and byte-compile-current-file
1078 (file-name-directory byte-compile-current-file)))
1079 (was-same (equal default-directory dir))
1081 (when dir
1082 (unless was-same
1083 (insert (format "Leaving directory `%s'\n" default-directory))))
1084 (unless (bolp)
1085 (insert "\n"))
1086 (setq pt (point-marker))
1087 (if byte-compile-current-file
1088 (insert "\f\nCompiling "
1089 (if (stringp byte-compile-current-file)
1090 (concat "file " byte-compile-current-file)
1091 (concat "buffer " (buffer-name byte-compile-current-file)))
1092 " at " (current-time-string) "\n")
1093 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1094 (when dir
1095 (setq default-directory dir)
1096 (unless was-same
1097 (insert (format "Entering directory `%s'\n" default-directory))))
1098 (setq byte-compile-last-logged-file byte-compile-current-file
1099 byte-compile-last-warned-form nil)
1100 ;; Do this after setting default-directory.
1101 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1102 (compilation-forget-errors)
1103 pt))))
1105 ;; Log a message STRING in `byte-compile-log-buffer'.
1106 ;; Also log the current function and file if not already done.
1107 (defun byte-compile-log-warning (string &optional fill level)
1108 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1109 (warning-type-format "")
1110 (warning-fill-prefix (if fill " "))
1111 (inhibit-read-only t))
1112 (display-warning 'bytecomp string level byte-compile-log-buffer)))
1114 (defun byte-compile-warn (format &rest args)
1115 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1116 (setq format (apply 'format format args))
1117 (if byte-compile-error-on-warn
1118 (error "%s" format) ; byte-compile-file catches and logs it
1119 (byte-compile-log-warning format t :warning)))
1121 (defun byte-compile-warn-obsolete (symbol)
1122 "Warn that SYMBOL (a variable or function) is obsolete."
1123 (when (byte-compile-warning-enabled-p 'obsolete)
1124 (let* ((funcp (get symbol 'byte-obsolete-info))
1125 (obsolete (or funcp (get symbol 'byte-obsolete-variable)))
1126 (instead (car obsolete))
1127 (asof (if funcp (nth 2 obsolete) (cdr obsolete))))
1128 (unless (and funcp (memq symbol byte-compile-not-obsolete-funcs))
1129 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1130 (if funcp "function" "variable")
1131 (if asof (concat " (as of Emacs " asof ")") "")
1132 (cond ((stringp instead)
1133 (concat "; " instead))
1134 (instead
1135 (format "; use `%s' instead." instead))
1136 (t ".")))))))
1138 (defun byte-compile-report-error (error-info)
1139 "Report Lisp error in compilation. ERROR-INFO is the error data."
1140 (setq byte-compiler-error-flag t)
1141 (byte-compile-log-warning
1142 (error-message-string error-info)
1143 nil :error))
1145 ;;; sanity-checking arglists
1147 (defun byte-compile-fdefinition (name macro-p)
1148 ;; If a function has an entry saying (FUNCTION . t).
1149 ;; that means we know it is defined but we don't know how.
1150 ;; If a function has an entry saying (FUNCTION . nil),
1151 ;; that means treat it as not defined.
1152 (let* ((list (if macro-p
1153 byte-compile-macro-environment
1154 byte-compile-function-environment))
1155 (env (cdr (assq name list))))
1156 (or env
1157 (let ((fn name))
1158 (while (and (symbolp fn)
1159 (fboundp fn)
1160 (or (symbolp (symbol-function fn))
1161 (consp (symbol-function fn))
1162 (and (not macro-p)
1163 (byte-code-function-p (symbol-function fn)))))
1164 (setq fn (symbol-function fn)))
1165 (let ((advertised (gethash (if (and (symbolp fn) (fboundp fn))
1166 ;; Could be a subr.
1167 (symbol-function fn)
1169 advertised-signature-table t)))
1170 (cond
1171 ((listp advertised)
1172 (if macro-p
1173 `(macro lambda ,advertised)
1174 `(lambda ,advertised)))
1175 ((and (not macro-p) (byte-code-function-p fn)) fn)
1176 ((not (consp fn)) nil)
1177 ((eq 'macro (car fn)) (cdr fn))
1178 (macro-p nil)
1179 ((eq 'autoload (car fn)) nil)
1180 (t fn)))))))
1182 (defun byte-compile-arglist-signature (arglist)
1183 (let ((args 0)
1184 opts
1185 restp)
1186 (while arglist
1187 (cond ((eq (car arglist) '&optional)
1188 (or opts (setq opts 0)))
1189 ((eq (car arglist) '&rest)
1190 (if (cdr arglist)
1191 (setq restp t
1192 arglist nil)))
1194 (if opts
1195 (setq opts (1+ opts))
1196 (setq args (1+ args)))))
1197 (setq arglist (cdr arglist)))
1198 (cons args (if restp nil (if opts (+ args opts) args)))))
1201 (defun byte-compile-arglist-signatures-congruent-p (old new)
1202 (not (or
1203 (> (car new) (car old)) ; requires more args now
1204 (and (null (cdr old)) ; took rest-args, doesn't any more
1205 (cdr new))
1206 (and (cdr new) (cdr old) ; can't take as many args now
1207 (< (cdr new) (cdr old)))
1210 (defun byte-compile-arglist-signature-string (signature)
1211 (cond ((null (cdr signature))
1212 (format "%d+" (car signature)))
1213 ((= (car signature) (cdr signature))
1214 (format "%d" (car signature)))
1215 (t (format "%d-%d" (car signature) (cdr signature)))))
1218 ;; Warn if the form is calling a function with the wrong number of arguments.
1219 (defun byte-compile-callargs-warn (form)
1220 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1221 (byte-compile-fdefinition (car form) t)))
1222 (sig (if (and def (not (eq def t)))
1223 (progn
1224 (and (eq (car-safe def) 'macro)
1225 (eq (car-safe (cdr-safe def)) 'lambda)
1226 (setq def (cdr def)))
1227 (byte-compile-arglist-signature
1228 (if (memq (car-safe def) '(declared lambda))
1229 (nth 1 def)
1230 (if (byte-code-function-p def)
1231 (aref def 0)
1232 '(&rest def)))))
1233 (if (and (fboundp (car form))
1234 (subrp (symbol-function (car form))))
1235 (subr-arity (symbol-function (car form))))))
1236 (ncall (length (cdr form))))
1237 ;; Check many or unevalled from subr-arity.
1238 (if (and (cdr-safe sig)
1239 (not (numberp (cdr sig))))
1240 (setcdr sig nil))
1241 (if sig
1242 (when (or (< ncall (car sig))
1243 (and (cdr sig) (> ncall (cdr sig))))
1244 (byte-compile-set-symbol-position (car form))
1245 (byte-compile-warn
1246 "%s called with %d argument%s, but %s %s"
1247 (car form) ncall
1248 (if (= 1 ncall) "" "s")
1249 (if (< ncall (car sig))
1250 "requires"
1251 "accepts only")
1252 (byte-compile-arglist-signature-string sig))))
1253 (byte-compile-format-warn form)
1254 ;; Check to see if the function will be available at runtime
1255 ;; and/or remember its arity if it's unknown.
1256 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1257 (not (memq (car form) byte-compile-noruntime-functions)))
1258 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1259 ; with recursion.
1260 ;; It's a currently-undefined function.
1261 ;; Remember number of args in call.
1262 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1263 (n (length (cdr form))))
1264 (if cons
1265 (or (memq n (cdr cons))
1266 (setcdr cons (cons n (cdr cons))))
1267 (push (list (car form) n)
1268 byte-compile-unresolved-functions))))))
1270 (defun byte-compile-format-warn (form)
1271 "Warn if FORM is `format'-like with inconsistent args.
1272 Applies if head of FORM is a symbol with non-nil property
1273 `byte-compile-format-like' and first arg is a constant string.
1274 Then check the number of format fields matches the number of
1275 extra args."
1276 (when (and (symbolp (car form))
1277 (stringp (nth 1 form))
1278 (get (car form) 'byte-compile-format-like))
1279 (let ((nfields (with-temp-buffer
1280 (insert (nth 1 form))
1281 (goto-char (point-min))
1282 (let ((n 0))
1283 (while (re-search-forward "%." nil t)
1284 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1285 (setq n (1+ n))))
1286 n)))
1287 (nargs (- (length form) 2)))
1288 (unless (= nargs nfields)
1289 (byte-compile-warn
1290 "`%s' called with %d args to fill %d format field(s)" (car form)
1291 nargs nfields)))))
1293 (dolist (elt '(format message error))
1294 (put elt 'byte-compile-format-like t))
1296 ;; Warn if a custom definition fails to specify :group.
1297 (defun byte-compile-nogroup-warn (form)
1298 (if (and (memq (car form) '(custom-declare-face custom-declare-variable))
1299 byte-compile-current-group)
1300 ;; The group will be provided implicitly.
1302 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1303 (name (cadr form)))
1304 (or (not (eq (car-safe name) 'quote))
1305 (and (eq (car form) 'custom-declare-group)
1306 (equal name ''emacs))
1307 (plist-get keyword-args :group)
1308 (not (and (consp name) (eq (car name) 'quote)))
1309 (byte-compile-warn
1310 "%s for `%s' fails to specify containing group"
1311 (cdr (assq (car form)
1312 '((custom-declare-group . defgroup)
1313 (custom-declare-face . defface)
1314 (custom-declare-variable . defcustom))))
1315 (cadr name)))
1316 ;; Update the current group, if needed.
1317 (if (and byte-compile-current-file ;Only when byte-compiling a whole file.
1318 (eq (car form) 'custom-declare-group)
1319 (eq (car-safe name) 'quote))
1320 (setq byte-compile-current-group (cadr name))))))
1322 ;; Warn if the function or macro is being redefined with a different
1323 ;; number of arguments.
1324 (defun byte-compile-arglist-warn (form macrop)
1325 (let* ((name (nth 1 form))
1326 (old (byte-compile-fdefinition name macrop)))
1327 (if (and old (not (eq old t)))
1328 (progn
1329 (and (eq 'macro (car-safe old))
1330 (eq 'lambda (car-safe (cdr-safe old)))
1331 (setq old (cdr old)))
1332 (let ((sig1 (byte-compile-arglist-signature
1333 (pcase old
1334 (`(lambda ,args . ,_) args)
1335 (`(closure ,_ ,_ ,args . ,_) args)
1336 ((pred byte-code-function-p) (aref old 0))
1337 (t '(&rest def)))))
1338 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1339 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1340 (byte-compile-set-symbol-position name)
1341 (byte-compile-warn
1342 "%s %s used to take %s %s, now takes %s"
1343 (if (eq (car form) 'defun) "function" "macro")
1344 name
1345 (byte-compile-arglist-signature-string sig1)
1346 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1347 (byte-compile-arglist-signature-string sig2)))))
1348 ;; This is the first definition. See if previous calls are compatible.
1349 (let ((calls (assq name byte-compile-unresolved-functions))
1350 nums sig min max)
1351 (when calls
1352 (when (and (symbolp name)
1353 (eq (get name 'byte-optimizer)
1354 'byte-compile-inline-expand))
1355 (byte-compile-warn "defsubst `%s' was used before it was defined"
1356 name))
1357 (setq sig (byte-compile-arglist-signature (nth 2 form))
1358 nums (sort (copy-sequence (cdr calls)) (function <))
1359 min (car nums)
1360 max (car (nreverse nums)))
1361 (when (or (< min (car sig))
1362 (and (cdr sig) (> max (cdr sig))))
1363 (byte-compile-set-symbol-position name)
1364 (byte-compile-warn
1365 "%s being defined to take %s%s, but was previously called with %s"
1366 name
1367 (byte-compile-arglist-signature-string sig)
1368 (if (equal sig '(1 . 1)) " arg" " args")
1369 (byte-compile-arglist-signature-string (cons min max))))
1371 (setq byte-compile-unresolved-functions
1372 (delq calls byte-compile-unresolved-functions)))))))
1374 (defvar byte-compile-cl-functions nil
1375 "List of functions defined in CL.")
1377 ;; Can't just add this to cl-load-hook, because that runs just before
1378 ;; the forms from cl.el get added to load-history.
1379 (defun byte-compile-find-cl-functions ()
1380 (unless byte-compile-cl-functions
1381 (dolist (elt load-history)
1382 (and (byte-compile-cl-file-p (car elt))
1383 (dolist (e (cdr elt))
1384 ;; Includes the cl-foo functions that cl autoloads.
1385 (when (memq (car-safe e) '(autoload defun))
1386 (push (cdr e) byte-compile-cl-functions)))))))
1388 (defun byte-compile-cl-warn (form)
1389 "Warn if FORM is a call of a function from the CL package."
1390 (let ((func (car-safe form)))
1391 (if (and byte-compile-cl-functions
1392 (memq func byte-compile-cl-functions)
1393 ;; Aliases which won't have been expanded at this point.
1394 ;; These aren't all aliases of subrs, so not trivial to
1395 ;; avoid hardwiring the list.
1396 (not (memq func
1397 '(cl-block-wrapper cl-block-throw
1398 multiple-value-call nth-value
1399 copy-seq first second rest endp cl-member
1400 ;; These are included in generated code
1401 ;; that can't be called except at compile time
1402 ;; or unless cl is loaded anyway.
1403 cl-defsubst-expand cl-struct-setf-expander
1404 ;; These would sometimes be warned about
1405 ;; but such warnings are never useful,
1406 ;; so don't warn about them.
1407 macroexpand cl-macroexpand-all
1408 cl-compiling-file))))
1409 (byte-compile-warn "function `%s' from cl package called at runtime"
1410 func)))
1411 form)
1413 (defun byte-compile-print-syms (str1 strn syms)
1414 (when syms
1415 (byte-compile-set-symbol-position (car syms) t))
1416 (cond ((and (cdr syms) (not noninteractive))
1417 (let* ((str strn)
1418 (L (length str))
1420 (while syms
1421 (setq s (symbol-name (pop syms))
1422 L (+ L (length s) 2))
1423 (if (< L (1- fill-column))
1424 (setq str (concat str " " s (and syms ",")))
1425 (setq str (concat str "\n " s (and syms ","))
1426 L (+ (length s) 4))))
1427 (byte-compile-warn "%s" str)))
1428 ((cdr syms)
1429 (byte-compile-warn "%s %s"
1430 strn
1431 (mapconcat #'symbol-name syms ", ")))
1433 (syms
1434 (byte-compile-warn str1 (car syms)))))
1436 ;; If we have compiled any calls to functions which are not known to be
1437 ;; defined, issue a warning enumerating them.
1438 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1439 (defun byte-compile-warn-about-unresolved-functions ()
1440 (when (byte-compile-warning-enabled-p 'unresolved)
1441 (let ((byte-compile-current-form :end)
1442 (noruntime nil)
1443 (unresolved nil))
1444 ;; Separate the functions that will not be available at runtime
1445 ;; from the truly unresolved ones.
1446 (dolist (f byte-compile-unresolved-functions)
1447 (setq f (car f))
1448 (if (fboundp f) (push f noruntime) (push f unresolved)))
1449 ;; Complain about the no-run-time functions
1450 (byte-compile-print-syms
1451 "the function `%s' might not be defined at runtime."
1452 "the following functions might not be defined at runtime:"
1453 noruntime)
1454 ;; Complain about the unresolved functions
1455 (byte-compile-print-syms
1456 "the function `%s' is not known to be defined."
1457 "the following functions are not known to be defined:"
1458 unresolved)))
1459 nil)
1462 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1463 "Non-nil if SYMBOL is constant.
1464 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1465 symbol itself."
1466 (or (memq symbol '(nil t))
1467 (keywordp symbol)
1468 (if any-value
1469 (or (memq symbol byte-compile-const-variables)
1470 ;; FIXME: We should provide a less intrusive way to find out
1471 ;; if a variable is "constant".
1472 (and (boundp symbol)
1473 (condition-case nil
1474 (progn (set symbol (symbol-value symbol)) nil)
1475 (setting-constant t)))))))
1477 (defmacro byte-compile-constp (form)
1478 "Return non-nil if FORM is a constant."
1479 `(cond ((consp ,form) (eq (car ,form) 'quote))
1480 ((not (symbolp ,form)))
1481 ((byte-compile-const-symbol-p ,form))))
1483 (defmacro byte-compile-close-variables (&rest body)
1484 (declare (debug t))
1485 (cons 'let
1486 (cons '(;;
1487 ;; Close over these variables to encapsulate the
1488 ;; compilation state
1490 (byte-compile-macro-environment
1491 ;; Copy it because the compiler may patch into the
1492 ;; macroenvironment.
1493 (copy-alist byte-compile-initial-macro-environment))
1494 (byte-compile-function-environment nil)
1495 (byte-compile-bound-variables nil)
1496 (byte-compile-const-variables nil)
1497 (byte-compile-free-references nil)
1498 (byte-compile-free-assignments nil)
1500 ;; Close over these variables so that `byte-compiler-options'
1501 ;; can change them on a per-file basis.
1503 (byte-compile-verbose byte-compile-verbose)
1504 (byte-optimize byte-optimize)
1505 (byte-compile-dynamic byte-compile-dynamic)
1506 (byte-compile-dynamic-docstrings
1507 byte-compile-dynamic-docstrings)
1508 ;; (byte-compile-generate-emacs19-bytecodes
1509 ;; byte-compile-generate-emacs19-bytecodes)
1510 (byte-compile-warnings byte-compile-warnings)
1512 body)))
1514 (defmacro displaying-byte-compile-warnings (&rest body)
1515 (declare (debug t))
1516 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1517 (warning-series-started
1518 (and (markerp warning-series)
1519 (eq (marker-buffer warning-series)
1520 (get-buffer byte-compile-log-buffer)))))
1521 (byte-compile-find-cl-functions)
1522 (if (or (eq warning-series 'byte-compile-warning-series)
1523 warning-series-started)
1524 ;; warning-series does come from compilation,
1525 ;; so don't bind it, but maybe do set it.
1526 (let (tem)
1527 ;; Log the file name. Record position of that text.
1528 (setq tem (byte-compile-log-file))
1529 (unless warning-series-started
1530 (setq warning-series (or tem 'byte-compile-warning-series)))
1531 (if byte-compile-debug
1532 (funcall --displaying-byte-compile-warnings-fn)
1533 (condition-case error-info
1534 (funcall --displaying-byte-compile-warnings-fn)
1535 (error (byte-compile-report-error error-info)))))
1536 ;; warning-series does not come from compilation, so bind it.
1537 (let ((warning-series
1538 ;; Log the file name. Record position of that text.
1539 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1540 (if byte-compile-debug
1541 (funcall --displaying-byte-compile-warnings-fn)
1542 (condition-case error-info
1543 (funcall --displaying-byte-compile-warnings-fn)
1544 (error (byte-compile-report-error error-info))))))))
1546 ;;;###autoload
1547 (defun byte-force-recompile (directory)
1548 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1549 Files in subdirectories of DIRECTORY are processed also."
1550 (interactive "DByte force recompile (directory): ")
1551 (byte-recompile-directory directory nil t))
1553 ;; The `bytecomp-' prefix is applied to all local variables with
1554 ;; otherwise common names in this and similar functions for the sake
1555 ;; of the boundp test in byte-compile-variable-ref.
1556 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg00237.html
1557 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00134.html
1558 ;; Note that similar considerations apply to command-line-1 in startup.el.
1559 ;;;###autoload
1560 (defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
1561 bytecomp-force)
1562 "Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
1563 This happens when a `.elc' file exists but is older than the `.el' file.
1564 Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
1566 If the `.elc' file does not exist, normally this function *does not*
1567 compile the corresponding `.el' file. However, if the prefix argument
1568 BYTECOMP-ARG is 0, that means do compile all those files. A nonzero
1569 BYTECOMP-ARG means ask the user, for each such `.el' file, whether to
1570 compile it. A nonzero BYTECOMP-ARG also means ask about each subdirectory
1571 before scanning it.
1573 If the third argument BYTECOMP-FORCE is non-nil, recompile every `.el' file
1574 that already has a `.elc' file."
1575 (interactive "DByte recompile directory: \nP")
1576 (if bytecomp-arg
1577 (setq bytecomp-arg (prefix-numeric-value bytecomp-arg)))
1578 (if noninteractive
1580 (save-some-buffers)
1581 (force-mode-line-update))
1582 (with-current-buffer (get-buffer-create byte-compile-log-buffer)
1583 (setq default-directory (expand-file-name bytecomp-directory))
1584 ;; compilation-mode copies value of default-directory.
1585 (unless (eq major-mode 'compilation-mode)
1586 (compilation-mode))
1587 (let ((bytecomp-directories (list default-directory))
1588 (default-directory default-directory)
1589 (skip-count 0)
1590 (fail-count 0)
1591 (file-count 0)
1592 (dir-count 0)
1593 last-dir)
1594 (displaying-byte-compile-warnings
1595 (while bytecomp-directories
1596 (setq bytecomp-directory (car bytecomp-directories))
1597 (message "Checking %s..." bytecomp-directory)
1598 (let ((bytecomp-files (directory-files bytecomp-directory))
1599 bytecomp-source bytecomp-dest)
1600 (dolist (bytecomp-file bytecomp-files)
1601 (setq bytecomp-source
1602 (expand-file-name bytecomp-file bytecomp-directory))
1603 (if (and (not (member bytecomp-file '("RCS" "CVS")))
1604 (not (eq ?\. (aref bytecomp-file 0)))
1605 (file-directory-p bytecomp-source)
1606 (not (file-symlink-p bytecomp-source)))
1607 ;; This file is a subdirectory. Handle them differently.
1608 (when (or (null bytecomp-arg)
1609 (eq 0 bytecomp-arg)
1610 (y-or-n-p (concat "Check " bytecomp-source "? ")))
1611 (setq bytecomp-directories
1612 (nconc bytecomp-directories (list bytecomp-source))))
1613 ;; It is an ordinary file. Decide whether to compile it.
1614 (if (and (string-match emacs-lisp-file-regexp bytecomp-source)
1615 (file-readable-p bytecomp-source)
1616 (not (auto-save-file-name-p bytecomp-source))
1617 (not (string-equal dir-locals-file
1618 (file-name-nondirectory
1619 bytecomp-source))))
1620 (progn (let ((bytecomp-res (byte-recompile-file
1621 bytecomp-source
1622 bytecomp-force bytecomp-arg)))
1623 (cond ((eq bytecomp-res 'no-byte-compile)
1624 (setq skip-count (1+ skip-count)))
1625 ((eq bytecomp-res t)
1626 (setq file-count (1+ file-count)))
1627 ((eq bytecomp-res nil)
1628 (setq fail-count (1+ fail-count)))))
1629 (or noninteractive
1630 (message "Checking %s..." bytecomp-directory))
1631 (if (not (eq last-dir bytecomp-directory))
1632 (setq last-dir bytecomp-directory
1633 dir-count (1+ dir-count)))
1634 )))))
1635 (setq bytecomp-directories (cdr bytecomp-directories))))
1636 (message "Done (Total of %d file%s compiled%s%s%s)"
1637 file-count (if (= file-count 1) "" "s")
1638 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1639 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1640 (if (> dir-count 1)
1641 (format " in %d directories" dir-count) "")))))
1643 (defvar no-byte-compile nil
1644 "Non-nil to prevent byte-compiling of Emacs Lisp code.
1645 This is normally set in local file variables at the end of the elisp file:
1647 \;; Local Variables:\n;; no-byte-compile: t\n;; End: ") ;Backslash for compile-main.
1648 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1650 (defun byte-recompile-file (bytecomp-filename &optional bytecomp-force bytecomp-arg load)
1651 "Recompile BYTECOMP-FILENAME file if it needs recompilation.
1652 This happens when its `.elc' file is older than itself.
1654 If the `.elc' file exists and is up-to-date, normally this
1655 function *does not* compile BYTECOMP-FILENAME. However, if the
1656 prefix argument BYTECOMP-FORCE is set, that means do compile
1657 BYTECOMP-FILENAME even if the destination already exists and is
1658 up-to-date.
1660 If the `.elc' file does not exist, normally this function *does
1661 not* compile BYTECOMP-FILENAME. If BYTECOMP-ARG is 0, that means
1662 compile the file even if it has never been compiled before.
1663 A nonzero BYTECOMP-ARG means ask the user.
1665 If LOAD is set, `load' the file after compiling.
1667 The value returned is the value returned by `byte-compile-file',
1668 or 'no-byte-compile if the file did not need recompilation."
1669 (interactive
1670 (let ((bytecomp-file buffer-file-name)
1671 (bytecomp-file-name nil)
1672 (bytecomp-file-dir nil))
1673 (and bytecomp-file
1674 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1675 'emacs-lisp-mode)
1676 (setq bytecomp-file-name (file-name-nondirectory bytecomp-file)
1677 bytecomp-file-dir (file-name-directory bytecomp-file)))
1678 (list (read-file-name (if current-prefix-arg
1679 "Byte compile file: "
1680 "Byte recompile file: ")
1681 bytecomp-file-dir bytecomp-file-name nil)
1682 current-prefix-arg)))
1683 (let ((bytecomp-dest
1684 (byte-compile-dest-file bytecomp-filename))
1685 ;; Expand now so we get the current buffer's defaults
1686 (bytecomp-filename (expand-file-name bytecomp-filename)))
1687 (if (if (file-exists-p bytecomp-dest)
1688 ;; File was already compiled
1689 ;; Compile if forced to, or filename newer
1690 (or bytecomp-force
1691 (file-newer-than-file-p bytecomp-filename
1692 bytecomp-dest))
1693 (and bytecomp-arg
1694 (or (eq 0 bytecomp-arg)
1695 (y-or-n-p (concat "Compile "
1696 bytecomp-filename "? ")))))
1697 (progn
1698 (if (and noninteractive (not byte-compile-verbose))
1699 (message "Compiling %s..." bytecomp-filename))
1700 (byte-compile-file bytecomp-filename load))
1701 (when load (load bytecomp-filename))
1702 'no-byte-compile)))
1704 ;;;###autoload
1705 (defun byte-compile-file (bytecomp-filename &optional load)
1706 "Compile a file of Lisp code named BYTECOMP-FILENAME into a file of byte code.
1707 The output file's name is generated by passing BYTECOMP-FILENAME to the
1708 function `byte-compile-dest-file' (which see).
1709 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1710 The value is non-nil if there were no errors, nil if errors."
1711 ;; (interactive "fByte compile file: \nP")
1712 (interactive
1713 (let ((bytecomp-file buffer-file-name)
1714 (bytecomp-file-name nil)
1715 (bytecomp-file-dir nil))
1716 (and bytecomp-file
1717 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1718 'emacs-lisp-mode)
1719 (setq bytecomp-file-name (file-name-nondirectory bytecomp-file)
1720 bytecomp-file-dir (file-name-directory bytecomp-file)))
1721 (list (read-file-name (if current-prefix-arg
1722 "Byte compile and load file: "
1723 "Byte compile file: ")
1724 bytecomp-file-dir bytecomp-file-name nil)
1725 current-prefix-arg)))
1726 ;; Expand now so we get the current buffer's defaults
1727 (setq bytecomp-filename (expand-file-name bytecomp-filename))
1729 ;; If we're compiling a file that's in a buffer and is modified, offer
1730 ;; to save it first.
1731 (or noninteractive
1732 (let ((b (get-file-buffer (expand-file-name bytecomp-filename))))
1733 (if (and b (buffer-modified-p b)
1734 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1735 (with-current-buffer b (save-buffer)))))
1737 ;; Force logging of the file name for each file compiled.
1738 (setq byte-compile-last-logged-file nil)
1739 (let ((byte-compile-current-file bytecomp-filename)
1740 (byte-compile-current-group nil)
1741 (set-auto-coding-for-load t)
1742 target-file input-buffer output-buffer
1743 byte-compile-dest-file)
1744 (setq target-file (byte-compile-dest-file bytecomp-filename))
1745 (setq byte-compile-dest-file target-file)
1746 (with-current-buffer
1747 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1748 (erase-buffer)
1749 (setq buffer-file-coding-system nil)
1750 ;; Always compile an Emacs Lisp file as multibyte
1751 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1752 (set-buffer-multibyte t)
1753 (insert-file-contents bytecomp-filename)
1754 ;; Mimic the way after-insert-file-set-coding can make the
1755 ;; buffer unibyte when visiting this file.
1756 (when (or (eq last-coding-system-used 'no-conversion)
1757 (eq (coding-system-type last-coding-system-used) 5))
1758 ;; For coding systems no-conversion and raw-text...,
1759 ;; edit the buffer as unibyte.
1760 (set-buffer-multibyte nil))
1761 ;; Run hooks including the uncompression hook.
1762 ;; If they change the file name, then change it for the output also.
1763 (letf ((buffer-file-name bytecomp-filename)
1764 ((default-value 'major-mode) 'emacs-lisp-mode)
1765 ;; Ignore unsafe local variables.
1766 ;; We only care about a few of them for our purposes.
1767 (enable-local-variables :safe)
1768 (enable-local-eval nil))
1769 ;; Arg of t means don't alter enable-local-variables.
1770 (normal-mode t)
1771 (setq bytecomp-filename buffer-file-name))
1772 ;; Set the default directory, in case an eval-when-compile uses it.
1773 (setq default-directory (file-name-directory bytecomp-filename)))
1774 ;; Check if the file's local variables explicitly specify not to
1775 ;; compile this file.
1776 (if (with-current-buffer input-buffer no-byte-compile)
1777 (progn
1778 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1779 ;; (file-relative-name bytecomp-filename)
1780 ;; (with-current-buffer input-buffer no-byte-compile))
1781 (when (file-exists-p target-file)
1782 (message "%s deleted because of `no-byte-compile: %s'"
1783 (file-relative-name target-file)
1784 (buffer-local-value 'no-byte-compile input-buffer))
1785 (condition-case nil (delete-file target-file) (error nil)))
1786 ;; We successfully didn't compile this file.
1787 'no-byte-compile)
1788 (when byte-compile-verbose
1789 (message "Compiling %s..." bytecomp-filename))
1790 (setq byte-compiler-error-flag nil)
1791 ;; It is important that input-buffer not be current at this call,
1792 ;; so that the value of point set in input-buffer
1793 ;; within byte-compile-from-buffer lingers in that buffer.
1794 (setq output-buffer
1795 (save-current-buffer
1796 (byte-compile-from-buffer input-buffer bytecomp-filename)))
1797 (if byte-compiler-error-flag
1799 (when byte-compile-verbose
1800 (message "Compiling %s...done" bytecomp-filename))
1801 (kill-buffer input-buffer)
1802 (with-current-buffer output-buffer
1803 (goto-char (point-max))
1804 (insert "\n") ; aaah, unix.
1805 (if (file-writable-p target-file)
1806 ;; We must disable any code conversion here.
1807 (let* ((coding-system-for-write 'no-conversion)
1808 ;; Write to a tempfile so that if another Emacs
1809 ;; process is trying to load target-file (eg in a
1810 ;; parallel bootstrap), it does not risk getting a
1811 ;; half-finished file. (Bug#4196)
1812 (tempfile (make-temp-name target-file))
1813 (kill-emacs-hook
1814 (cons (lambda () (ignore-errors (delete-file tempfile)))
1815 kill-emacs-hook)))
1816 (if (memq system-type '(ms-dos 'windows-nt))
1817 (setq buffer-file-type t))
1818 (write-region (point-min) (point-max) tempfile nil 1)
1819 ;; This has the intentional side effect that any
1820 ;; hard-links to target-file continue to
1821 ;; point to the old file (this makes it possible
1822 ;; for installed files to share disk space with
1823 ;; the build tree, without causing problems when
1824 ;; emacs-lisp files in the build tree are
1825 ;; recompiled). Previously this was accomplished by
1826 ;; deleting target-file before writing it.
1827 (rename-file tempfile target-file t)
1828 (message "Wrote %s" target-file))
1829 ;; This is just to give a better error message than write-region
1830 (signal 'file-error
1831 (list "Opening output file"
1832 (if (file-exists-p target-file)
1833 "cannot overwrite file"
1834 "directory not writable or nonexistent")
1835 target-file)))
1836 (kill-buffer (current-buffer)))
1837 (if (and byte-compile-generate-call-tree
1838 (or (eq t byte-compile-generate-call-tree)
1839 (y-or-n-p (format "Report call tree for %s? "
1840 bytecomp-filename))))
1841 (save-excursion
1842 (display-call-tree bytecomp-filename)))
1843 (if load
1844 (load target-file))
1845 t))))
1847 ;;; compiling a single function
1848 ;;;###autoload
1849 (defun compile-defun (&optional arg)
1850 "Compile and evaluate the current top-level form.
1851 Print the result in the echo area.
1852 With argument ARG, insert value in current buffer after the form."
1853 (interactive "P")
1854 (save-excursion
1855 (end-of-defun)
1856 (beginning-of-defun)
1857 (let* ((byte-compile-current-file nil)
1858 (byte-compile-current-buffer (current-buffer))
1859 (byte-compile-read-position (point))
1860 (byte-compile-last-position byte-compile-read-position)
1861 (byte-compile-last-warned-form 'nothing)
1862 (value (eval
1863 (let ((read-with-symbol-positions (current-buffer))
1864 (read-symbol-positions-list nil))
1865 (displaying-byte-compile-warnings
1866 (byte-compile-sexp (read (current-buffer))))))))
1867 (cond (arg
1868 (message "Compiling from buffer... done.")
1869 (prin1 value (current-buffer))
1870 (insert "\n"))
1871 ((message "%s" (prin1-to-string value)))))))
1874 (defun byte-compile-from-buffer (bytecomp-inbuffer &optional bytecomp-filename)
1875 ;; Filename is used for the loading-into-Emacs-18 error message.
1876 (let (bytecomp-outbuffer
1877 (byte-compile-current-buffer bytecomp-inbuffer)
1878 (byte-compile-read-position nil)
1879 (byte-compile-last-position nil)
1880 ;; Prevent truncation of flonums and lists as we read and print them
1881 (float-output-format nil)
1882 (case-fold-search nil)
1883 (print-length nil)
1884 (print-level nil)
1885 ;; Prevent edebug from interfering when we compile
1886 ;; and put the output into a file.
1887 ;; (edebug-all-defs nil)
1888 ;; (edebug-all-forms nil)
1889 ;; Simulate entry to byte-compile-top-level
1890 (byte-compile-constants nil)
1891 (byte-compile-variables nil)
1892 (byte-compile-tag-number 0)
1893 (byte-compile-depth 0)
1894 (byte-compile-maxdepth 0)
1895 (byte-compile-output nil)
1896 ;; This allows us to get the positions of symbols read; it's
1897 ;; new in Emacs 22.1.
1898 (read-with-symbol-positions bytecomp-inbuffer)
1899 (read-symbol-positions-list nil)
1900 ;; #### This is bound in b-c-close-variables.
1901 ;; (byte-compile-warnings byte-compile-warnings)
1903 (byte-compile-close-variables
1904 (with-current-buffer
1905 (setq bytecomp-outbuffer (get-buffer-create " *Compiler Output*"))
1906 (set-buffer-multibyte t)
1907 (erase-buffer)
1908 ;; (emacs-lisp-mode)
1909 (setq case-fold-search nil))
1910 (displaying-byte-compile-warnings
1911 (with-current-buffer bytecomp-inbuffer
1912 (and bytecomp-filename
1913 (byte-compile-insert-header bytecomp-filename bytecomp-outbuffer))
1914 (goto-char (point-min))
1915 ;; Should we always do this? When calling multiple files, it
1916 ;; would be useful to delay this warning until all have been
1917 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1918 ;; previous byte-compile.
1919 (setq byte-compile-unresolved-functions nil)
1921 ;; Compile the forms from the input buffer.
1922 (while (progn
1923 (while (progn (skip-chars-forward " \t\n\^l")
1924 (looking-at ";"))
1925 (forward-line 1))
1926 (not (eobp)))
1927 (setq byte-compile-read-position (point)
1928 byte-compile-last-position byte-compile-read-position)
1929 (let* ((old-style-backquotes nil)
1930 (form (read bytecomp-inbuffer)))
1931 ;; Warn about the use of old-style backquotes.
1932 (when old-style-backquotes
1933 (byte-compile-warn "!! The file uses old-style backquotes !!
1934 This functionality has been obsolete for more than 10 years already
1935 and will be removed soon. See (elisp)Backquote in the manual."))
1936 (byte-compile-toplevel-file-form form)))
1937 ;; Compile pending forms at end of file.
1938 (byte-compile-flush-pending)
1939 ;; Make warnings about unresolved functions
1940 ;; give the end of the file as their position.
1941 (setq byte-compile-last-position (point-max))
1942 (byte-compile-warn-about-unresolved-functions))
1943 ;; Fix up the header at the front of the output
1944 ;; if the buffer contains multibyte characters.
1945 (and bytecomp-filename
1946 (with-current-buffer bytecomp-outbuffer
1947 (byte-compile-fix-header bytecomp-filename)))))
1948 bytecomp-outbuffer))
1950 (defun byte-compile-fix-header (filename)
1951 "If the current buffer has any multibyte characters, insert a version test."
1952 (when (< (point-max) (position-bytes (point-max)))
1953 (goto-char (point-min))
1954 ;; Find the comment that describes the version condition.
1955 (search-forward "\n;;; This file uses")
1956 (narrow-to-region (line-beginning-position) (point-max))
1957 ;; Find the first line of ballast semicolons.
1958 (search-forward ";;;;;;;;;;")
1959 (beginning-of-line)
1960 (narrow-to-region (point-min) (point))
1961 (let ((old-header-end (point))
1962 (minimum-version "23")
1963 delta)
1964 (delete-region (point-min) (point-max))
1965 (insert
1966 ";;; This file contains utf-8 non-ASCII characters,\n"
1967 ";;; and so cannot be loaded into Emacs 22 or earlier.\n"
1968 ;; Have to check if emacs-version is bound so that this works
1969 ;; in files loaded early in loadup.el.
1970 "(and (boundp 'emacs-version)\n"
1971 ;; If there is a name at the end of emacs-version,
1972 ;; don't try to check the version number.
1973 " (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
1974 (format " (string-lessp emacs-version \"%s\")\n" minimum-version)
1975 " (error \"`"
1976 ;; prin1-to-string is used to quote backslashes.
1977 (substring (prin1-to-string (file-name-nondirectory filename))
1978 1 -1)
1979 (format "' was compiled for Emacs %s or later\"))\n\n"
1980 minimum-version))
1981 ;; Now compensate for any change in size, to make sure all
1982 ;; positions in the file remain valid.
1983 (setq delta (- (point-max) old-header-end))
1984 (goto-char (point-max))
1985 (widen)
1986 (delete-char delta))))
1988 (defun byte-compile-insert-header (filename outbuffer)
1989 "Insert a header at the start of OUTBUFFER.
1990 Call from the source buffer."
1991 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1992 (dynamic byte-compile-dynamic)
1993 (optimize byte-optimize))
1994 (with-current-buffer outbuffer
1995 (goto-char (point-min))
1996 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1997 ;; that is the file-format version number (18, 19, 20, or 23) as a
1998 ;; byte, followed by some nulls. The primary motivation for doing
1999 ;; this is to get some binary characters up in the first line of
2000 ;; the file so that `diff' will simply say "Binary files differ"
2001 ;; instead of actually doing a diff of two .elc files. An extra
2002 ;; benefit is that you can add this to /etc/magic:
2003 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
2004 ;; >4 byte x version %d
2005 (insert
2006 ";ELC" 23 "\000\000\000\n"
2007 ";;; Compiled by "
2008 (or (and (boundp 'user-mail-address) user-mail-address)
2009 (concat (user-login-name) "@" (system-name)))
2010 " on " (current-time-string) "\n"
2011 ";;; from file " filename "\n"
2012 ";;; in Emacs version " emacs-version "\n"
2013 ";;; with"
2014 (cond
2015 ((eq optimize 'source) " source-level optimization only")
2016 ((eq optimize 'byte) " byte-level optimization only")
2017 (optimize " all optimizations")
2018 (t "out optimization"))
2019 ".\n"
2020 (if dynamic ";;; Function definitions are lazy-loaded.\n"
2022 "\n;;; This file uses "
2023 (if dynamic-docstrings
2024 "dynamic docstrings, first added in Emacs 19.29"
2025 "opcodes that do not exist in Emacs 18")
2026 ".\n\n"
2027 ;; Note that byte-compile-fix-header may change this.
2028 ";;; This file does not contain utf-8 non-ASCII characters,\n"
2029 ";;; and so can be loaded in Emacs versions earlier than 23.\n\n"
2030 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2031 ;; can delete them so as to keep the buffer positions
2032 ;; constant for the actual compiled code.
2033 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n"
2034 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))))
2036 ;; Dynamically bound in byte-compile-from-buffer.
2037 ;; NB also used in cl.el and cl-macs.el.
2038 (defvar bytecomp-outbuffer)
2040 (defun byte-compile-output-file-form (form)
2041 ;; writes the given form to the output buffer, being careful of docstrings
2042 ;; in defun, defmacro, defvar, defvaralias, defconst, autoload and
2043 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2044 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2045 ;; it does not pay to first build the defalias in defmumble and then parse
2046 ;; it here.
2047 (if (and (memq (car-safe form) '(defun defmacro defvar defvaralias defconst
2048 autoload custom-declare-variable))
2049 (stringp (nth 3 form)))
2050 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
2051 (memq (car form)
2052 '(defvaralias autoload
2053 custom-declare-variable)))
2054 (let ((print-escape-newlines t)
2055 (print-length nil)
2056 (print-level nil)
2057 (print-quoted t)
2058 (print-gensym t)
2059 (print-circle ; handle circular data structures
2060 (not byte-compile-disable-print-circle)))
2061 (princ "\n" bytecomp-outbuffer)
2062 (prin1 form bytecomp-outbuffer)
2063 nil)))
2065 (defvar print-gensym-alist) ;Used before print-circle existed.
2067 (defun byte-compile-output-docform (preface name info form specindex quoted)
2068 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2069 If PREFACE and NAME are non-nil, print them too,
2070 before INFO and the FORM but after the doc string itself.
2071 If SPECINDEX is non-nil, it is the index in FORM
2072 of the function bytecode string. In that case,
2073 we output that argument and the following argument
2074 \(the constants vector) together, for lazy loading.
2075 QUOTED says that we have to put a quote before the
2076 list that represents a doc string reference.
2077 `defvaralias', `autoload' and `custom-declare-variable' need that."
2078 ;; We need to examine byte-compile-dynamic-docstrings
2079 ;; in the input buffer (now current), not in the output buffer.
2080 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2081 (with-current-buffer bytecomp-outbuffer
2082 (let (position)
2084 ;; Insert the doc string, and make it a comment with #@LENGTH.
2085 (and (>= (nth 1 info) 0)
2086 dynamic-docstrings
2087 (progn
2088 ;; Make the doc string start at beginning of line
2089 ;; for make-docfile's sake.
2090 (insert "\n")
2091 (setq position
2092 (byte-compile-output-as-comment
2093 (nth (nth 1 info) form) nil))
2094 (setq position (- (position-bytes position) (point-min) -1))
2095 ;; If the doc string starts with * (a user variable),
2096 ;; negate POSITION.
2097 (if (and (stringp (nth (nth 1 info) form))
2098 (> (length (nth (nth 1 info) form)) 0)
2099 (eq (aref (nth (nth 1 info) form) 0) ?*))
2100 (setq position (- position)))))
2102 (if preface
2103 (progn
2104 (insert preface)
2105 (prin1 name bytecomp-outbuffer)))
2106 (insert (car info))
2107 (let ((print-escape-newlines t)
2108 (print-quoted t)
2109 ;; For compatibility with code before print-circle,
2110 ;; use a cons cell to say that we want
2111 ;; print-gensym-alist not to be cleared
2112 ;; between calls to print functions.
2113 (print-gensym '(t))
2114 (print-circle ; handle circular data structures
2115 (not byte-compile-disable-print-circle))
2116 print-gensym-alist ; was used before print-circle existed.
2117 (print-continuous-numbering t)
2118 print-number-table
2119 (index 0))
2120 (prin1 (car form) bytecomp-outbuffer)
2121 (while (setq form (cdr form))
2122 (setq index (1+ index))
2123 (insert " ")
2124 (cond ((and (numberp specindex) (= index specindex)
2125 ;; Don't handle the definition dynamically
2126 ;; if it refers (or might refer)
2127 ;; to objects already output
2128 ;; (for instance, gensyms in the arg list).
2129 (let (non-nil)
2130 (when (hash-table-p print-number-table)
2131 (maphash (lambda (k v) (if v (setq non-nil t)))
2132 print-number-table))
2133 (not non-nil)))
2134 ;; Output the byte code and constants specially
2135 ;; for lazy dynamic loading.
2136 (let ((position
2137 (byte-compile-output-as-comment
2138 (cons (car form) (nth 1 form))
2139 t)))
2140 (setq position (- (position-bytes position) (point-min) -1))
2141 (princ (format "(#$ . %d) nil" position) bytecomp-outbuffer)
2142 (setq form (cdr form))
2143 (setq index (1+ index))))
2144 ((= index (nth 1 info))
2145 (if position
2146 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2147 position)
2148 bytecomp-outbuffer)
2149 (let ((print-escape-newlines nil))
2150 (goto-char (prog1 (1+ (point))
2151 (prin1 (car form) bytecomp-outbuffer)))
2152 (insert "\\\n")
2153 (goto-char (point-max)))))
2155 (prin1 (car form) bytecomp-outbuffer)))))
2156 (insert (nth 2 info)))))
2157 nil)
2159 (defun byte-compile-keep-pending (form &optional bytecomp-handler)
2160 (if (memq byte-optimize '(t source))
2161 (setq form (byte-optimize-form form t)))
2162 (if bytecomp-handler
2163 (let ((for-effect t))
2164 ;; To avoid consing up monstrously large forms at load time, we split
2165 ;; the output regularly.
2166 (and (memq (car-safe form) '(fset defalias))
2167 (nthcdr 300 byte-compile-output)
2168 (byte-compile-flush-pending))
2169 (funcall bytecomp-handler form)
2170 (if for-effect
2171 (byte-compile-discard)))
2172 (byte-compile-form form t))
2173 nil)
2175 (defun byte-compile-flush-pending ()
2176 (if byte-compile-output
2177 (let ((form (byte-compile-out-toplevel t 'file)))
2178 (cond ((eq (car-safe form) 'progn)
2179 (mapc 'byte-compile-output-file-form (cdr form)))
2180 (form
2181 (byte-compile-output-file-form form)))
2182 (setq byte-compile-constants nil
2183 byte-compile-variables nil
2184 byte-compile-depth 0
2185 byte-compile-maxdepth 0
2186 byte-compile-output nil))))
2188 ;; byte-hunk-handlers cannot call this!
2189 (defun byte-compile-toplevel-file-form (form)
2190 (let ((byte-compile-current-form nil)) ; close over this for warnings.
2191 (setq form (macroexpand-all form byte-compile-macro-environment))
2192 (if lexical-binding
2193 (setq form (cconv-closure-convert form)))
2194 (byte-compile-file-form form)))
2196 ;; byte-hunk-handlers can call this.
2197 (defun byte-compile-file-form (form)
2198 (let (bytecomp-handler)
2199 (cond ((and (consp form)
2200 (symbolp (car form))
2201 (setq bytecomp-handler (get (car form) 'byte-hunk-handler)))
2202 (cond ((setq form (funcall bytecomp-handler form))
2203 (byte-compile-flush-pending)
2204 (byte-compile-output-file-form form))))
2206 (byte-compile-keep-pending form)))))
2208 ;; Functions and variables with doc strings must be output separately,
2209 ;; so make-docfile can recognise them. Most other things can be output
2210 ;; as byte-code.
2212 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2213 (defun byte-compile-file-form-autoload (form)
2214 (and (let ((form form))
2215 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2216 (null form)) ;Constants only
2217 (eval (nth 5 form)) ;Macro
2218 (eval form)) ;Define the autoload.
2219 ;; Avoid undefined function warnings for the autoload.
2220 (when (and (consp (nth 1 form))
2221 (eq (car (nth 1 form)) 'quote)
2222 (consp (cdr (nth 1 form)))
2223 (symbolp (nth 1 (nth 1 form))))
2224 (push (cons (nth 1 (nth 1 form))
2225 (cons 'autoload (cdr (cdr form))))
2226 byte-compile-function-environment)
2227 ;; If an autoload occurs _before_ the first call to a function,
2228 ;; byte-compile-callargs-warn does not add an entry to
2229 ;; byte-compile-unresolved-functions. Here we mimic the logic
2230 ;; of byte-compile-callargs-warn so as not to warn if the
2231 ;; autoload comes _after_ the function call.
2232 ;; Alternatively, similar logic could go in
2233 ;; byte-compile-warn-about-unresolved-functions.
2234 (or (memq (nth 1 (nth 1 form)) byte-compile-noruntime-functions)
2235 (setq byte-compile-unresolved-functions
2236 (delq (assq (nth 1 (nth 1 form))
2237 byte-compile-unresolved-functions)
2238 byte-compile-unresolved-functions))))
2239 (if (stringp (nth 3 form))
2240 form
2241 ;; No doc string, so we can compile this as a normal form.
2242 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2244 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2245 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2246 (defun byte-compile-file-form-defvar (form)
2247 (if (null (nth 3 form))
2248 ;; Since there is no doc string, we can compile this as a normal form,
2249 ;; and not do a file-boundary.
2250 (byte-compile-keep-pending form)
2251 (when (and (symbolp (nth 1 form))
2252 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
2253 (byte-compile-warning-enabled-p 'lexical))
2254 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
2255 (nth 1 form)))
2256 (push (nth 1 form) byte-compile-bound-variables)
2257 (if (eq (car form) 'defconst)
2258 (push (nth 1 form) byte-compile-const-variables))
2259 (cond ((consp (nth 2 form))
2260 (setq form (copy-sequence form))
2261 (setcar (cdr (cdr form))
2262 (byte-compile-top-level (nth 2 form) nil 'file))))
2263 form))
2265 (put 'define-abbrev-table 'byte-hunk-handler 'byte-compile-file-form-define-abbrev-table)
2266 (defun byte-compile-file-form-define-abbrev-table (form)
2267 (if (eq 'quote (car-safe (car-safe (cdr form))))
2268 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
2269 (byte-compile-keep-pending form))
2271 (put 'custom-declare-variable 'byte-hunk-handler
2272 'byte-compile-file-form-custom-declare-variable)
2273 (defun byte-compile-file-form-custom-declare-variable (form)
2274 (when (byte-compile-warning-enabled-p 'callargs)
2275 (byte-compile-nogroup-warn form))
2276 (push (nth 1 (nth 1 form)) byte-compile-bound-variables)
2277 ;; Don't compile the expression because it may be displayed to the user.
2278 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2279 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2280 ;; ;; final value already, we can byte-compile it.
2281 ;; (setcar (cdr (nth 2 form))
2282 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2283 (let ((tail (nthcdr 4 form)))
2284 (while tail
2285 (unless (keywordp (car tail)) ;No point optimizing keywords.
2286 ;; Compile the keyword arguments.
2287 (setcar tail (byte-compile-top-level (car tail) nil 'file)))
2288 (setq tail (cdr tail))))
2289 form)
2291 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2292 (defun byte-compile-file-form-require (form)
2293 (let ((args (mapcar 'eval (cdr form)))
2294 (hist-orig load-history)
2295 hist-new)
2296 (apply 'require args)
2297 (when (byte-compile-warning-enabled-p 'cl-functions)
2298 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2299 (if (member (car args) '("cl" cl))
2300 (progn
2301 (byte-compile-warn "cl package required at runtime")
2302 (byte-compile-disable-warning 'cl-functions))
2303 ;; We may have required something that causes cl to be loaded, eg
2304 ;; the uncompiled version of a file that requires cl when compiling.
2305 (setq hist-new load-history)
2306 (while (and (not byte-compile-cl-functions)
2307 hist-new (not (eq hist-new hist-orig)))
2308 (and (byte-compile-cl-file-p (car (pop hist-new)))
2309 (byte-compile-find-cl-functions))))))
2310 (byte-compile-keep-pending form 'byte-compile-normal-call))
2312 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2313 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2314 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2315 (defun byte-compile-file-form-progn (form)
2316 (mapc 'byte-compile-file-form (cdr form))
2317 ;; Return nil so the forms are not output twice.
2318 nil)
2320 (put 'with-no-warnings 'byte-hunk-handler
2321 'byte-compile-file-form-with-no-warnings)
2322 (defun byte-compile-file-form-with-no-warnings (form)
2323 ;; cf byte-compile-file-form-progn.
2324 (let (byte-compile-warnings)
2325 (mapc 'byte-compile-file-form (cdr form))
2326 nil))
2328 ;; This handler is not necessary, but it makes the output from dont-compile
2329 ;; and similar macros cleaner.
2330 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2331 (defun byte-compile-file-form-eval (form)
2332 (if (eq (car-safe (nth 1 form)) 'quote)
2333 (nth 1 (nth 1 form))
2334 (byte-compile-keep-pending form)))
2336 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2337 (defun byte-compile-file-form-defun (form)
2338 (byte-compile-file-form-defmumble form nil))
2340 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2341 (defun byte-compile-file-form-defmacro (form)
2342 (byte-compile-file-form-defmumble form t))
2344 (defun byte-compile-defmacro-declaration (form)
2345 "Generate code for declarations in macro definitions.
2346 Remove declarations from the body of the macro definition
2347 by side-effects."
2348 (let ((tail (nthcdr 2 form))
2349 (res '()))
2350 (when (stringp (car (cdr tail)))
2351 (setq tail (cdr tail)))
2352 (while (and (consp (car (cdr tail)))
2353 (eq (car (car (cdr tail))) 'declare))
2354 (let ((declaration (car (cdr tail))))
2355 (setcdr tail (cdr (cdr tail)))
2356 (push `(if macro-declaration-function
2357 (funcall macro-declaration-function
2358 ',(car (cdr form)) ',declaration))
2359 res)))
2360 res))
2362 (defun byte-compile-file-form-defmumble (form macrop)
2363 (let* ((bytecomp-name (car (cdr form)))
2364 (bytecomp-this-kind (if macrop 'byte-compile-macro-environment
2365 'byte-compile-function-environment))
2366 (bytecomp-that-kind (if macrop 'byte-compile-function-environment
2367 'byte-compile-macro-environment))
2368 (bytecomp-this-one (assq bytecomp-name
2369 (symbol-value bytecomp-this-kind)))
2370 (bytecomp-that-one (assq bytecomp-name
2371 (symbol-value bytecomp-that-kind)))
2372 (byte-compile-free-references nil)
2373 (byte-compile-free-assignments nil))
2374 (byte-compile-set-symbol-position bytecomp-name)
2375 ;; When a function or macro is defined, add it to the call tree so that
2376 ;; we can tell when functions are not used.
2377 (if byte-compile-generate-call-tree
2378 (or (assq bytecomp-name byte-compile-call-tree)
2379 (setq byte-compile-call-tree
2380 (cons (list bytecomp-name nil nil) byte-compile-call-tree))))
2382 (setq byte-compile-current-form bytecomp-name) ; for warnings
2383 (if (byte-compile-warning-enabled-p 'redefine)
2384 (byte-compile-arglist-warn form macrop))
2385 (if byte-compile-verbose
2386 ;; bytecomp-filename is from byte-compile-from-buffer.
2387 (message "Compiling %s... (%s)" (or bytecomp-filename "") (nth 1 form)))
2388 (cond (bytecomp-that-one
2389 (if (and (byte-compile-warning-enabled-p 'redefine)
2390 ;; don't warn when compiling the stubs in byte-run...
2391 (not (assq (nth 1 form)
2392 byte-compile-initial-macro-environment)))
2393 (byte-compile-warn
2394 "`%s' defined multiple times, as both function and macro"
2395 (nth 1 form)))
2396 (setcdr bytecomp-that-one nil))
2397 (bytecomp-this-one
2398 (when (and (byte-compile-warning-enabled-p 'redefine)
2399 ;; hack: don't warn when compiling the magic internal
2400 ;; byte-compiler macros in byte-run.el...
2401 (not (assq (nth 1 form)
2402 byte-compile-initial-macro-environment)))
2403 (byte-compile-warn "%s `%s' defined multiple times in this file"
2404 (if macrop "macro" "function")
2405 (nth 1 form))))
2406 ((and (fboundp bytecomp-name)
2407 (eq (car-safe (symbol-function bytecomp-name))
2408 (if macrop 'lambda 'macro)))
2409 (when (byte-compile-warning-enabled-p 'redefine)
2410 (byte-compile-warn "%s `%s' being redefined as a %s"
2411 (if macrop "function" "macro")
2412 (nth 1 form)
2413 (if macrop "macro" "function")))
2414 ;; shadow existing definition
2415 (set bytecomp-this-kind
2416 (cons (cons bytecomp-name nil)
2417 (symbol-value bytecomp-this-kind))))
2419 (let ((body (nthcdr 3 form)))
2420 (when (and (stringp (car body))
2421 (symbolp (car-safe (cdr-safe body)))
2422 (car-safe (cdr-safe body))
2423 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2424 (byte-compile-set-symbol-position (nth 1 form))
2425 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2426 (nth 1 form))))
2428 ;; Generate code for declarations in macro definitions.
2429 ;; Remove declarations from the body of the macro definition.
2430 (when macrop
2431 (dolist (decl (byte-compile-defmacro-declaration form))
2432 (prin1 decl bytecomp-outbuffer)))
2434 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
2435 (code (byte-compile-byte-code-maker new-one)))
2436 (if bytecomp-this-one
2437 (setcdr bytecomp-this-one new-one)
2438 (set bytecomp-this-kind
2439 (cons (cons bytecomp-name new-one)
2440 (symbol-value bytecomp-this-kind))))
2441 (if (and (stringp (nth 3 form))
2442 (eq 'quote (car-safe code))
2443 (eq 'lambda (car-safe (nth 1 code))))
2444 (cons (car form)
2445 (cons bytecomp-name (cdr (nth 1 code))))
2446 (byte-compile-flush-pending)
2447 (if (not (stringp (nth 3 form)))
2448 ;; No doc string. Provide -1 as the "doc string index"
2449 ;; so that no element will be treated as a doc string.
2450 (byte-compile-output-docform
2451 "\n(defalias '"
2452 bytecomp-name
2453 (cond ((atom code)
2454 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2455 ((eq (car code) 'quote)
2456 (setq code new-one)
2457 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2458 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2459 (append code nil)
2460 (and (atom code) byte-compile-dynamic
2462 nil)
2463 ;; Output the form by hand, that's much simpler than having
2464 ;; b-c-output-file-form analyze the defalias.
2465 (byte-compile-output-docform
2466 "\n(defalias '"
2467 bytecomp-name
2468 (cond ((atom code)
2469 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2470 ((eq (car code) 'quote)
2471 (setq code new-one)
2472 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2473 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2474 (append code nil)
2475 (and (atom code) byte-compile-dynamic
2477 nil))
2478 (princ ")" bytecomp-outbuffer)
2479 nil))))
2481 ;; Print Lisp object EXP in the output file, inside a comment,
2482 ;; and return the file position it will have.
2483 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2484 (defun byte-compile-output-as-comment (exp quoted)
2485 (let ((position (point)))
2486 (with-current-buffer bytecomp-outbuffer
2488 ;; Insert EXP, and make it a comment with #@LENGTH.
2489 (insert " ")
2490 (if quoted
2491 (prin1 exp bytecomp-outbuffer)
2492 (princ exp bytecomp-outbuffer))
2493 (goto-char position)
2494 ;; Quote certain special characters as needed.
2495 ;; get_doc_string in doc.c does the unquoting.
2496 (while (search-forward "\^A" nil t)
2497 (replace-match "\^A\^A" t t))
2498 (goto-char position)
2499 (while (search-forward "\000" nil t)
2500 (replace-match "\^A0" t t))
2501 (goto-char position)
2502 (while (search-forward "\037" nil t)
2503 (replace-match "\^A_" t t))
2504 (goto-char (point-max))
2505 (insert "\037")
2506 (goto-char position)
2507 (insert "#@" (format "%d" (- (position-bytes (point-max))
2508 (position-bytes position))))
2510 ;; Save the file position of the object.
2511 ;; Note we should add 1 to skip the space
2512 ;; that we inserted before the actual doc string,
2513 ;; and subtract 1 to convert from an 1-origin Emacs position
2514 ;; to a file position; they cancel.
2515 (setq position (point))
2516 (goto-char (point-max)))
2517 position))
2521 ;;;###autoload
2522 (defun byte-compile (form)
2523 "If FORM is a symbol, byte-compile its function definition.
2524 If FORM is a lambda or a macro, byte-compile it as a function."
2525 (displaying-byte-compile-warnings
2526 (byte-compile-close-variables
2527 (let* ((fun (if (symbolp form)
2528 (and (fboundp form) (symbol-function form))
2529 form))
2530 (macro (eq (car-safe fun) 'macro)))
2531 (if macro
2532 (setq fun (cdr fun)))
2533 (cond ((eq (car-safe fun) 'lambda)
2534 ;; Expand macros.
2535 (setq fun
2536 (macroexpand-all fun
2537 byte-compile-initial-macro-environment))
2538 (if lexical-binding
2539 (setq fun (cconv-closure-convert fun)))
2540 ;; Get rid of the `function' quote added by the `lambda' macro.
2541 (if (eq (car-safe fun) 'function) (setq fun (cadr fun)))
2542 (setq fun (if macro
2543 (cons 'macro (byte-compile-lambda fun))
2544 (byte-compile-lambda fun)))
2545 (if (symbolp form)
2546 (defalias form fun)
2547 fun)))))))
2549 (defun byte-compile-sexp (sexp)
2550 "Compile and return SEXP."
2551 (displaying-byte-compile-warnings
2552 (byte-compile-close-variables
2553 (byte-compile-top-level sexp))))
2555 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2556 (defun byte-compile-byte-code-maker (fun)
2557 (cond
2558 ;; ## atom is faster than compiled-func-p.
2559 ((atom fun) ; compiled function.
2560 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2561 ;; would have produced a lambda.
2562 fun)
2563 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2564 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2565 ((let (tmp)
2566 ;; FIXME: can this happen?
2567 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2568 (null (cdr (memq tmp fun))))
2569 ;; Generate a make-byte-code call.
2570 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2571 (nconc (list 'make-byte-code
2572 (list 'quote (nth 1 fun)) ;arglist
2573 (nth 1 tmp) ;bytes
2574 (nth 2 tmp) ;consts
2575 (nth 3 tmp)) ;depth
2576 (cond ((stringp (nth 2 fun))
2577 (list (nth 2 fun))) ;doc
2578 (interactive
2579 (list nil)))
2580 (cond (interactive
2581 (list (if (or (null (nth 1 interactive))
2582 (stringp (nth 1 interactive)))
2583 (nth 1 interactive)
2584 ;; Interactive spec is a list or a variable
2585 ;; (if it is correct).
2586 (list 'quote (nth 1 interactive))))))))
2587 ;; a non-compiled function (probably trivial)
2588 (list 'quote fun))))))
2590 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2591 (defun byte-compile-byte-code-unmake (function) ;FIXME: what is it?
2592 (if (consp function)
2593 function;;It already is a lambda.
2594 (setq function (append function nil)) ; turn it into a list
2595 (nconc (list 'lambda (nth 0 function))
2596 (and (nth 4 function) (list (nth 4 function)))
2597 (if (nthcdr 5 function)
2598 (list (cons 'interactive (if (nth 5 function)
2599 (nthcdr 5 function)))))
2600 (list (list 'byte-code
2601 (nth 1 function) (nth 2 function)
2602 (nth 3 function))))))
2605 (defun byte-compile-check-lambda-list (list)
2606 "Check lambda-list LIST for errors."
2607 (let (vars)
2608 (while list
2609 (let ((arg (car list)))
2610 (when (symbolp arg)
2611 (byte-compile-set-symbol-position arg))
2612 (cond ((or (not (symbolp arg))
2613 (byte-compile-const-symbol-p arg t))
2614 (error "Invalid lambda variable %s" arg))
2615 ((eq arg '&rest)
2616 (unless (cdr list)
2617 (error "&rest without variable name"))
2618 (when (cddr list)
2619 (error "Garbage following &rest VAR in lambda-list")))
2620 ((eq arg '&optional)
2621 (unless (cdr list)
2622 (error "Variable name missing after &optional")))
2623 ((memq arg vars)
2624 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2626 (push arg vars))))
2627 (setq list (cdr list)))))
2630 (defun byte-compile-arglist-vars (arglist)
2631 "Return a list of the variables in the lambda argument list ARGLIST."
2632 (remq '&rest (remq '&optional arglist)))
2634 (defun byte-compile-make-lambda-lexenv (form)
2635 "Return a new lexical environment for a lambda expression FORM."
2636 ;; See if this is a closure or not
2637 (let ((args (byte-compile-arglist-vars (cadr form))))
2638 (let ((lexenv nil))
2639 ;; Fill in the initial stack contents
2640 (let ((stackpos 0))
2641 ;; Add entries for each argument
2642 (dolist (arg args)
2643 (push (cons arg stackpos) lexenv)
2644 (setq stackpos (1+ stackpos)))
2645 ;; Return the new lexical environment
2646 lexenv))))
2648 ;; Byte-compile a lambda-expression and return a valid function.
2649 ;; The value is usually a compiled function but may be the original
2650 ;; lambda-expression.
2651 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2652 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2653 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2654 ;; for symbols generated by the byte compiler itself.
2655 (defun byte-compile-lambda (bytecomp-fun &optional add-lambda reserved-csts)
2656 (if add-lambda
2657 (setq bytecomp-fun (cons 'lambda bytecomp-fun))
2658 (unless (eq 'lambda (car-safe bytecomp-fun))
2659 (error "Not a lambda list: %S" bytecomp-fun))
2660 (byte-compile-set-symbol-position 'lambda))
2661 (byte-compile-check-lambda-list (nth 1 bytecomp-fun))
2662 (let* ((bytecomp-arglist (nth 1 bytecomp-fun))
2663 (byte-compile-bound-variables
2664 (append (and (not lexical-binding)
2665 (byte-compile-arglist-vars bytecomp-arglist))
2666 byte-compile-bound-variables))
2667 (bytecomp-body (cdr (cdr bytecomp-fun)))
2668 (bytecomp-doc (if (stringp (car bytecomp-body))
2669 (prog1 (car bytecomp-body)
2670 ;; Discard the doc string
2671 ;; unless it is the last element of the body.
2672 (if (cdr bytecomp-body)
2673 (setq bytecomp-body (cdr bytecomp-body))))))
2674 (bytecomp-int (assq 'interactive bytecomp-body)))
2675 ;; Process the interactive spec.
2676 (when bytecomp-int
2677 (byte-compile-set-symbol-position 'interactive)
2678 ;; Skip (interactive) if it is in front (the most usual location).
2679 (if (eq bytecomp-int (car bytecomp-body))
2680 (setq bytecomp-body (cdr bytecomp-body)))
2681 (cond ((consp (cdr bytecomp-int))
2682 (if (cdr (cdr bytecomp-int))
2683 (byte-compile-warn "malformed interactive spec: %s"
2684 (prin1-to-string bytecomp-int)))
2685 ;; If the interactive spec is a call to `list', don't
2686 ;; compile it, because `call-interactively' looks at the
2687 ;; args of `list'. Actually, compile it to get warnings,
2688 ;; but don't use the result.
2689 (let* ((form (nth 1 bytecomp-int))
2690 (newform (byte-compile-top-level form)))
2691 (while (memq (car-safe form) '(let let* progn save-excursion))
2692 (while (consp (cdr form))
2693 (setq form (cdr form)))
2694 (setq form (car form)))
2695 (if (and (eq (car-safe form) 'list)
2696 ;; The spec is evaled in callint.c in dynamic-scoping
2697 ;; mode, so just leaving the form unchanged would mean
2698 ;; it won't be eval'd in the right mode.
2699 (not lexical-binding))
2701 (setq bytecomp-int `(interactive ,newform)))))
2702 ((cdr bytecomp-int)
2703 (byte-compile-warn "malformed interactive spec: %s"
2704 (prin1-to-string bytecomp-int)))))
2705 ;; Process the body.
2706 (let* ((compiled
2707 (byte-compile-top-level (cons 'progn bytecomp-body) nil 'lambda
2708 ;; If doing lexical binding, push a new
2709 ;; lexical environment containing just the
2710 ;; args (since lambda expressions should be
2711 ;; closed by now).
2712 (and lexical-binding
2713 (byte-compile-make-lambda-lexenv
2714 bytecomp-fun))
2715 reserved-csts)))
2716 ;; Build the actual byte-coded function.
2717 (if (eq 'byte-code (car-safe compiled))
2718 (apply 'make-byte-code
2719 (append (list bytecomp-arglist)
2720 ;; byte-string, constants-vector, stack depth
2721 (cdr compiled)
2722 ;; optionally, the doc string.
2723 (if (or bytecomp-doc bytecomp-int
2724 lexical-binding)
2725 (list bytecomp-doc))
2726 ;; optionally, the interactive spec.
2727 (if (or bytecomp-int lexical-binding)
2728 (list (nth 1 bytecomp-int)))
2729 (if lexical-binding
2730 '(t))))
2731 (setq compiled
2732 (nconc (if bytecomp-int (list bytecomp-int))
2733 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2734 (compiled (list compiled)))))
2735 (nconc (list 'lambda bytecomp-arglist)
2736 (if (or bytecomp-doc (stringp (car compiled)))
2737 (cons bytecomp-doc (cond (compiled)
2738 (bytecomp-body (list nil))))
2739 compiled))))))
2741 (defun byte-compile-closure (form &optional add-lambda)
2742 (let ((code (byte-compile-lambda form add-lambda)))
2743 ;; A simple lambda is just a constant.
2744 (byte-compile-constant code)))
2746 (defvar byte-compile-reserved-constants 0)
2748 (defun byte-compile-constants-vector ()
2749 ;; Builds the constants-vector from the current variables and constants.
2750 ;; This modifies the constants from (const . nil) to (const . offset).
2751 ;; To keep the byte-codes to look up the vector as short as possible:
2752 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2753 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2754 ;; Next variables again, to get 2-byte codes for variable lookup.
2755 ;; The rest of the constants and variables need 3-byte byte-codes.
2756 (let* ((i (1- byte-compile-reserved-constants))
2757 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2758 (other (nreverse byte-compile-constants)) ; vars often are used most.
2759 ret tmp
2760 (limits '(5 ; Use the 1-byte varref codes,
2761 63 ; 1-constlim ; 1-byte byte-constant codes,
2762 255 ; 2-byte varref codes,
2763 65535)) ; 3-byte codes for the rest.
2764 limit)
2765 (while (or rest other)
2766 (setq limit (car limits))
2767 (while (and rest (< i limit))
2768 (cond
2769 ((numberp (car rest))
2770 (assert (< (car rest) byte-compile-reserved-constants)))
2771 ((setq tmp (assq (car (car rest)) ret))
2772 (setcdr (car rest) (cdr tmp)))
2774 (setcdr (car rest) (setq i (1+ i)))
2775 (setq ret (cons (car rest) ret))))
2776 (setq rest (cdr rest)))
2777 (setq limits (cdr limits)
2778 rest (prog1 other
2779 (setq other rest))))
2780 (apply 'vector (nreverse (mapcar 'car ret)))))
2782 ;; Given an expression FORM, compile it and return an equivalent byte-code
2783 ;; expression (a call to the function byte-code).
2784 (defun byte-compile-top-level (form &optional for-effect output-type
2785 lexenv reserved-csts)
2786 ;; OUTPUT-TYPE advises about how form is expected to be used:
2787 ;; 'eval or nil -> a single form,
2788 ;; 'progn or t -> a list of forms,
2789 ;; 'lambda -> body of a lambda,
2790 ;; 'file -> used at file-level.
2791 (let ((byte-compile-constants nil)
2792 (byte-compile-variables nil)
2793 (byte-compile-tag-number 0)
2794 (byte-compile-depth 0)
2795 (byte-compile-maxdepth 0)
2796 (byte-compile-lexical-environment lexenv)
2797 (byte-compile-reserved-constants (or reserved-csts 0))
2798 (byte-compile-output nil))
2799 (if (memq byte-optimize '(t source))
2800 (setq form (byte-optimize-form form for-effect)))
2801 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2802 (setq form (nth 1 form)))
2803 (if (and (eq 'byte-code (car-safe form))
2804 (not (memq byte-optimize '(t byte)))
2805 (stringp (nth 1 form)) (vectorp (nth 2 form))
2806 (natnump (nth 3 form)))
2807 form
2808 ;; Set up things for a lexically-bound function.
2809 (when (and lexical-binding (eq output-type 'lambda))
2810 ;; See how many arguments there are, and set the current stack depth
2811 ;; accordingly.
2812 (setq byte-compile-depth (length byte-compile-lexical-environment))
2813 ;; If there are args, output a tag to record the initial
2814 ;; stack-depth for the optimizer.
2815 (when (> byte-compile-depth 0)
2816 (byte-compile-out-tag (byte-compile-make-tag))))
2817 ;; Now compile FORM
2818 (byte-compile-form form for-effect)
2819 (byte-compile-out-toplevel for-effect output-type))))
2821 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2822 (if for-effect
2823 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2824 (if (eq (car (car byte-compile-output)) 'byte-discard)
2825 (setq byte-compile-output (cdr byte-compile-output))
2826 (byte-compile-push-constant
2827 ;; Push any constant - preferably one which already is used, and
2828 ;; a number or symbol - ie not some big sequence. The return value
2829 ;; isn't returned, but it would be a shame if some textually large
2830 ;; constant was not optimized away because we chose to return it.
2831 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2832 (let ((tmp (reverse byte-compile-constants)))
2833 (while (and tmp (not (or (symbolp (caar tmp))
2834 (numberp (caar tmp)))))
2835 (setq tmp (cdr tmp)))
2836 (caar tmp))))))
2837 (byte-compile-out 'byte-return 0)
2838 (setq byte-compile-output (nreverse byte-compile-output))
2839 (if (memq byte-optimize '(t byte))
2840 (setq byte-compile-output
2841 (byte-optimize-lapcode byte-compile-output for-effect)))
2843 ;; Decompile trivial functions:
2844 ;; only constants and variables, or a single funcall except in lambdas.
2845 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2846 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2847 ;; Note that even (quote foo) must be parsed just as any subr by the
2848 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2849 ;; What to leave uncompiled:
2850 ;; lambda -> never. we used to leave it uncompiled if the body was
2851 ;; a single atom, but that causes confusion if the docstring
2852 ;; uses the (file . pos) syntax. Besides, now that we have
2853 ;; the Lisp_Compiled type, the compiled form is faster.
2854 ;; eval -> atom, quote or (function atom atom atom)
2855 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2856 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2857 (let (rest
2858 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2859 tmp body)
2860 (cond
2861 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2862 ((or (eq output-type 'lambda)
2863 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2864 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2865 (not (setq tmp (assq 'byte-return byte-compile-output)))
2866 (progn
2867 (setq rest (nreverse
2868 (cdr (memq tmp (reverse byte-compile-output)))))
2869 (while (cond
2870 ((memq (car (car rest)) '(byte-varref byte-constant))
2871 (setq tmp (car (cdr (car rest))))
2872 (if (if (eq (car (car rest)) 'byte-constant)
2873 (or (consp tmp)
2874 (and (symbolp tmp)
2875 (not (byte-compile-const-symbol-p tmp)))))
2876 (if maycall
2877 (setq body (cons (list 'quote tmp) body)))
2878 (setq body (cons tmp body))))
2879 ((and maycall
2880 ;; Allow a funcall if at most one atom follows it.
2881 (null (nthcdr 3 rest))
2882 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2883 (or (null (cdr rest))
2884 (and (memq output-type '(file progn t))
2885 (cdr (cdr rest))
2886 (eq (car (nth 1 rest)) 'byte-discard)
2887 (progn (setq rest (cdr rest)) t))))
2888 (setq maycall nil) ; Only allow one real function call.
2889 (setq body (nreverse body))
2890 (setq body (list
2891 (if (and (eq tmp 'funcall)
2892 (eq (car-safe (car body)) 'quote))
2893 (cons (nth 1 (car body)) (cdr body))
2894 (cons tmp body))))
2895 (or (eq output-type 'file)
2896 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2897 (setq rest (cdr rest)))
2898 rest))
2899 (let ((byte-compile-vector (byte-compile-constants-vector)))
2900 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2901 byte-compile-vector byte-compile-maxdepth)))
2902 ;; it's a trivial function
2903 ((cdr body) (cons 'progn (nreverse body)))
2904 ((car body)))))
2906 ;; Given BYTECOMP-BODY, compile it and return a new body.
2907 (defun byte-compile-top-level-body (bytecomp-body &optional for-effect)
2908 (setq bytecomp-body
2909 (byte-compile-top-level (cons 'progn bytecomp-body) for-effect t))
2910 (cond ((eq (car-safe bytecomp-body) 'progn)
2911 (cdr bytecomp-body))
2912 (bytecomp-body
2913 (list bytecomp-body))))
2915 ;; Special macro-expander used during byte-compilation.
2916 (defun byte-compile-macroexpand-declare-function (fn file &rest args)
2917 (push (cons fn
2918 (if (and (consp args) (listp (car args)))
2919 (list 'declared (car args))
2920 t)) ; arglist not specified
2921 byte-compile-function-environment)
2922 ;; We are stating that it _will_ be defined at runtime.
2923 (setq byte-compile-noruntime-functions
2924 (delq fn byte-compile-noruntime-functions))
2925 ;; Delegate the rest to the normal macro definition.
2926 (macroexpand `(declare-function ,fn ,file ,@args)))
2929 ;; This is the recursive entry point for compiling each subform of an
2930 ;; expression.
2931 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2932 ;; before terminating (ie no value will be left on the stack).
2933 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2934 ;; which does not leave a value on the stack, and then set for-effect to nil
2935 ;; (to prevent byte-compile-form from outputting the byte-discard).
2936 ;; If a handler wants to call another handler, it should do so via
2937 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2938 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2940 (defun byte-compile-form (form &optional for-effect)
2941 (cond ((not (consp form))
2942 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2943 (when (symbolp form)
2944 (byte-compile-set-symbol-position form))
2945 (byte-compile-constant form))
2946 ((and for-effect byte-compile-delete-errors)
2947 (when (symbolp form)
2948 (byte-compile-set-symbol-position form))
2949 (setq for-effect nil))
2951 (byte-compile-variable-ref form))))
2952 ((symbolp (car form))
2953 (let* ((bytecomp-fn (car form))
2954 (bytecomp-handler (get bytecomp-fn 'byte-compile)))
2955 (when (byte-compile-const-symbol-p bytecomp-fn)
2956 (byte-compile-warn "`%s' called as a function" bytecomp-fn))
2957 (and (byte-compile-warning-enabled-p 'interactive-only)
2958 (memq bytecomp-fn byte-compile-interactive-only-functions)
2959 (byte-compile-warn "`%s' used from Lisp code\n\
2960 That command is designed for interactive use only" bytecomp-fn))
2961 (if (and (fboundp (car form))
2962 (eq (car-safe (symbol-function (car form))) 'macro))
2963 (byte-compile-report-error
2964 (format "Forgot to expand macro %s" (car form))))
2965 (if (and bytecomp-handler
2966 ;; Make sure that function exists. This is important
2967 ;; for CL compiler macros since the symbol may be
2968 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2969 ;; loaded, this function doesn't exist.
2970 (and (not (eq bytecomp-handler
2971 ;; Already handled by macroexpand-all.
2972 'cl-byte-compile-compiler-macro))
2973 (functionp bytecomp-handler)))
2974 (funcall bytecomp-handler form)
2975 (byte-compile-normal-call form))
2976 (if (byte-compile-warning-enabled-p 'cl-functions)
2977 (byte-compile-cl-warn form))))
2978 ((and (or (byte-code-function-p (car form))
2979 (eq (car-safe (car form)) 'lambda))
2980 ;; if the form comes out the same way it went in, that's
2981 ;; because it was malformed, and we couldn't unfold it.
2982 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2983 (byte-compile-form form for-effect)
2984 (setq for-effect nil))
2985 ((byte-compile-normal-call form)))
2986 (if for-effect
2987 (byte-compile-discard)))
2989 (defun byte-compile-normal-call (form)
2990 (when (and (byte-compile-warning-enabled-p 'callargs)
2991 (symbolp (car form)))
2992 (if (memq (car form)
2993 '(custom-declare-group custom-declare-variable
2994 custom-declare-face))
2995 (byte-compile-nogroup-warn form))
2996 (when (get (car form) 'byte-obsolete-info)
2997 (byte-compile-warn-obsolete (car form)))
2998 (byte-compile-callargs-warn form))
2999 (if byte-compile-generate-call-tree
3000 (byte-compile-annotate-call-tree form))
3001 (when (and for-effect (eq (car form) 'mapcar)
3002 (byte-compile-warning-enabled-p 'mapcar))
3003 (byte-compile-set-symbol-position 'mapcar)
3004 (byte-compile-warn
3005 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
3006 (byte-compile-push-constant (car form))
3007 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
3008 (byte-compile-out 'byte-call (length (cdr form))))
3010 (defun byte-compile-check-variable (var &optional binding)
3011 "Do various error checks before a use of the variable VAR.
3012 If BINDING is non-nil, VAR is being bound."
3013 (when (symbolp var)
3014 (byte-compile-set-symbol-position var))
3015 (cond ((or (not (symbolp var)) (byte-compile-const-symbol-p var))
3016 (when (byte-compile-warning-enabled-p 'constants)
3017 (byte-compile-warn (if binding
3018 "attempt to let-bind %s `%s`"
3019 "variable reference to %s `%s'")
3020 (if (symbolp var) "constant" "nonvariable")
3021 (prin1-to-string var))))
3022 ((and (get var 'byte-obsolete-variable)
3023 (not (memq var byte-compile-not-obsolete-vars)))
3024 (byte-compile-warn-obsolete var))))
3026 (defsubst byte-compile-dynamic-variable-op (base-op var)
3027 (let ((tmp (assq var byte-compile-variables)))
3028 (unless tmp
3029 (setq tmp (list var))
3030 (push tmp byte-compile-variables))
3031 (byte-compile-out base-op tmp)))
3033 (defun byte-compile-dynamic-variable-bind (var)
3034 "Generate code to bind the lexical variable VAR to the top-of-stack value."
3035 (byte-compile-check-variable var t)
3036 (push var byte-compile-bound-variables)
3037 (byte-compile-dynamic-variable-op 'byte-varbind var))
3039 (defun byte-compile-variable-ref (var)
3040 "Generate code to push the value of the variable VAR on the stack."
3041 (byte-compile-check-variable var)
3042 (let ((lex-binding (assq var byte-compile-lexical-environment)))
3043 (if lex-binding
3044 ;; VAR is lexically bound
3045 (byte-compile-stack-ref (cdr lex-binding))
3046 ;; VAR is dynamically bound
3047 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3048 (boundp var)
3049 (memq var byte-compile-bound-variables)
3050 (memq var byte-compile-free-references))
3051 (byte-compile-warn "reference to free variable `%S'" var)
3052 (push var byte-compile-free-references))
3053 (byte-compile-dynamic-variable-op 'byte-varref var))))
3055 (defun byte-compile-variable-set (var)
3056 "Generate code to set the variable VAR from the top-of-stack value."
3057 (byte-compile-check-variable var)
3058 (let ((lex-binding (assq var byte-compile-lexical-environment)))
3059 (if lex-binding
3060 ;; VAR is lexically bound
3061 (byte-compile-stack-set (cdr lex-binding))
3062 ;; VAR is dynamically bound
3063 (unless (or (not (byte-compile-warning-enabled-p 'free-vars))
3064 (boundp var)
3065 (memq var byte-compile-bound-variables)
3066 (memq var byte-compile-free-assignments))
3067 (byte-compile-warn "assignment to free variable `%s'" var)
3068 (push var byte-compile-free-assignments))
3069 (byte-compile-dynamic-variable-op 'byte-varset var))))
3071 (defmacro byte-compile-get-constant (const)
3072 `(or (if (stringp ,const)
3073 ;; In a string constant, treat properties as significant.
3074 (let (result)
3075 (dolist (elt byte-compile-constants)
3076 (if (equal-including-properties (car elt) ,const)
3077 (setq result elt)))
3078 result)
3079 (assq ,const byte-compile-constants))
3080 (car (setq byte-compile-constants
3081 (cons (list ,const) byte-compile-constants)))))
3083 ;; Use this when the value of a form is a constant. This obeys for-effect.
3084 (defun byte-compile-constant (const)
3085 (if for-effect
3086 (setq for-effect nil)
3087 (when (symbolp const)
3088 (byte-compile-set-symbol-position const))
3089 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
3091 ;; Use this for a constant that is not the value of its containing form.
3092 ;; This ignores for-effect.
3093 (defun byte-compile-push-constant (const)
3094 (let ((for-effect nil))
3095 (inline (byte-compile-constant const))))
3097 ;; Compile those primitive ordinary functions
3098 ;; which have special byte codes just for speed.
3100 (defmacro byte-defop-compiler (function &optional compile-handler)
3101 "Add a compiler-form for FUNCTION.
3102 If function is a symbol, then the variable \"byte-SYMBOL\" must name
3103 the opcode to be used. If function is a list, the first element
3104 is the function and the second element is the bytecode-symbol.
3105 The second element may be nil, meaning there is no opcode.
3106 COMPILE-HANDLER is the function to use to compile this byte-op, or
3107 may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
3108 If it is nil, then the handler is \"byte-compile-SYMBOL.\""
3109 (let (opcode)
3110 (if (symbolp function)
3111 (setq opcode (intern (concat "byte-" (symbol-name function))))
3112 (setq opcode (car (cdr function))
3113 function (car function)))
3114 (let ((fnform
3115 (list 'put (list 'quote function) ''byte-compile
3116 (list 'quote
3117 (or (cdr (assq compile-handler
3118 '((0 . byte-compile-no-args)
3119 (1 . byte-compile-one-arg)
3120 (2 . byte-compile-two-args)
3121 (3 . byte-compile-three-args)
3122 (0-1 . byte-compile-zero-or-one-arg)
3123 (1-2 . byte-compile-one-or-two-args)
3124 (2-3 . byte-compile-two-or-three-args)
3126 compile-handler
3127 (intern (concat "byte-compile-"
3128 (symbol-name function))))))))
3129 (if opcode
3130 (list 'progn fnform
3131 (list 'put (list 'quote function)
3132 ''byte-opcode (list 'quote opcode))
3133 (list 'put (list 'quote opcode)
3134 ''byte-opcode-invert (list 'quote function)))
3135 fnform))))
3137 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
3138 (list 'byte-defop-compiler (list function nil) compile-handler))
3141 (put 'byte-call 'byte-opcode-invert 'funcall)
3142 (put 'byte-list1 'byte-opcode-invert 'list)
3143 (put 'byte-list2 'byte-opcode-invert 'list)
3144 (put 'byte-list3 'byte-opcode-invert 'list)
3145 (put 'byte-list4 'byte-opcode-invert 'list)
3146 (put 'byte-listN 'byte-opcode-invert 'list)
3147 (put 'byte-concat2 'byte-opcode-invert 'concat)
3148 (put 'byte-concat3 'byte-opcode-invert 'concat)
3149 (put 'byte-concat4 'byte-opcode-invert 'concat)
3150 (put 'byte-concatN 'byte-opcode-invert 'concat)
3151 (put 'byte-insertN 'byte-opcode-invert 'insert)
3153 (byte-defop-compiler point 0)
3154 ;;(byte-defop-compiler mark 0) ;; obsolete
3155 (byte-defop-compiler point-max 0)
3156 (byte-defop-compiler point-min 0)
3157 (byte-defop-compiler following-char 0)
3158 (byte-defop-compiler preceding-char 0)
3159 (byte-defop-compiler current-column 0)
3160 (byte-defop-compiler eolp 0)
3161 (byte-defop-compiler eobp 0)
3162 (byte-defop-compiler bolp 0)
3163 (byte-defop-compiler bobp 0)
3164 (byte-defop-compiler current-buffer 0)
3165 ;;(byte-defop-compiler read-char 0) ;; obsolete
3166 (byte-defop-compiler widen 0)
3167 (byte-defop-compiler end-of-line 0-1)
3168 (byte-defop-compiler forward-char 0-1)
3169 (byte-defop-compiler forward-line 0-1)
3170 (byte-defop-compiler symbolp 1)
3171 (byte-defop-compiler consp 1)
3172 (byte-defop-compiler stringp 1)
3173 (byte-defop-compiler listp 1)
3174 (byte-defop-compiler not 1)
3175 (byte-defop-compiler (null byte-not) 1)
3176 (byte-defop-compiler car 1)
3177 (byte-defop-compiler cdr 1)
3178 (byte-defop-compiler length 1)
3179 (byte-defop-compiler symbol-value 1)
3180 (byte-defop-compiler symbol-function 1)
3181 (byte-defop-compiler (1+ byte-add1) 1)
3182 (byte-defop-compiler (1- byte-sub1) 1)
3183 (byte-defop-compiler goto-char 1)
3184 (byte-defop-compiler char-after 0-1)
3185 (byte-defop-compiler set-buffer 1)
3186 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3187 (byte-defop-compiler forward-word 0-1)
3188 (byte-defop-compiler char-syntax 1)
3189 (byte-defop-compiler nreverse 1)
3190 (byte-defop-compiler car-safe 1)
3191 (byte-defop-compiler cdr-safe 1)
3192 (byte-defop-compiler numberp 1)
3193 (byte-defop-compiler integerp 1)
3194 (byte-defop-compiler skip-chars-forward 1-2)
3195 (byte-defop-compiler skip-chars-backward 1-2)
3196 (byte-defop-compiler eq 2)
3197 (byte-defop-compiler memq 2)
3198 (byte-defop-compiler cons 2)
3199 (byte-defop-compiler aref 2)
3200 (byte-defop-compiler set 2)
3201 (byte-defop-compiler (= byte-eqlsign) 2)
3202 (byte-defop-compiler (< byte-lss) 2)
3203 (byte-defop-compiler (> byte-gtr) 2)
3204 (byte-defop-compiler (<= byte-leq) 2)
3205 (byte-defop-compiler (>= byte-geq) 2)
3206 (byte-defop-compiler get 2)
3207 (byte-defop-compiler nth 2)
3208 (byte-defop-compiler substring 2-3)
3209 (byte-defop-compiler (move-marker byte-set-marker) 2-3)
3210 (byte-defop-compiler set-marker 2-3)
3211 (byte-defop-compiler match-beginning 1)
3212 (byte-defop-compiler match-end 1)
3213 (byte-defop-compiler upcase 1)
3214 (byte-defop-compiler downcase 1)
3215 (byte-defop-compiler string= 2)
3216 (byte-defop-compiler string< 2)
3217 (byte-defop-compiler (string-equal byte-string=) 2)
3218 (byte-defop-compiler (string-lessp byte-string<) 2)
3219 (byte-defop-compiler equal 2)
3220 (byte-defop-compiler nthcdr 2)
3221 (byte-defop-compiler elt 2)
3222 (byte-defop-compiler member 2)
3223 (byte-defop-compiler assq 2)
3224 (byte-defop-compiler (rplaca byte-setcar) 2)
3225 (byte-defop-compiler (rplacd byte-setcdr) 2)
3226 (byte-defop-compiler setcar 2)
3227 (byte-defop-compiler setcdr 2)
3228 (byte-defop-compiler buffer-substring 2)
3229 (byte-defop-compiler delete-region 2)
3230 (byte-defop-compiler narrow-to-region 2)
3231 (byte-defop-compiler (% byte-rem) 2)
3232 (byte-defop-compiler aset 3)
3234 (byte-defop-compiler max byte-compile-associative)
3235 (byte-defop-compiler min byte-compile-associative)
3236 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3237 (byte-defop-compiler (* byte-mult) byte-compile-associative)
3239 ;;####(byte-defop-compiler move-to-column 1)
3240 (byte-defop-compiler-1 interactive byte-compile-noop)
3243 (defun byte-compile-subr-wrong-args (form n)
3244 (byte-compile-set-symbol-position (car form))
3245 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3246 (car form) (length (cdr form))
3247 (if (= 1 (length (cdr form))) "" "s") n)
3248 ;; get run-time wrong-number-of-args error.
3249 (byte-compile-normal-call form))
3251 (defun byte-compile-no-args (form)
3252 (if (not (= (length form) 1))
3253 (byte-compile-subr-wrong-args form "none")
3254 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3256 (defun byte-compile-one-arg (form)
3257 (if (not (= (length form) 2))
3258 (byte-compile-subr-wrong-args form 1)
3259 (byte-compile-form (car (cdr form))) ;; Push the argument
3260 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3262 (defun byte-compile-two-args (form)
3263 (if (not (= (length form) 3))
3264 (byte-compile-subr-wrong-args form 2)
3265 (byte-compile-form (car (cdr form))) ;; Push the arguments
3266 (byte-compile-form (nth 2 form))
3267 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3269 (defun byte-compile-three-args (form)
3270 (if (not (= (length form) 4))
3271 (byte-compile-subr-wrong-args form 3)
3272 (byte-compile-form (car (cdr form))) ;; Push the arguments
3273 (byte-compile-form (nth 2 form))
3274 (byte-compile-form (nth 3 form))
3275 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3277 (defun byte-compile-zero-or-one-arg (form)
3278 (let ((len (length form)))
3279 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3280 ((= len 2) (byte-compile-one-arg form))
3281 (t (byte-compile-subr-wrong-args form "0-1")))))
3283 (defun byte-compile-one-or-two-args (form)
3284 (let ((len (length form)))
3285 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3286 ((= len 3) (byte-compile-two-args form))
3287 (t (byte-compile-subr-wrong-args form "1-2")))))
3289 (defun byte-compile-two-or-three-args (form)
3290 (let ((len (length form)))
3291 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3292 ((= len 4) (byte-compile-three-args form))
3293 (t (byte-compile-subr-wrong-args form "2-3")))))
3295 (defun byte-compile-noop (form)
3296 (byte-compile-constant nil))
3298 (defun byte-compile-discard (&optional num preserve-tos)
3299 "Output byte codes to discard the NUM entries at the top of the stack (NUM defaults to 1).
3300 If PRESERVE-TOS is non-nil, preserve the top-of-stack value, as if it were
3301 popped before discarding the num values, and then pushed back again after
3302 discarding."
3303 (if (and (null num) (not preserve-tos))
3304 ;; common case
3305 (byte-compile-out 'byte-discard)
3306 ;; general case
3307 (unless num
3308 (setq num 1))
3309 (when (and preserve-tos (> num 0))
3310 ;; Preserve the top-of-stack value by writing it directly to the stack
3311 ;; location which will be at the top-of-stack after popping.
3312 (byte-compile-stack-set (1- (- byte-compile-depth num)))
3313 ;; Now we actually discard one less value, since we want to keep
3314 ;; the eventual TOS
3315 (setq num (1- num)))
3316 (while (> num 0)
3317 (byte-compile-out 'byte-discard)
3318 (setq num (1- num)))))
3320 (defun byte-compile-stack-ref (stack-pos)
3321 "Output byte codes to push the value at position STACK-POS in the stack, on the top of the stack."
3322 (let ((dist (- byte-compile-depth (1+ stack-pos))))
3323 (if (zerop dist)
3324 ;; A simple optimization
3325 (byte-compile-out 'byte-dup)
3326 ;; normal case
3327 (byte-compile-out 'byte-stack-ref dist))))
3329 (defun byte-compile-stack-set (stack-pos)
3330 "Output byte codes to store the top-of-stack value at position STACK-POS in the stack."
3331 (byte-compile-out 'byte-stack-set (- byte-compile-depth (1+ stack-pos))))
3333 (byte-defop-compiler-1 internal-make-closure byte-compile-make-closure)
3334 (byte-defop-compiler-1 internal-get-closed-var byte-compile-get-closed-var)
3336 (defconst byte-compile--env-var (make-symbol "env"))
3338 (defun byte-compile-make-closure (form)
3339 (if for-effect (setq for-effect nil)
3340 (let* ((vars (nth 1 form))
3341 (env (nth 2 form))
3342 (body (nthcdr 3 form))
3343 (fun
3344 (byte-compile-lambda `(lambda ,vars . ,body) nil (length env))))
3345 (assert (byte-code-function-p fun))
3346 (byte-compile-form `(make-byte-code
3347 ',(aref fun 0) ',(aref fun 1)
3348 (vconcat (vector . ,env) ',(aref fun 2))
3349 ,@(nthcdr 3 (mapcar (lambda (x) `',x) fun)))))))
3352 (defun byte-compile-get-closed-var (form)
3353 (if for-effect (setq for-effect nil)
3354 (byte-compile-out 'byte-constant ;; byte-closed-var
3355 (nth 1 form))))
3357 ;; Compile a function that accepts one or more args and is right-associative.
3358 ;; We do it by left-associativity so that the operations
3359 ;; are done in the same order as in interpreted code.
3360 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3361 ;; in order to convert markers to numbers, and trigger expected errors.
3362 (defun byte-compile-associative (form)
3363 (if (cdr form)
3364 (let ((opcode (get (car form) 'byte-opcode))
3365 args)
3366 (if (and (< 3 (length form))
3367 (memq opcode (list (get '+ 'byte-opcode)
3368 (get '* 'byte-opcode))))
3369 ;; Don't use binary operations for > 2 operands, as that
3370 ;; may cause overflow/truncation in float operations.
3371 (byte-compile-normal-call form)
3372 (setq args (copy-sequence (cdr form)))
3373 (byte-compile-form (car args))
3374 (setq args (cdr args))
3375 (or args (setq args '(0)
3376 opcode (get '+ 'byte-opcode)))
3377 (dolist (arg args)
3378 (byte-compile-form arg)
3379 (byte-compile-out opcode 0))))
3380 (byte-compile-constant (eval form))))
3383 ;; more complicated compiler macros
3385 (byte-defop-compiler char-before)
3386 (byte-defop-compiler backward-char)
3387 (byte-defop-compiler backward-word)
3388 (byte-defop-compiler list)
3389 (byte-defop-compiler concat)
3390 (byte-defop-compiler fset)
3391 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3392 (byte-defop-compiler indent-to)
3393 (byte-defop-compiler insert)
3394 (byte-defop-compiler-1 function byte-compile-function-form)
3395 (byte-defop-compiler-1 - byte-compile-minus)
3396 (byte-defop-compiler (/ byte-quo) byte-compile-quo)
3397 (byte-defop-compiler nconc)
3399 (defun byte-compile-char-before (form)
3400 (cond ((= 2 (length form))
3401 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3402 (1- (nth 1 form))
3403 `(1- ,(nth 1 form))))))
3404 ((= 1 (length form))
3405 (byte-compile-form '(char-after (1- (point)))))
3406 (t (byte-compile-subr-wrong-args form "0-1"))))
3408 ;; backward-... ==> forward-... with negated argument.
3409 (defun byte-compile-backward-char (form)
3410 (cond ((= 2 (length form))
3411 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3412 (- (nth 1 form))
3413 `(- ,(nth 1 form))))))
3414 ((= 1 (length form))
3415 (byte-compile-form '(forward-char -1)))
3416 (t (byte-compile-subr-wrong-args form "0-1"))))
3418 (defun byte-compile-backward-word (form)
3419 (cond ((= 2 (length form))
3420 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3421 (- (nth 1 form))
3422 `(- ,(nth 1 form))))))
3423 ((= 1 (length form))
3424 (byte-compile-form '(forward-word -1)))
3425 (t (byte-compile-subr-wrong-args form "0-1"))))
3427 (defun byte-compile-list (form)
3428 (let ((count (length (cdr form))))
3429 (cond ((= count 0)
3430 (byte-compile-constant nil))
3431 ((< count 5)
3432 (mapc 'byte-compile-form (cdr form))
3433 (byte-compile-out
3434 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3435 ((< count 256)
3436 (mapc 'byte-compile-form (cdr form))
3437 (byte-compile-out 'byte-listN count))
3438 (t (byte-compile-normal-call form)))))
3440 (defun byte-compile-concat (form)
3441 (let ((count (length (cdr form))))
3442 (cond ((and (< 1 count) (< count 5))
3443 (mapc 'byte-compile-form (cdr form))
3444 (byte-compile-out
3445 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3447 ;; Concat of one arg is not a no-op if arg is not a string.
3448 ((= count 0)
3449 (byte-compile-form ""))
3450 ((< count 256)
3451 (mapc 'byte-compile-form (cdr form))
3452 (byte-compile-out 'byte-concatN count))
3453 ((byte-compile-normal-call form)))))
3455 (defun byte-compile-minus (form)
3456 (let ((len (length form)))
3457 (cond
3458 ((= 1 len) (byte-compile-constant 0))
3459 ((= 2 len)
3460 (byte-compile-form (cadr form))
3461 (byte-compile-out 'byte-negate 0))
3462 ((= 3 len)
3463 (byte-compile-form (nth 1 form))
3464 (byte-compile-form (nth 2 form))
3465 (byte-compile-out 'byte-diff 0))
3466 ;; Don't use binary operations for > 2 operands, as that may
3467 ;; cause overflow/truncation in float operations.
3468 (t (byte-compile-normal-call form)))))
3470 (defun byte-compile-quo (form)
3471 (let ((len (length form)))
3472 (cond ((<= len 2)
3473 (byte-compile-subr-wrong-args form "2 or more"))
3474 ((= len 3)
3475 (byte-compile-two-args form))
3477 ;; Don't use binary operations for > 2 operands, as that
3478 ;; may cause overflow/truncation in float operations.
3479 (byte-compile-normal-call form)))))
3481 (defun byte-compile-nconc (form)
3482 (let ((len (length form)))
3483 (cond ((= len 1)
3484 (byte-compile-constant nil))
3485 ((= len 2)
3486 ;; nconc of one arg is a noop, even if that arg isn't a list.
3487 (byte-compile-form (nth 1 form)))
3489 (byte-compile-form (car (setq form (cdr form))))
3490 (while (setq form (cdr form))
3491 (byte-compile-form (car form))
3492 (byte-compile-out 'byte-nconc 0))))))
3494 (defun byte-compile-fset (form)
3495 ;; warn about forms like (fset 'foo '(lambda () ...))
3496 ;; (where the lambda expression is non-trivial...)
3497 (let ((fn (nth 2 form))
3498 body)
3499 (if (and (eq (car-safe fn) 'quote)
3500 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3501 (progn
3502 (setq body (cdr (cdr fn)))
3503 (if (stringp (car body)) (setq body (cdr body)))
3504 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3505 (if (and (consp (car body))
3506 (not (eq 'byte-code (car (car body)))))
3507 (byte-compile-warn
3508 "A quoted lambda form is the second argument of `fset'. This is probably
3509 not what you want, as that lambda cannot be compiled. Consider using
3510 the syntax (function (lambda (...) ...)) instead.")))))
3511 (byte-compile-two-args form))
3513 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3514 ;; Otherwise it will be incompatible with the interpreter,
3515 ;; and (funcall (function foo)) will lose with autoloads.
3517 (defun byte-compile-function-form (form)
3518 (if (symbolp (nth 1 form))
3519 (byte-compile-constant (nth 1 form))
3520 (byte-compile-closure (nth 1 form))))
3522 (defun byte-compile-indent-to (form)
3523 (let ((len (length form)))
3524 (cond ((= len 2)
3525 (byte-compile-form (car (cdr form)))
3526 (byte-compile-out 'byte-indent-to 0))
3527 ((= len 3)
3528 ;; no opcode for 2-arg case.
3529 (byte-compile-normal-call form))
3531 (byte-compile-subr-wrong-args form "1-2")))))
3533 (defun byte-compile-insert (form)
3534 (cond ((null (cdr form))
3535 (byte-compile-constant nil))
3536 ((<= (length form) 256)
3537 (mapc 'byte-compile-form (cdr form))
3538 (if (cdr (cdr form))
3539 (byte-compile-out 'byte-insertN (length (cdr form)))
3540 (byte-compile-out 'byte-insert 0)))
3541 ((memq t (mapcar 'consp (cdr (cdr form))))
3542 (byte-compile-normal-call form))
3543 ;; We can split it; there is no function call after inserting 1st arg.
3545 (while (setq form (cdr form))
3546 (byte-compile-form (car form))
3547 (byte-compile-out 'byte-insert 0)
3548 (if (cdr form)
3549 (byte-compile-discard))))))
3552 (byte-defop-compiler-1 setq)
3553 (byte-defop-compiler-1 setq-default)
3554 (byte-defop-compiler-1 quote)
3556 (defun byte-compile-setq (form)
3557 (let ((bytecomp-args (cdr form)))
3558 (if bytecomp-args
3559 (while bytecomp-args
3560 (byte-compile-form (car (cdr bytecomp-args)))
3561 (or for-effect (cdr (cdr bytecomp-args))
3562 (byte-compile-out 'byte-dup 0))
3563 (byte-compile-variable-set (car bytecomp-args))
3564 (setq bytecomp-args (cdr (cdr bytecomp-args))))
3565 ;; (setq), with no arguments.
3566 (byte-compile-form nil for-effect))
3567 (setq for-effect nil)))
3569 (defun byte-compile-setq-default (form)
3570 (setq form (cdr form))
3571 (if (> (length form) 2)
3572 (let ((setters ()))
3573 (while (consp form)
3574 (push `(setq-default ,(pop form) ,(pop form)) setters))
3575 (byte-compile-form (cons 'progn (nreverse setters))))
3576 (let ((var (car form)))
3577 (and (or (not (symbolp var))
3578 (byte-compile-const-symbol-p var t))
3579 (byte-compile-warning-enabled-p 'constants)
3580 (byte-compile-warn
3581 "variable assignment to %s `%s'"
3582 (if (symbolp var) "constant" "nonvariable")
3583 (prin1-to-string var)))
3584 (byte-compile-normal-call `(set-default ',var ,@(cdr form))))))
3586 (byte-defop-compiler-1 set-default)
3587 (defun byte-compile-set-default (form)
3588 (let ((varexp (car-safe (cdr-safe form))))
3589 (if (eq (car-safe varexp) 'quote)
3590 ;; If the varexp is constant, compile it as a setq-default
3591 ;; so we get more warnings.
3592 (byte-compile-setq-default `(setq-default ,(car-safe (cdr varexp))
3593 ,@(cddr form)))
3594 (byte-compile-normal-call form))))
3596 (defun byte-compile-quote (form)
3597 (byte-compile-constant (car (cdr form))))
3599 ;;; control structures
3601 (defun byte-compile-body (bytecomp-body &optional for-effect)
3602 (while (cdr bytecomp-body)
3603 (byte-compile-form (car bytecomp-body) t)
3604 (setq bytecomp-body (cdr bytecomp-body)))
3605 (byte-compile-form (car bytecomp-body) for-effect))
3607 (defsubst byte-compile-body-do-effect (bytecomp-body)
3608 (byte-compile-body bytecomp-body for-effect)
3609 (setq for-effect nil))
3611 (defsubst byte-compile-form-do-effect (form)
3612 (byte-compile-form form for-effect)
3613 (setq for-effect nil))
3615 (byte-defop-compiler-1 inline byte-compile-progn)
3616 (byte-defop-compiler-1 progn)
3617 (byte-defop-compiler-1 prog1)
3618 (byte-defop-compiler-1 prog2)
3619 (byte-defop-compiler-1 if)
3620 (byte-defop-compiler-1 cond)
3621 (byte-defop-compiler-1 and)
3622 (byte-defop-compiler-1 or)
3623 (byte-defop-compiler-1 while)
3624 (byte-defop-compiler-1 funcall)
3625 (byte-defop-compiler-1 let)
3626 (byte-defop-compiler-1 let* byte-compile-let)
3628 (defun byte-compile-progn (form)
3629 (byte-compile-body-do-effect (cdr form)))
3631 (defun byte-compile-prog1 (form)
3632 (byte-compile-form-do-effect (car (cdr form)))
3633 (byte-compile-body (cdr (cdr form)) t))
3635 (defun byte-compile-prog2 (form)
3636 (byte-compile-form (nth 1 form) t)
3637 (byte-compile-form-do-effect (nth 2 form))
3638 (byte-compile-body (cdr (cdr (cdr form))) t))
3640 (defmacro byte-compile-goto-if (cond discard tag)
3641 `(byte-compile-goto
3642 (if ,cond
3643 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3644 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3645 ,tag))
3647 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3648 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3649 (defun byte-compile-find-bound-condition (condition-param
3650 pred-list
3651 &optional only-if-not-present)
3652 (let ((result nil)
3653 (nth-one nil)
3654 (cond-list
3655 (if (memq (car-safe condition-param) pred-list)
3656 ;; The condition appears by itself.
3657 (list condition-param)
3658 ;; If the condition is an `and', look for matches among the
3659 ;; `and' arguments.
3660 (when (eq 'and (car-safe condition-param))
3661 (cdr condition-param)))))
3663 (dolist (crt cond-list)
3664 (when (and (memq (car-safe crt) pred-list)
3665 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3666 ;; Ignore if the symbol is already on the unresolved
3667 ;; list.
3668 (not (assq (nth 1 nth-one) ; the relevant symbol
3669 only-if-not-present)))
3670 (push (nth 1 (nth 1 crt)) result)))
3671 result))
3673 (defmacro byte-compile-maybe-guarded (condition &rest body)
3674 "Execute forms in BODY, potentially guarded by CONDITION.
3675 CONDITION is a variable whose value is a test in an `if' or `cond'.
3676 BODY is the code to compile in the first arm of the if or the body of
3677 the cond clause. If CONDITION's value is of the form (fboundp 'foo)
3678 or (boundp 'foo), the relevant warnings from BODY about foo's
3679 being undefined (or obsolete) will be suppressed.
3681 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3682 that suppresses all warnings during execution of BODY."
3683 (declare (indent 1) (debug t))
3684 `(let* ((fbound-list (byte-compile-find-bound-condition
3685 ,condition (list 'fboundp)
3686 byte-compile-unresolved-functions))
3687 (bound-list (byte-compile-find-bound-condition
3688 ,condition (list 'boundp 'default-boundp)))
3689 ;; Maybe add to the bound list.
3690 (byte-compile-bound-variables
3691 (append bound-list byte-compile-bound-variables)))
3692 (unwind-protect
3693 ;; If things not being bound at all is ok, so must them being obsolete.
3694 ;; Note that we add to the existing lists since Tramp (ab)uses
3695 ;; this feature.
3696 (let ((byte-compile-not-obsolete-vars
3697 (append byte-compile-not-obsolete-vars bound-list))
3698 (byte-compile-not-obsolete-funcs
3699 (append byte-compile-not-obsolete-funcs fbound-list)))
3700 ,@body)
3701 ;; Maybe remove the function symbol from the unresolved list.
3702 (dolist (fbound fbound-list)
3703 (when fbound
3704 (setq byte-compile-unresolved-functions
3705 (delq (assq fbound byte-compile-unresolved-functions)
3706 byte-compile-unresolved-functions)))))))
3708 (defun byte-compile-if (form)
3709 (byte-compile-form (car (cdr form)))
3710 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3711 ;; and avoid warnings about the relevent symbols in the consequent.
3712 (let ((clause (nth 1 form))
3713 (donetag (byte-compile-make-tag)))
3714 (if (null (nthcdr 3 form))
3715 ;; No else-forms
3716 (progn
3717 (byte-compile-goto-if nil for-effect donetag)
3718 (byte-compile-maybe-guarded clause
3719 (byte-compile-form (nth 2 form) for-effect))
3720 (byte-compile-out-tag donetag))
3721 (let ((elsetag (byte-compile-make-tag)))
3722 (byte-compile-goto 'byte-goto-if-nil elsetag)
3723 (byte-compile-maybe-guarded clause
3724 (byte-compile-form (nth 2 form) for-effect))
3725 (byte-compile-goto 'byte-goto donetag)
3726 (byte-compile-out-tag elsetag)
3727 (byte-compile-maybe-guarded (list 'not clause)
3728 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3729 (byte-compile-out-tag donetag))))
3730 (setq for-effect nil))
3732 (defun byte-compile-cond (clauses)
3733 (let ((donetag (byte-compile-make-tag))
3734 nexttag clause)
3735 (while (setq clauses (cdr clauses))
3736 (setq clause (car clauses))
3737 (cond ((or (eq (car clause) t)
3738 (and (eq (car-safe (car clause)) 'quote)
3739 (car-safe (cdr-safe (car clause)))))
3740 ;; Unconditional clause
3741 (setq clause (cons t clause)
3742 clauses nil))
3743 ((cdr clauses)
3744 (byte-compile-form (car clause))
3745 (if (null (cdr clause))
3746 ;; First clause is a singleton.
3747 (byte-compile-goto-if t for-effect donetag)
3748 (setq nexttag (byte-compile-make-tag))
3749 (byte-compile-goto 'byte-goto-if-nil nexttag)
3750 (byte-compile-maybe-guarded (car clause)
3751 (byte-compile-body (cdr clause) for-effect))
3752 (byte-compile-goto 'byte-goto donetag)
3753 (byte-compile-out-tag nexttag)))))
3754 ;; Last clause
3755 (let ((guard (car clause)))
3756 (and (cdr clause) (not (eq guard t))
3757 (progn (byte-compile-form guard)
3758 (byte-compile-goto-if nil for-effect donetag)
3759 (setq clause (cdr clause))))
3760 (byte-compile-maybe-guarded guard
3761 (byte-compile-body-do-effect clause)))
3762 (byte-compile-out-tag donetag)))
3764 (defun byte-compile-and (form)
3765 (let ((failtag (byte-compile-make-tag))
3766 (bytecomp-args (cdr form)))
3767 (if (null bytecomp-args)
3768 (byte-compile-form-do-effect t)
3769 (byte-compile-and-recursion bytecomp-args failtag))))
3771 ;; Handle compilation of a nontrivial `and' call.
3772 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3773 (defun byte-compile-and-recursion (rest failtag)
3774 (if (cdr rest)
3775 (progn
3776 (byte-compile-form (car rest))
3777 (byte-compile-goto-if nil for-effect failtag)
3778 (byte-compile-maybe-guarded (car rest)
3779 (byte-compile-and-recursion (cdr rest) failtag)))
3780 (byte-compile-form-do-effect (car rest))
3781 (byte-compile-out-tag failtag)))
3783 (defun byte-compile-or (form)
3784 (let ((wintag (byte-compile-make-tag))
3785 (bytecomp-args (cdr form)))
3786 (if (null bytecomp-args)
3787 (byte-compile-form-do-effect nil)
3788 (byte-compile-or-recursion bytecomp-args wintag))))
3790 ;; Handle compilation of a nontrivial `or' call.
3791 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3792 (defun byte-compile-or-recursion (rest wintag)
3793 (if (cdr rest)
3794 (progn
3795 (byte-compile-form (car rest))
3796 (byte-compile-goto-if t for-effect wintag)
3797 (byte-compile-maybe-guarded (list 'not (car rest))
3798 (byte-compile-or-recursion (cdr rest) wintag)))
3799 (byte-compile-form-do-effect (car rest))
3800 (byte-compile-out-tag wintag)))
3802 (defun byte-compile-while (form)
3803 (let ((endtag (byte-compile-make-tag))
3804 (looptag (byte-compile-make-tag)))
3805 (byte-compile-out-tag looptag)
3806 (byte-compile-form (car (cdr form)))
3807 (byte-compile-goto-if nil for-effect endtag)
3808 (byte-compile-body (cdr (cdr form)) t)
3809 (byte-compile-goto 'byte-goto looptag)
3810 (byte-compile-out-tag endtag)
3811 (setq for-effect nil)))
3813 (defun byte-compile-funcall (form)
3814 (mapc 'byte-compile-form (cdr form))
3815 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3818 ;; let binding
3820 (defun byte-compile-push-binding-init (clause)
3821 "Emit byte-codes to push the initialization value for CLAUSE on the stack.
3822 Return the offset in the form (VAR . OFFSET)."
3823 (let* ((var (if (consp clause) (car clause) clause)))
3824 ;; We record the stack position even of dynamic bindings and
3825 ;; variables in non-stack lexical environments; we'll put
3826 ;; them in the proper place below.
3827 (prog1 (cons var byte-compile-depth)
3828 (if (consp clause)
3829 (byte-compile-form (cadr clause))
3830 (byte-compile-push-constant nil)))))
3832 (defun byte-compile-not-lexical-var-p (var)
3833 (or (not (symbolp var))
3834 (special-variable-p var)
3835 (memq var byte-compile-bound-variables)
3836 (memq var '(nil t))
3837 (keywordp var)))
3839 (defun byte-compile-bind (var init-lexenv)
3840 "Emit byte-codes to bind VAR and update `byte-compile-lexical-environment'.
3841 INIT-LEXENV should be a lexical-environment alist describing the
3842 positions of the init value that have been pushed on the stack.
3843 Return non-nil if the TOS value was popped."
3844 ;; The presence of lexical bindings mean that we may have to
3845 ;; juggle things on the stack, to move them to TOS for
3846 ;; dynamic binding.
3847 (cond ((not (byte-compile-not-lexical-var-p var))
3848 ;; VAR is a simple stack-allocated lexical variable
3849 (push (assq var init-lexenv)
3850 byte-compile-lexical-environment)
3851 nil)
3852 ((eq var (caar init-lexenv))
3853 ;; VAR is dynamic and is on the top of the
3854 ;; stack, so we can just bind it like usual
3855 (byte-compile-dynamic-variable-bind var)
3858 ;; VAR is dynamic, but we have to get its
3859 ;; value out of the middle of the stack
3860 (let ((stack-pos (cdr (assq var init-lexenv))))
3861 (byte-compile-stack-ref stack-pos)
3862 (byte-compile-dynamic-variable-bind var)
3863 ;; Now we have to store nil into its temporary
3864 ;; stack position to avoid problems with GC
3865 (byte-compile-push-constant nil)
3866 (byte-compile-stack-set stack-pos))
3867 nil)))
3869 (defun byte-compile-unbind (clauses init-lexenv
3870 &optional preserve-body-value)
3871 "Emit byte-codes to unbind the variables bound by CLAUSES.
3872 CLAUSES is a `let'-style variable binding list. INIT-LEXENV should be a
3873 lexical-environment alist describing the positions of the init value that
3874 have been pushed on the stack. If PRESERVE-BODY-VALUE is true,
3875 then an additional value on the top of the stack, above any lexical binding
3876 slots, is preserved, so it will be on the top of the stack after all
3877 binding slots have been popped."
3878 ;; Unbind dynamic variables
3879 (let ((num-dynamic-bindings 0))
3880 (dolist (clause clauses)
3881 (unless (assq (if (consp clause) (car clause) clause)
3882 byte-compile-lexical-environment)
3883 (setq num-dynamic-bindings (1+ num-dynamic-bindings))))
3884 (unless (zerop num-dynamic-bindings)
3885 (byte-compile-out 'byte-unbind num-dynamic-bindings)))
3886 ;; Pop lexical variables off the stack, possibly preserving the
3887 ;; return value of the body.
3888 (when init-lexenv
3889 ;; INIT-LEXENV contains all init values left on the stack
3890 (byte-compile-discard (length init-lexenv) preserve-body-value)))
3892 (defun byte-compile-let (form)
3893 "Generate code for the `let' form FORM."
3894 (let ((clauses (cadr form))
3895 (init-lexenv nil))
3896 (when (eq (car form) 'let)
3897 ;; First compute the binding values in the old scope.
3898 (dolist (var clauses)
3899 (push (byte-compile-push-binding-init var) init-lexenv)))
3900 ;; New scope.
3901 (let ((byte-compile-bound-variables byte-compile-bound-variables)
3902 (byte-compile-lexical-environment byte-compile-lexical-environment))
3903 ;; Bind the variables.
3904 ;; For `let', do it in reverse order, because it makes no
3905 ;; semantic difference, but it is a lot more efficient since the
3906 ;; values are now in reverse order on the stack.
3907 (dolist (var (if (eq (car form) 'let) (reverse clauses) clauses))
3908 (unless (eq (car form) 'let)
3909 (push (byte-compile-push-binding-init var) init-lexenv))
3910 (let ((var (if (consp var) (car var) var)))
3911 (cond ((null lexical-binding)
3912 ;; If there are no lexical bindings, we can do things simply.
3913 (byte-compile-dynamic-variable-bind var))
3914 ((byte-compile-bind var init-lexenv)
3915 (pop init-lexenv)))))
3916 ;; Emit the body.
3917 (let ((init-stack-depth byte-compile-depth))
3918 (byte-compile-body-do-effect (cdr (cdr form)))
3919 ;; Unbind the variables.
3920 (if lexical-binding
3921 ;; Unbind both lexical and dynamic variables.
3922 (progn
3923 (assert (or (eq byte-compile-depth init-stack-depth)
3924 (eq byte-compile-depth (1+ init-stack-depth))))
3925 (byte-compile-unbind clauses init-lexenv (> byte-compile-depth
3926 init-stack-depth)))
3927 ;; Unbind dynamic variables.
3928 (byte-compile-out 'byte-unbind (length clauses)))))))
3932 (byte-defop-compiler-1 /= byte-compile-negated)
3933 (byte-defop-compiler-1 atom byte-compile-negated)
3934 (byte-defop-compiler-1 nlistp byte-compile-negated)
3936 (put '/= 'byte-compile-negated-op '=)
3937 (put 'atom 'byte-compile-negated-op 'consp)
3938 (put 'nlistp 'byte-compile-negated-op 'listp)
3940 (defun byte-compile-negated (form)
3941 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3943 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3944 (defun byte-compile-negation-optimizer (form)
3945 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3946 (byte-compile-set-symbol-position (car form))
3947 (list 'not
3948 (cons (or (get (car form) 'byte-compile-negated-op)
3949 (error
3950 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3951 (car form)))
3952 (cdr form))))
3955 ;;; other tricky macro-like special-forms
3957 (byte-defop-compiler-1 catch)
3958 (byte-defop-compiler-1 unwind-protect)
3959 (byte-defop-compiler-1 condition-case)
3960 (byte-defop-compiler-1 save-excursion)
3961 (byte-defop-compiler-1 save-current-buffer)
3962 (byte-defop-compiler-1 save-restriction)
3963 (byte-defop-compiler-1 track-mouse)
3965 (defun byte-compile-catch (form)
3966 (byte-compile-form (car (cdr form)))
3967 (pcase (cddr form)
3968 (`(:fun-body ,f)
3969 (byte-compile-form `(list 'funcall ,f)))
3970 (body
3971 (byte-compile-push-constant
3972 (byte-compile-top-level (cons 'progn body) for-effect))))
3973 (byte-compile-out 'byte-catch 0))
3975 (defun byte-compile-unwind-protect (form)
3976 (pcase (cddr form)
3977 (`(:fun-body ,f)
3978 (byte-compile-form `(list (list 'funcall ,f))))
3979 (handlers
3980 (byte-compile-push-constant
3981 (byte-compile-top-level-body handlers t))))
3982 (byte-compile-out 'byte-unwind-protect 0)
3983 (byte-compile-form-do-effect (car (cdr form)))
3984 (byte-compile-out 'byte-unbind 1))
3986 (defun byte-compile-track-mouse (form)
3987 (byte-compile-form
3988 (pcase form
3989 (`(,_ :fun-body ,f) `(eval (list 'track-mouse (list 'funcall ,f))))
3990 (_ `(eval '(track-mouse ,@(byte-compile-top-level-body (cdr form))))))))
3992 (defun byte-compile-condition-case (form)
3993 (let* ((var (nth 1 form))
3994 (fun-bodies (eq var :fun-body))
3995 (byte-compile-bound-variables
3996 (if (and var (not fun-bodies))
3997 (cons var byte-compile-bound-variables)
3998 byte-compile-bound-variables)))
3999 (byte-compile-set-symbol-position 'condition-case)
4000 (unless (symbolp var)
4001 (byte-compile-warn
4002 "`%s' is not a variable-name or nil (in condition-case)" var))
4003 (if fun-bodies (setq var (make-symbol "err")))
4004 (byte-compile-push-constant var)
4005 (if fun-bodies
4006 (byte-compile-form `(list 'funcall ,(nth 2 form)))
4007 (byte-compile-push-constant
4008 (byte-compile-top-level (nth 2 form) for-effect)))
4009 (let ((compiled-clauses
4010 (mapcar
4011 (lambda (clause)
4012 (let ((condition (car clause)))
4013 (cond ((not (or (symbolp condition)
4014 (and (listp condition)
4015 (let ((ok t))
4016 (dolist (sym condition)
4017 (if (not (symbolp sym))
4018 (setq ok nil)))
4019 ok))))
4020 (byte-compile-warn
4021 "`%S' is not a condition name or list of such (in condition-case)"
4022 condition))
4023 ;; (not (or (eq condition 't)
4024 ;; (and (stringp (get condition 'error-message))
4025 ;; (consp (get condition
4026 ;; 'error-conditions)))))
4027 ;; (byte-compile-warn
4028 ;; "`%s' is not a known condition name
4029 ;; (in condition-case)"
4030 ;; condition))
4032 (if fun-bodies
4033 `(list ',condition (list 'funcall ,(cadr clause) ',var))
4034 (cons condition
4035 (byte-compile-top-level-body
4036 (cdr clause) for-effect)))))
4037 (cdr (cdr (cdr form))))))
4038 (if fun-bodies
4039 (byte-compile-form `(list ,@compiled-clauses))
4040 (byte-compile-push-constant compiled-clauses)))
4041 (byte-compile-out 'byte-condition-case 0)))
4044 (defun byte-compile-save-excursion (form)
4045 (if (and (eq 'set-buffer (car-safe (car-safe (cdr form))))
4046 (byte-compile-warning-enabled-p 'suspicious))
4047 (byte-compile-warn "`save-excursion' defeated by `set-buffer'"))
4048 (byte-compile-out 'byte-save-excursion 0)
4049 (byte-compile-body-do-effect (cdr form))
4050 (byte-compile-out 'byte-unbind 1))
4052 (defun byte-compile-save-restriction (form)
4053 (byte-compile-out 'byte-save-restriction 0)
4054 (byte-compile-body-do-effect (cdr form))
4055 (byte-compile-out 'byte-unbind 1))
4057 (defun byte-compile-save-current-buffer (form)
4058 (byte-compile-out 'byte-save-current-buffer 0)
4059 (byte-compile-body-do-effect (cdr form))
4060 (byte-compile-out 'byte-unbind 1))
4062 ;;; top-level forms elsewhere
4064 (byte-defop-compiler-1 defun)
4065 (byte-defop-compiler-1 defmacro)
4066 (byte-defop-compiler-1 defvar)
4067 (byte-defop-compiler-1 defconst byte-compile-defvar)
4068 (byte-defop-compiler-1 autoload)
4069 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
4071 (defun byte-compile-defun (form)
4072 ;; This is not used for file-level defuns with doc strings.
4073 (if (symbolp (car form))
4074 (byte-compile-set-symbol-position (car form))
4075 (byte-compile-set-symbol-position 'defun)
4076 (error "defun name must be a symbol, not %s" (car form)))
4077 (let ((for-effect nil))
4078 (byte-compile-push-constant 'defalias)
4079 (byte-compile-push-constant (nth 1 form))
4080 (byte-compile-closure (cdr (cdr form)) t))
4081 (byte-compile-out 'byte-call 2))
4083 (defun byte-compile-defmacro (form)
4084 ;; This is not used for file-level defmacros with doc strings.
4085 (byte-compile-body-do-effect
4086 (let ((decls (byte-compile-defmacro-declaration form))
4087 (code (byte-compile-byte-code-maker
4088 (byte-compile-lambda (cdr (cdr form)) t))))
4089 `((defalias ',(nth 1 form)
4090 ,(if (eq (car-safe code) 'make-byte-code)
4091 `(cons 'macro ,code)
4092 `'(macro . ,(eval code))))
4093 ,@decls
4094 ',(nth 1 form)))))
4096 (defun byte-compile-defvar (form)
4097 ;; This is not used for file-level defvar/consts with doc strings.
4098 (when (and (symbolp (nth 1 form))
4099 (not (string-match "[-*/:$]" (symbol-name (nth 1 form))))
4100 (byte-compile-warning-enabled-p 'lexical))
4101 (byte-compile-warn "global/dynamic var `%s' lacks a prefix"
4102 (nth 1 form)))
4103 (let ((fun (nth 0 form))
4104 (var (nth 1 form))
4105 (value (nth 2 form))
4106 (string (nth 3 form)))
4107 (byte-compile-set-symbol-position fun)
4108 (when (or (> (length form) 4)
4109 (and (eq fun 'defconst) (null (cddr form))))
4110 (let ((ncall (length (cdr form))))
4111 (byte-compile-warn
4112 "`%s' called with %d argument%s, but %s %s"
4113 fun ncall
4114 (if (= 1 ncall) "" "s")
4115 (if (< ncall 2) "requires" "accepts only")
4116 "2-3")))
4117 (push var byte-compile-bound-variables)
4118 (if (eq fun 'defconst)
4119 (push var byte-compile-const-variables))
4120 (byte-compile-body-do-effect
4121 (list
4122 ;; Put the defined variable in this library's load-history entry
4123 ;; just as a real defvar would, but only in top-level forms.
4124 (when (and (cddr form) (null byte-compile-current-form))
4125 `(setq current-load-list (cons ',var current-load-list)))
4126 (when (> (length form) 3)
4127 (when (and string (not (stringp string)))
4128 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
4129 fun var string))
4130 `(put ',var 'variable-documentation ,string))
4131 (if (cddr form) ; `value' provided
4132 (let ((byte-compile-not-obsolete-vars (list var)))
4133 (if (eq fun 'defconst)
4134 ;; `defconst' sets `var' unconditionally.
4135 (let ((tmp (make-symbol "defconst-tmp-var")))
4136 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
4137 ,value))
4138 ;; `defvar' sets `var' only when unbound.
4139 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
4140 (when (eq fun 'defconst)
4141 ;; This will signal an appropriate error at runtime.
4142 `(eval ',form)))
4143 `',var))))
4145 (defun byte-compile-autoload (form)
4146 (byte-compile-set-symbol-position 'autoload)
4147 (and (byte-compile-constp (nth 1 form))
4148 (byte-compile-constp (nth 5 form))
4149 (eval (nth 5 form)) ; macro-p
4150 (not (fboundp (eval (nth 1 form))))
4151 (byte-compile-warn
4152 "The compiler ignores `autoload' except at top level. You should
4153 probably put the autoload of the macro `%s' at top-level."
4154 (eval (nth 1 form))))
4155 (byte-compile-normal-call form))
4157 ;; Lambdas in valid places are handled as special cases by various code.
4158 ;; The ones that remain are errors.
4159 (defun byte-compile-lambda-form (form)
4160 (byte-compile-set-symbol-position 'lambda)
4161 (error "`lambda' used as function name is invalid"))
4163 ;; Compile normally, but deal with warnings for the function being defined.
4164 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
4165 (defun byte-compile-file-form-defalias (form)
4166 (if (and (consp (cdr form)) (consp (nth 1 form))
4167 (eq (car (nth 1 form)) 'quote)
4168 (consp (cdr (nth 1 form)))
4169 (symbolp (nth 1 (nth 1 form))))
4170 (let ((constant
4171 (and (consp (nthcdr 2 form))
4172 (consp (nth 2 form))
4173 (eq (car (nth 2 form)) 'quote)
4174 (consp (cdr (nth 2 form)))
4175 (symbolp (nth 1 (nth 2 form))))))
4176 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
4177 (push (cons (nth 1 (nth 1 form))
4178 (if constant (nth 1 (nth 2 form)) t))
4179 byte-compile-function-environment)))
4180 ;; We used to just do: (byte-compile-normal-call form)
4181 ;; But it turns out that this fails to optimize the code.
4182 ;; So instead we now do the same as what other byte-hunk-handlers do,
4183 ;; which is to call back byte-compile-file-form and then return nil.
4184 ;; Except that we can't just call byte-compile-file-form since it would
4185 ;; call us right back.
4186 (byte-compile-keep-pending form)
4187 ;; Return nil so the form is not output twice.
4188 nil)
4190 ;; Turn off warnings about prior calls to the function being defalias'd.
4191 ;; This could be smarter and compare those calls with
4192 ;; the function it is being aliased to.
4193 (defun byte-compile-defalias-warn (new)
4194 (let ((calls (assq new byte-compile-unresolved-functions)))
4195 (if calls
4196 (setq byte-compile-unresolved-functions
4197 (delq calls byte-compile-unresolved-functions)))))
4199 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
4200 (defun byte-compile-no-warnings (form)
4201 (let (byte-compile-warnings)
4202 (byte-compile-form (cons 'progn (cdr form)))))
4204 ;; Warn about misuses of make-variable-buffer-local.
4205 (byte-defop-compiler-1 make-variable-buffer-local
4206 byte-compile-make-variable-buffer-local)
4207 (defun byte-compile-make-variable-buffer-local (form)
4208 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
4209 (byte-compile-warning-enabled-p 'make-local))
4210 (byte-compile-warn
4211 "`make-variable-buffer-local' should be called at toplevel"))
4212 (byte-compile-normal-call form))
4213 (put 'make-variable-buffer-local
4214 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
4215 (defun byte-compile-form-make-variable-buffer-local (form)
4216 (byte-compile-keep-pending form 'byte-compile-normal-call))
4219 ;;; tags
4221 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4222 ;; optimization to have the 'TAG as a part of the tag.
4223 ;; Tags will be (TAG . (tag-number . stack-depth)).
4224 (defun byte-compile-make-tag ()
4225 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4228 (defun byte-compile-out-tag (tag)
4229 (setq byte-compile-output (cons tag byte-compile-output))
4230 (if (cdr (cdr tag))
4231 (progn
4232 ;; ## remove this someday
4233 (and byte-compile-depth
4234 (not (= (cdr (cdr tag)) byte-compile-depth))
4235 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
4236 (setq byte-compile-depth (cdr (cdr tag))))
4237 (setcdr (cdr tag) byte-compile-depth)))
4239 (defun byte-compile-goto (opcode tag)
4240 (push (cons opcode tag) byte-compile-output)
4241 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4242 (1- byte-compile-depth)
4243 byte-compile-depth))
4244 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4245 (1- byte-compile-depth))))
4247 (defun byte-compile-stack-adjustment (op operand)
4248 "Return the amount by which an operation adjusts the stack.
4249 OP and OPERAND are as passed to `byte-compile-out'."
4250 (if (memq op '(byte-call byte-discardN byte-discardN-preserve-tos))
4251 ;; For calls, OPERAND is the number of args, so we pop OPERAND + 1
4252 ;; elements, and the push the result, for a total of -OPERAND.
4253 ;; For discardN*, of course, we just pop OPERAND elements.
4254 (- operand)
4255 (or (aref byte-stack+-info (symbol-value op))
4256 ;; Ops with a nil entry in `byte-stack+-info' are byte-codes
4257 ;; that take OPERAND values off the stack and push a result, for
4258 ;; a total of 1 - OPERAND
4259 (- 1 operand))))
4261 (defun byte-compile-out (op &optional operand)
4262 (push (cons op operand) byte-compile-output)
4263 (if (eq op 'byte-return)
4264 ;; This is actually an unnecessary case, because there should be no
4265 ;; more ops behind byte-return.
4266 (setq byte-compile-depth nil)
4267 (setq byte-compile-depth
4268 (+ byte-compile-depth (byte-compile-stack-adjustment op operand)))
4269 (setq byte-compile-maxdepth (max byte-compile-depth byte-compile-maxdepth))
4270 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4273 (defun byte-compile-delay-out (&optional stack-used stack-adjust)
4274 "Add a placeholder to the output, which can be used to later add byte-codes.
4275 Return a position tag that can be passed to `byte-compile-delayed-out'
4276 to add the delayed byte-codes. STACK-USED is the maximum amount of
4277 stack-spaced used by the delayed byte-codes (defaulting to 0), and
4278 STACK-ADJUST is the amount by which the later-added code will adjust the
4279 stack (defaulting to 0); the byte-codes added later _must_ adjust the
4280 stack by this amount! If STACK-ADJUST is 0, then it's not necessary to
4281 actually add anything later; the effect as if nothing was added at all."
4282 ;; We just add a no-op to `byte-compile-output', and return a pointer to
4283 ;; the tail of the list; `byte-compile-delayed-out' uses list surgery
4284 ;; to add the byte-codes.
4285 (when stack-used
4286 (setq byte-compile-maxdepth
4287 (max byte-compile-depth (+ byte-compile-depth (or stack-used 0)))))
4288 (when stack-adjust
4289 (setq byte-compile-depth
4290 (+ byte-compile-depth stack-adjust)))
4291 (push (cons nil (or stack-adjust 0)) byte-compile-output))
4293 (defun byte-compile-delayed-out (position op &optional operand)
4294 "Add at POSITION the byte-operation OP, with optional numeric arg OPERAND.
4295 POSITION should a position returned by `byte-compile-delay-out'.
4296 Return a new position, which can be used to add further operations."
4297 (unless (null (caar position))
4298 (error "Bad POSITION arg to `byte-compile-delayed-out'"))
4299 ;; This is kind of like `byte-compile-out', but we splice into the list
4300 ;; where POSITION is. We don't bother updating `byte-compile-maxdepth'
4301 ;; because that was already done by `byte-compile-delay-out', but we do
4302 ;; update the relative operand stored in the no-op marker currently at
4303 ;; POSITION; since we insert before that marker, this means that if the
4304 ;; caller doesn't insert a sequence of byte-codes that matches the expected
4305 ;; operand passed to `byte-compile-delay-out', then the nop will still have
4306 ;; a non-zero operand when `byte-compile-lapcode' is called, which will
4307 ;; cause an error to be signaled.
4309 ;; Adjust the cumulative stack-adjustment stored in the cdr of the no-op
4310 (setcdr (car position)
4311 (- (cdar position) (byte-compile-stack-adjustment op operand)))
4312 ;; Add the new operation onto the list tail at POSITION
4313 (setcdr position (cons (cons op operand) (cdr position)))
4314 position)
4317 ;;; call tree stuff
4319 (defun byte-compile-annotate-call-tree (form)
4320 (let (entry)
4321 ;; annotate the current call
4322 (if (setq entry (assq (car form) byte-compile-call-tree))
4323 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4324 (setcar (cdr entry)
4325 (cons byte-compile-current-form (nth 1 entry))))
4326 (setq byte-compile-call-tree
4327 (cons (list (car form) (list byte-compile-current-form) nil)
4328 byte-compile-call-tree)))
4329 ;; annotate the current function
4330 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4331 (or (memq (car form) (nth 2 entry)) ;called
4332 (setcar (cdr (cdr entry))
4333 (cons (car form) (nth 2 entry))))
4334 (setq byte-compile-call-tree
4335 (cons (list byte-compile-current-form nil (list (car form)))
4336 byte-compile-call-tree)))
4339 ;; Renamed from byte-compile-report-call-tree
4340 ;; to avoid interfering with completion of byte-compile-file.
4341 ;;;###autoload
4342 (defun display-call-tree (&optional filename)
4343 "Display a call graph of a specified file.
4344 This lists which functions have been called, what functions called
4345 them, and what functions they call. The list includes all functions
4346 whose definitions have been compiled in this Emacs session, as well as
4347 all functions called by those functions.
4349 The call graph does not include macros, inline functions, or
4350 primitives that the byte-code interpreter knows about directly \(eq,
4351 cons, etc.\).
4353 The call tree also lists those functions which are not known to be called
4354 \(that is, to which no calls have been compiled\), and which cannot be
4355 invoked interactively."
4356 (interactive)
4357 (message "Generating call tree...")
4358 (with-output-to-temp-buffer "*Call-Tree*"
4359 (set-buffer "*Call-Tree*")
4360 (erase-buffer)
4361 (message "Generating call tree... (sorting on %s)"
4362 byte-compile-call-tree-sort)
4363 (insert "Call tree for "
4364 (cond ((null byte-compile-current-file) (or filename "???"))
4365 ((stringp byte-compile-current-file)
4366 byte-compile-current-file)
4367 (t (buffer-name byte-compile-current-file)))
4368 " sorted on "
4369 (prin1-to-string byte-compile-call-tree-sort)
4370 ":\n\n")
4371 (if byte-compile-call-tree-sort
4372 (setq byte-compile-call-tree
4373 (sort byte-compile-call-tree
4374 (cond ((eq byte-compile-call-tree-sort 'callers)
4375 (function (lambda (x y) (< (length (nth 1 x))
4376 (length (nth 1 y))))))
4377 ((eq byte-compile-call-tree-sort 'calls)
4378 (function (lambda (x y) (< (length (nth 2 x))
4379 (length (nth 2 y))))))
4380 ((eq byte-compile-call-tree-sort 'calls+callers)
4381 (function (lambda (x y) (< (+ (length (nth 1 x))
4382 (length (nth 2 x)))
4383 (+ (length (nth 1 y))
4384 (length (nth 2 y)))))))
4385 ((eq byte-compile-call-tree-sort 'name)
4386 (function (lambda (x y) (string< (car x)
4387 (car y)))))
4388 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4389 byte-compile-call-tree-sort))))))
4390 (message "Generating call tree...")
4391 (let ((rest byte-compile-call-tree)
4392 (b (current-buffer))
4394 callers calls)
4395 (while rest
4396 (prin1 (car (car rest)) b)
4397 (setq callers (nth 1 (car rest))
4398 calls (nth 2 (car rest)))
4399 (insert "\t"
4400 (cond ((not (fboundp (setq f (car (car rest)))))
4401 (if (null f)
4402 " <top level>";; shouldn't insert nil then, actually -sk
4403 " <not defined>"))
4404 ((subrp (setq f (symbol-function f)))
4405 " <subr>")
4406 ((symbolp f)
4407 (format " ==> %s" f))
4408 ((byte-code-function-p f)
4409 "<compiled function>")
4410 ((not (consp f))
4411 "<malformed function>")
4412 ((eq 'macro (car f))
4413 (if (or (byte-code-function-p (cdr f))
4414 (assq 'byte-code (cdr (cdr (cdr f)))))
4415 " <compiled macro>"
4416 " <macro>"))
4417 ((assq 'byte-code (cdr (cdr f)))
4418 "<compiled lambda>")
4419 ((eq 'lambda (car f))
4420 "<function>")
4421 (t "???"))
4422 (format " (%d callers + %d calls = %d)"
4423 ;; Does the optimizer eliminate common subexpressions?-sk
4424 (length callers)
4425 (length calls)
4426 (+ (length callers) (length calls)))
4427 "\n")
4428 (if callers
4429 (progn
4430 (insert " called by:\n")
4431 (setq p (point))
4432 (insert " " (if (car callers)
4433 (mapconcat 'symbol-name callers ", ")
4434 "<top level>"))
4435 (let ((fill-prefix " "))
4436 (fill-region-as-paragraph p (point)))
4437 (unless (= 0 (current-column))
4438 (insert "\n"))))
4439 (if calls
4440 (progn
4441 (insert " calls:\n")
4442 (setq p (point))
4443 (insert " " (mapconcat 'symbol-name calls ", "))
4444 (let ((fill-prefix " "))
4445 (fill-region-as-paragraph p (point)))
4446 (unless (= 0 (current-column))
4447 (insert "\n"))))
4448 (setq rest (cdr rest)))
4450 (message "Generating call tree...(finding uncalled functions...)")
4451 (setq rest byte-compile-call-tree)
4452 (let (uncalled def)
4453 (while rest
4454 (or (nth 1 (car rest))
4455 (null (setq f (caar rest)))
4456 (progn
4457 (setq def (byte-compile-fdefinition f t))
4458 (and (eq (car-safe def) 'macro)
4459 (eq (car-safe (cdr-safe def)) 'lambda)
4460 (setq def (cdr def)))
4461 (functionp def))
4462 (progn
4463 (setq def (byte-compile-fdefinition f nil))
4464 (and (eq (car-safe def) 'macro)
4465 (eq (car-safe (cdr-safe def)) 'lambda)
4466 (setq def (cdr def)))
4467 (commandp def))
4468 (setq uncalled (cons f uncalled)))
4469 (setq rest (cdr rest)))
4470 (if uncalled
4471 (let ((fill-prefix " "))
4472 (insert "Noninteractive functions not known to be called:\n ")
4473 (setq p (point))
4474 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4475 (fill-region-as-paragraph p (point))))))
4476 (message "Generating call tree...done.")))
4479 ;;;###autoload
4480 (defun batch-byte-compile-if-not-done ()
4481 "Like `byte-compile-file' but doesn't recompile if already up to date.
4482 Use this from the command line, with `-batch';
4483 it won't work in an interactive Emacs."
4484 (batch-byte-compile t))
4486 ;;; by crl@newton.purdue.edu
4487 ;;; Only works noninteractively.
4488 ;;;###autoload
4489 (defun batch-byte-compile (&optional noforce)
4490 "Run `byte-compile-file' on the files remaining on the command line.
4491 Use this from the command line, with `-batch';
4492 it won't work in an interactive Emacs.
4493 Each file is processed even if an error occurred previously.
4494 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4495 If NOFORCE is non-nil, don't recompile a file that seems to be
4496 already up-to-date."
4497 ;; command-line-args-left is what is left of the command line (from startup.el)
4498 (defvar command-line-args-left) ;Avoid 'free variable' warning
4499 (if (not noninteractive)
4500 (error "`batch-byte-compile' is to be used only with -batch"))
4501 (let ((bytecomp-error nil))
4502 (while command-line-args-left
4503 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4504 ;; Directory as argument.
4505 (let ((bytecomp-files (directory-files (car command-line-args-left)))
4506 bytecomp-source bytecomp-dest)
4507 (dolist (bytecomp-file bytecomp-files)
4508 (if (and (string-match emacs-lisp-file-regexp bytecomp-file)
4509 (not (auto-save-file-name-p bytecomp-file))
4510 (setq bytecomp-source
4511 (expand-file-name bytecomp-file
4512 (car command-line-args-left)))
4513 (setq bytecomp-dest (byte-compile-dest-file
4514 bytecomp-source))
4515 (file-exists-p bytecomp-dest)
4516 (file-newer-than-file-p bytecomp-source bytecomp-dest))
4517 (if (null (batch-byte-compile-file bytecomp-source))
4518 (setq bytecomp-error t)))))
4519 ;; Specific file argument
4520 (if (or (not noforce)
4521 (let* ((bytecomp-source (car command-line-args-left))
4522 (bytecomp-dest (byte-compile-dest-file bytecomp-source)))
4523 (or (not (file-exists-p bytecomp-dest))
4524 (file-newer-than-file-p bytecomp-source bytecomp-dest))))
4525 (if (null (batch-byte-compile-file (car command-line-args-left)))
4526 (setq bytecomp-error t))))
4527 (setq command-line-args-left (cdr command-line-args-left)))
4528 (kill-emacs (if bytecomp-error 1 0))))
4530 (defun batch-byte-compile-file (bytecomp-file)
4531 (if debug-on-error
4532 (byte-compile-file bytecomp-file)
4533 (condition-case err
4534 (byte-compile-file bytecomp-file)
4535 (file-error
4536 (message (if (cdr err)
4537 ">>Error occurred processing %s: %s (%s)"
4538 ">>Error occurred processing %s: %s")
4539 bytecomp-file
4540 (get (car err) 'error-message)
4541 (prin1-to-string (cdr err)))
4542 (let ((bytecomp-destfile (byte-compile-dest-file bytecomp-file)))
4543 (if (file-exists-p bytecomp-destfile)
4544 (delete-file bytecomp-destfile)))
4545 nil)
4546 (error
4547 (message (if (cdr err)
4548 ">>Error occurred processing %s: %s (%s)"
4549 ">>Error occurred processing %s: %s")
4550 bytecomp-file
4551 (get (car err) 'error-message)
4552 (prin1-to-string (cdr err)))
4553 nil))))
4555 (defun byte-compile-refresh-preloaded ()
4556 "Reload any Lisp file that was changed since Emacs was dumped.
4557 Use with caution."
4558 (let* ((argv0 (car command-line-args))
4559 (emacs-file (executable-find argv0)))
4560 (if (not (and emacs-file (file-executable-p emacs-file)))
4561 (message "Can't find %s to refresh preloaded Lisp files" argv0)
4562 (dolist (f (reverse load-history))
4563 (setq f (car f))
4564 (if (string-match "elc\\'" f) (setq f (substring f 0 -1)))
4565 (when (and (file-readable-p f)
4566 (file-newer-than-file-p f emacs-file)
4567 ;; Don't reload the source version of the files below
4568 ;; because that causes subsequent byte-compilation to
4569 ;; be a lot slower and need a higher max-lisp-eval-depth,
4570 ;; so it can cause recompilation to fail.
4571 (not (member (file-name-nondirectory f)
4572 '("pcase.el" "bytecomp.el" "macroexp.el"
4573 "cconv.el" "byte-opt.el"))))
4574 (message "Reloading stale %s" (file-name-nondirectory f))
4575 (condition-case nil
4576 (load f 'noerror nil 'nosuffix)
4577 ;; Probably shouldn't happen, but in case of an error, it seems
4578 ;; at least as useful to ignore it as it is to stop compilation.
4579 (error nil)))))))
4581 ;;;###autoload
4582 (defun batch-byte-recompile-directory (&optional arg)
4583 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4584 Must be used only with `-batch', and kills Emacs on completion.
4585 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4587 Optional argument ARG is passed as second argument ARG to
4588 `byte-recompile-directory'; see there for its possible values
4589 and corresponding effects."
4590 ;; command-line-args-left is what is left of the command line (startup.el)
4591 (defvar command-line-args-left) ;Avoid 'free variable' warning
4592 (if (not noninteractive)
4593 (error "batch-byte-recompile-directory is to be used only with -batch"))
4594 (or command-line-args-left
4595 (setq command-line-args-left '(".")))
4596 (while command-line-args-left
4597 (byte-recompile-directory (car command-line-args-left) arg)
4598 (setq command-line-args-left (cdr command-line-args-left)))
4599 (kill-emacs 0))
4601 (provide 'byte-compile)
4602 (provide 'bytecomp)
4605 ;;; report metering (see the hacks in bytecode.c)
4607 (defvar byte-code-meter)
4608 (defun byte-compile-report-ops ()
4609 (or (boundp 'byte-metering-on)
4610 (error "You must build Emacs with -DBYTE_CODE_METER to use this"))
4611 (with-output-to-temp-buffer "*Meter*"
4612 (set-buffer "*Meter*")
4613 (let ((i 0) n op off)
4614 (while (< i 256)
4615 (setq n (aref (aref byte-code-meter 0) i)
4616 off nil)
4617 (if t ;(not (zerop n))
4618 (progn
4619 (setq op i)
4620 (setq off nil)
4621 (cond ((< op byte-nth)
4622 (setq off (logand op 7))
4623 (setq op (logand op 248)))
4624 ((>= op byte-constant)
4625 (setq off (- op byte-constant)
4626 op byte-constant)))
4627 (setq op (aref byte-code-vector op))
4628 (insert (format "%-4d" i))
4629 (insert (symbol-name op))
4630 (if off (insert " [" (int-to-string off) "]"))
4631 (indent-to 40)
4632 (insert (int-to-string n) "\n")))
4633 (setq i (1+ i))))))
4635 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4636 ;; itself, compile some of its most used recursive functions (at load time).
4638 (eval-when-compile
4639 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4640 (assq 'byte-code (symbol-function 'byte-compile-form))
4641 (let ((byte-optimize nil) ; do it fast
4642 (byte-compile-warnings nil))
4643 (mapc (lambda (x)
4644 (or noninteractive (message "compiling %s..." x))
4645 (byte-compile x)
4646 (or noninteractive (message "compiling %s...done" x)))
4647 '(byte-compile-normal-call
4648 byte-compile-form
4649 byte-compile-body
4650 ;; Inserted some more than necessary, to speed it up.
4651 byte-compile-top-level
4652 byte-compile-out-toplevel
4653 byte-compile-constant
4654 byte-compile-variable-ref))))
4655 nil)
4657 (run-hooks 'bytecomp-load-hook)
4659 ;;; bytecomp.el ends here