Johan Bockg� <bojohan at gnu.org>
[emacs.git] / lisp / emacs-lisp / bytecomp.el
blob0249c0dc78cc9087fe422e8b84bd0482cc176bbb
1 ;;; bytecomp.el --- compilation of Lisp code into byte code
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1998, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>
7 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
8 ;; Maintainer: FSF
9 ;; Keywords: lisp
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; The Emacs Lisp byte compiler. This crunches lisp source into a sort
31 ;; of p-code (`lapcode') which takes up less space and can be interpreted
32 ;; faster. [`LAP' == `Lisp Assembly Program'.]
33 ;; The user entry points are byte-compile-file and byte-recompile-directory.
35 ;;; Code:
37 ;; ========================================================================
38 ;; Entry points:
39 ;; byte-recompile-directory, byte-compile-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:
73 ;; byte-compile-verbose Whether to report the function currently being
74 ;; compiled in the echo area;
75 ;; byte-optimize Whether to do optimizations; this may be
76 ;; t, nil, 'source, or 'byte;
77 ;; byte-optimize-log Whether to report (in excruciating detail)
78 ;; exactly which optimizations have been made.
79 ;; This may be t, nil, 'source, or 'byte;
80 ;; byte-compile-error-on-warn Whether to stop compilation when a warning is
81 ;; produced;
82 ;; byte-compile-delete-errors Whether the optimizer may delete calls or
83 ;; variable references that are side-effect-free
84 ;; except that they may return an error.
85 ;; byte-compile-generate-call-tree Whether to generate a histogram of
86 ;; function calls. This can be useful for
87 ;; finding unused functions, as well as simple
88 ;; performance metering.
89 ;; byte-compile-warnings List of warnings to issue, or t. May contain
90 ;; `free-vars' (references to variables not in the
91 ;; current lexical scope)
92 ;; `unresolved' (calls to unknown functions)
93 ;; `callargs' (lambda calls with args that don't
94 ;; match the lambda's definition)
95 ;; `redefine' (function cell redefined from
96 ;; a macro to a lambda or vice versa,
97 ;; or redefined to take other args)
98 ;; `obsolete' (obsolete variables and functions)
99 ;; `noruntime' (calls to functions only defined
100 ;; within `eval-when-compile')
101 ;; `cl-functions' (calls to CL functions)
102 ;; `interactive-only' (calls to commands that are
103 ;; not good to call from Lisp)
104 ;; `make-local' (dubious calls to
105 ;; `make-variable-buffer-local')
106 ;; `mapcar' (mapcar called for effect)
107 ;; byte-compile-compatibility Whether the compiler should
108 ;; generate .elc files which can be loaded into
109 ;; generic emacs 18.
110 ;; emacs-lisp-file-regexp Regexp for the extension of source-files;
111 ;; see also the function byte-compile-dest-file.
113 ;; New Features:
115 ;; o The form `defsubst' is just like `defun', except that the function
116 ;; generated will be open-coded in compiled code which uses it. This
117 ;; means that no function call will be generated, it will simply be
118 ;; spliced in. Lisp functions calls are very slow, so this can be a
119 ;; big win.
121 ;; You can generally accomplish the same thing with `defmacro', but in
122 ;; that case, the defined procedure can't be used as an argument to
123 ;; mapcar, etc.
125 ;; o You can also open-code one particular call to a function without
126 ;; open-coding all calls. Use the 'inline' form to do this, like so:
128 ;; (inline (foo 1 2 3)) ;; `foo' will be open-coded
129 ;; or...
130 ;; (inline ;; `foo' and `baz' will be
131 ;; (foo 1 2 3 (bar 5)) ;; open-coded, but `bar' will not.
132 ;; (baz 0))
134 ;; o It is possible to open-code a function in the same file it is defined
135 ;; in without having to load that file before compiling it. The
136 ;; byte-compiler has been modified to remember function definitions in
137 ;; the compilation environment in the same way that it remembers macro
138 ;; definitions.
140 ;; o Forms like ((lambda ...) ...) are open-coded.
142 ;; o The form `eval-when-compile' is like progn, except that the body
143 ;; is evaluated at compile-time. When it appears at top-level, this
144 ;; is analogous to the Common Lisp idiom (eval-when (compile) ...).
145 ;; When it does not appear at top-level, it is similar to the
146 ;; Common Lisp #. reader macro (but not in interpreted code).
148 ;; o The form `eval-and-compile' is similar to eval-when-compile, but
149 ;; the whole form is evalled both at compile-time and at run-time.
151 ;; o The command compile-defun is analogous to eval-defun.
153 ;; o If you run byte-compile-file on a filename which is visited in a
154 ;; buffer, and that buffer is modified, you are asked whether you want
155 ;; to save the buffer before compiling.
157 ;; o byte-compiled files now start with the string `;ELC'.
158 ;; Some versions of `file' can be customized to recognize that.
160 (require 'backquote)
162 (or (fboundp 'defsubst)
163 ;; This really ought to be loaded already!
164 (load "byte-run"))
166 ;; The feature of compiling in a specific target Emacs version
167 ;; has been turned off because compile time options are a bad idea.
168 (defmacro byte-compile-single-version () nil)
169 (defmacro byte-compile-version-cond (cond) cond)
171 ;; The crud you see scattered through this file of the form
172 ;; (or (and (boundp 'epoch::version) epoch::version)
173 ;; (string-lessp emacs-version "19"))
174 ;; is because the Epoch folks couldn't be bothered to follow the
175 ;; normal emacs version numbering convention.
177 ;; (if (byte-compile-version-cond
178 ;; (or (and (boundp 'epoch::version) epoch::version)
179 ;; (string-lessp emacs-version "19")))
180 ;; (progn
181 ;; ;; emacs-18 compatibility.
182 ;; (defvar baud-rate (baud-rate)) ;Define baud-rate if it's undefined
184 ;; (if (byte-compile-single-version)
185 ;; (defmacro byte-code-function-p (x) "Emacs 18 doesn't have these." nil)
186 ;; (defun byte-code-function-p (x) "Emacs 18 doesn't have these." nil))
188 ;; (or (and (fboundp 'member)
189 ;; ;; avoid using someone else's possibly bogus definition of this.
190 ;; (subrp (symbol-function 'member)))
191 ;; (defun member (elt list)
192 ;; "like memq, but uses equal instead of eq. In v19, this is a subr."
193 ;; (while (and list (not (equal elt (car list))))
194 ;; (setq list (cdr list)))
195 ;; list))))
198 (defgroup bytecomp nil
199 "Emacs Lisp byte-compiler."
200 :group 'lisp)
202 (defcustom emacs-lisp-file-regexp (if (eq system-type 'vax-vms)
203 "\\.EL\\(;[0-9]+\\)?$"
204 "\\.el$")
205 "*Regexp which matches Emacs Lisp source files.
206 You may want to redefine the function `byte-compile-dest-file'
207 if you change this variable."
208 :group 'bytecomp
209 :type 'regexp)
211 ;; This enables file name handlers such as jka-compr
212 ;; to remove parts of the file name that should not be copied
213 ;; through to the output file name.
214 (defun byte-compiler-base-file-name (filename)
215 (let ((handler (find-file-name-handler filename
216 'byte-compiler-base-file-name)))
217 (if handler
218 (funcall handler 'byte-compiler-base-file-name filename)
219 filename)))
221 (or (fboundp 'byte-compile-dest-file)
222 ;; The user may want to redefine this along with emacs-lisp-file-regexp,
223 ;; so only define it if it is undefined.
224 (defun byte-compile-dest-file (filename)
225 "Convert an Emacs Lisp source file name to a compiled file name.
226 If FILENAME matches `emacs-lisp-file-regexp' (by default, files
227 with the extension `.el'), add `c' to it; otherwise add `.elc'."
228 (setq filename (byte-compiler-base-file-name filename))
229 (setq filename (file-name-sans-versions filename))
230 (cond ((eq system-type 'vax-vms)
231 (concat (substring filename 0 (string-match ";" filename)) "c"))
232 ((string-match emacs-lisp-file-regexp filename)
233 (concat (substring filename 0 (match-beginning 0)) ".elc"))
234 (t (concat filename ".elc")))))
236 ;; This can be the 'byte-compile property of any symbol.
237 (autoload 'byte-compile-inline-expand "byte-opt")
239 ;; This is the entrypoint to the lapcode optimizer pass1.
240 (autoload 'byte-optimize-form "byte-opt")
241 ;; This is the entrypoint to the lapcode optimizer pass2.
242 (autoload 'byte-optimize-lapcode "byte-opt")
243 (autoload 'byte-compile-unfold-lambda "byte-opt")
245 ;; This is the entry point to the decompiler, which is used by the
246 ;; disassembler. The disassembler just requires 'byte-compile, but
247 ;; that doesn't define this function, so this seems to be a reasonable
248 ;; thing to do.
249 (autoload 'byte-decompile-bytecode "byte-opt")
251 (defcustom byte-compile-verbose
252 (and (not noninteractive) (> baud-rate search-slow-speed))
253 "*Non-nil means print messages describing progress of byte-compiler."
254 :group 'bytecomp
255 :type 'boolean)
257 (defcustom byte-compile-compatibility nil
258 "*Non-nil means generate output that can run in Emacs 18.
259 This only means that it can run in principle, if it doesn't require
260 facilities that have been added more recently."
261 :group 'bytecomp
262 :type 'boolean)
264 ;; (defvar byte-compile-generate-emacs19-bytecodes
265 ;; (not (or (and (boundp 'epoch::version) epoch::version)
266 ;; (string-lessp emacs-version "19")))
267 ;; "*If this is true, then the byte-compiler will generate bytecode which
268 ;; makes use of byte-ops which are present only in Emacs 19. Code generated
269 ;; this way can never be run in Emacs 18, and may even cause it to crash.")
271 (defcustom byte-optimize t
272 "*Enable optimization in the byte compiler.
273 Possible values are:
274 nil - no optimization
275 t - all optimizations
276 `source' - source-level optimizations only
277 `byte' - code-level optimizations only"
278 :group 'bytecomp
279 :type '(choice (const :tag "none" nil)
280 (const :tag "all" t)
281 (const :tag "source-level" source)
282 (const :tag "byte-level" byte)))
284 (defcustom byte-compile-delete-errors nil
285 "*If non-nil, the optimizer may delete forms that may signal an error.
286 This includes variable references and calls to functions such as `car'."
287 :group 'bytecomp
288 :type 'boolean)
290 (defvar byte-compile-dynamic nil
291 "If non-nil, compile function bodies so they load lazily.
292 They are hidden in comments in the compiled file,
293 and each one is brought into core when the
294 function is called.
296 To enable this option, make it a file-local variable
297 in the source file you want it to apply to.
298 For example, add -*-byte-compile-dynamic: t;-*- on the first line.
300 When this option is true, if you load the compiled file and then move it,
301 the functions you loaded will not be able to run.")
302 ;;;###autoload(put 'byte-compile-dynamic 'safe-local-variable 'booleanp)
304 (defvar byte-compile-disable-print-circle nil
305 "If non-nil, disable `print-circle' on printing a byte-compiled code.")
306 ;;;###autoload(put 'byte-compile-disable-print-circle 'safe-local-variable 'booleanp)
308 (defcustom byte-compile-dynamic-docstrings t
309 "*If non-nil, compile doc strings for lazy access.
310 We bury the doc strings of functions and variables
311 inside comments in the file, and bring them into core only when they
312 are actually needed.
314 When this option is true, if you load the compiled file and then move it,
315 you won't be able to find the documentation of anything in that file.
317 To disable this option for a certain file, make it a file-local variable
318 in the source file. For example, add this to the first line:
319 -*-byte-compile-dynamic-docstrings:nil;-*-
320 You can also set the variable globally.
322 This option is enabled by default because it reduces Emacs memory usage."
323 :group 'bytecomp
324 :type 'boolean)
325 ;;;###autoload(put 'byte-compile-dynamic-docstrings 'safe-local-variable 'booleanp)
327 (defcustom byte-optimize-log nil
328 "*If true, the byte-compiler will log its optimizations into *Compile-Log*.
329 If this is 'source, then only source-level optimizations will be logged.
330 If it is 'byte, then only byte-level optimizations will be logged."
331 :group 'bytecomp
332 :type '(choice (const :tag "none" nil)
333 (const :tag "all" t)
334 (const :tag "source-level" source)
335 (const :tag "byte-level" byte)))
337 (defcustom byte-compile-error-on-warn nil
338 "*If true, the byte-compiler reports warnings with `error'."
339 :group 'bytecomp
340 :type 'boolean)
342 (defconst byte-compile-warning-types
343 '(redefine callargs free-vars unresolved
344 obsolete noruntime cl-functions interactive-only
345 make-local mapcar)
346 "The list of warning types used when `byte-compile-warnings' is t.")
347 (defcustom byte-compile-warnings t
348 "*List of warnings that the byte-compiler should issue (t for all).
350 Elements of the list may be:
352 free-vars references to variables not in the current lexical scope.
353 unresolved calls to unknown functions.
354 callargs function calls with args that don't match the definition.
355 redefine function name redefined from a macro to ordinary function or vice
356 versa, or redefined to take a different number of arguments.
357 obsolete obsolete variables and functions.
358 noruntime functions that may not be defined at runtime (typically
359 defined only under `eval-when-compile').
360 cl-functions calls to runtime functions from the CL package (as
361 distinguished from macros and aliases).
362 interactive-only
363 commands that normally shouldn't be called from Lisp code.
364 make-local calls to make-variable-buffer-local that may be incorrect.
365 mapcar mapcar called for effect.
367 If the list begins with `not', then the remaining elements specify warnings to
368 suppress. For example, (not mapcar) will suppress warnings about mapcar."
369 :group 'bytecomp
370 :type `(choice (const :tag "All" t)
371 (set :menu-tag "Some"
372 (const free-vars) (const unresolved)
373 (const callargs) (const redefine)
374 (const obsolete) (const noruntime)
375 (const cl-functions) (const interactive-only)
376 (const make-local) (const mapcar))))
377 ;;;###autoload(put 'byte-compile-warnings 'safe-local-variable 'byte-compile-warnings-safe-p)
379 ;;;###autoload
380 (defun byte-compile-warnings-safe-p (x)
381 "Return non-nil if X is valid as a value of `byte-compile-warnings'."
382 (or (booleanp x)
383 (and (listp x)
384 (if (eq (car x) 'not) (setq x (cdr x))
386 (equal (mapcar
387 (lambda (e)
388 (when (memq e byte-compile-warning-types)
391 x))))
393 (defun byte-compile-warning-enabled-p (warning)
394 "Return non-nil if WARNING is enabled, according to `byte-compile-warnings'."
395 (or (eq byte-compile-warnings t)
396 (if (eq (car byte-compile-warnings) 'not)
397 (not (memq warning byte-compile-warnings))
398 (memq warning byte-compile-warnings))))
400 ;;;###autoload
401 (defun byte-compile-disable-warning (warning)
402 "Change `byte-compile-warnings' to disable WARNING.
403 If `byte-compile-warnings' is t, set it to `(not WARNING)'.
404 Otherwise, if the first element is `not', add WARNING, else remove it.
405 Normally you should let-bind `byte-compile-warnings' before calling this,
406 else the global value will be modified."
407 (setq byte-compile-warnings
408 (cond ((eq byte-compile-warnings t)
409 (list 'not warning))
410 ((eq (car byte-compile-warnings) 'not)
411 (if (memq warning byte-compile-warnings)
412 byte-compile-warnings
413 (append byte-compile-warnings (list warning))))
415 (delq warning byte-compile-warnings)))))
417 ;;;###autoload
418 (defun byte-compile-enable-warning (warning)
419 "Change `byte-compile-warnings' to enable WARNING.
420 If `byte-compile-warnings' is `t', do nothing. Otherwise, if the
421 first element is `not', remove WARNING, else add it.
422 Normally you should let-bind `byte-compile-warnings' before calling this,
423 else the global value will be modified."
424 (or (eq byte-compile-warnings t)
425 (setq byte-compile-warnings
426 (cond ((eq (car byte-compile-warnings) 'not)
427 (delq warning byte-compile-warnings))
428 ((memq warning byte-compile-warnings)
429 byte-compile-warnings)
431 (append byte-compile-warnings (list warning)))))))
433 (defvar byte-compile-interactive-only-functions
434 '(beginning-of-buffer end-of-buffer replace-string replace-regexp
435 insert-file insert-buffer insert-file-literally previous-line next-line)
436 "List of commands that are not meant to be called from Lisp.")
438 (defvar byte-compile-not-obsolete-var nil
439 "If non-nil, this is a variable that shouldn't be reported as obsolete.")
441 (defcustom byte-compile-generate-call-tree nil
442 "*Non-nil means collect call-graph information when compiling.
443 This records which functions were called and from where.
444 If the value is t, compilation displays the call graph when it finishes.
445 If the value is neither t nor nil, compilation asks you whether to display
446 the graph.
448 The call tree only lists functions called, not macros used. Those functions
449 which the byte-code interpreter knows about directly (eq, cons, etc.) are
450 not reported.
452 The call tree also lists those functions which are not known to be called
453 \(that is, to which no calls have been compiled). Functions which can be
454 invoked interactively are excluded from this list."
455 :group 'bytecomp
456 :type '(choice (const :tag "Yes" t) (const :tag "No" nil)
457 (other :tag "Ask" lambda)))
459 (defvar byte-compile-call-tree nil "Alist of functions and their call tree.
460 Each element looks like
462 \(FUNCTION CALLERS CALLS\)
464 where CALLERS is a list of functions that call FUNCTION, and CALLS
465 is a list of functions for which calls were generated while compiling
466 FUNCTION.")
468 (defcustom byte-compile-call-tree-sort 'name
469 "*If non-nil, sort the call tree.
470 The values `name', `callers', `calls', `calls+callers'
471 specify different fields to sort on."
472 :group 'bytecomp
473 :type '(choice (const name) (const callers) (const calls)
474 (const calls+callers) (const nil)))
476 (defvar byte-compile-debug nil)
478 ;; (defvar byte-compile-overwrite-file t
479 ;; "If nil, old .elc files are deleted before the new is saved, and .elc
480 ;; files will have the same modes as the corresponding .el file. Otherwise,
481 ;; existing .elc files will simply be overwritten, and the existing modes
482 ;; will not be changed. If this variable is nil, then an .elc file which
483 ;; is a symbolic link will be turned into a normal file, instead of the file
484 ;; which the link points to being overwritten.")
486 (defvar byte-compile-constants nil
487 "List of all constants encountered during compilation of this form.")
488 (defvar byte-compile-variables nil
489 "List of all variables encountered during compilation of this form.")
490 (defvar byte-compile-bound-variables nil
491 "List of variables bound in the context of the current form.
492 This list lives partly on the stack.")
493 (defvar byte-compile-const-variables nil
494 "List of variables declared as constants during compilation of this file.")
495 (defvar byte-compile-free-references)
496 (defvar byte-compile-free-assignments)
498 (defvar byte-compiler-error-flag)
500 (defconst byte-compile-initial-macro-environment
502 ;; (byte-compiler-options . (lambda (&rest forms)
503 ;; (apply 'byte-compiler-options-handler forms)))
504 (eval-when-compile . (lambda (&rest body)
505 (list 'quote
506 (byte-compile-eval (byte-compile-top-level
507 (cons 'progn body))))))
508 (eval-and-compile . (lambda (&rest body)
509 (byte-compile-eval-before-compile (cons 'progn body))
510 (cons 'progn body))))
511 "The default macro-environment passed to macroexpand by the compiler.
512 Placing a macro here will cause a macro to have different semantics when
513 expanded by the compiler as when expanded by the interpreter.")
515 (defvar byte-compile-macro-environment byte-compile-initial-macro-environment
516 "Alist of macros defined in the file being compiled.
517 Each element looks like (MACRONAME . DEFINITION). It is
518 \(MACRONAME . nil) when a macro is redefined as a function.")
520 (defvar byte-compile-function-environment nil
521 "Alist of functions defined in the file being compiled.
522 This is so we can inline them when necessary.
523 Each element looks like (FUNCTIONNAME . DEFINITION). It is
524 \(FUNCTIONNAME . nil) when a function is redefined as a macro.
525 It is \(FUNCTIONNAME . t) when all we know is that it was defined,
526 and we don't know the definition.")
528 (defvar byte-compile-unresolved-functions nil
529 "Alist of undefined functions to which calls have been compiled.
530 This variable is only significant whilst compiling an entire buffer.
531 Used for warnings when a function is not known to be defined or is later
532 defined with incorrect args.")
534 (defvar byte-compile-noruntime-functions nil
535 "Alist of functions called that may not be defined when the compiled code is run.
536 Used for warnings about calling a function that is defined during compilation
537 but won't necessarily be defined when the compiled file is loaded.")
539 (defvar byte-compile-tag-number 0)
540 (defvar byte-compile-output nil
541 "Alist describing contents to put in byte code string.
542 Each element is (INDEX . VALUE)")
543 (defvar byte-compile-depth 0 "Current depth of execution stack.")
544 (defvar byte-compile-maxdepth 0 "Maximum depth of execution stack.")
547 ;;; The byte codes; this information is duplicated in bytecomp.c
549 (defvar byte-code-vector nil
550 "An array containing byte-code names indexed by byte-code values.")
552 (defvar byte-stack+-info nil
553 "An array with the stack adjustment for each byte-code.")
555 (defmacro byte-defop (opcode stack-adjust opname &optional docstring)
556 ;; This is a speed-hack for building the byte-code-vector at compile-time.
557 ;; We fill in the vector at macroexpand-time, and then after the last call
558 ;; to byte-defop, we write the vector out as a constant instead of writing
559 ;; out a bunch of calls to aset.
560 ;; Actually, we don't fill in the vector itself, because that could make
561 ;; it problematic to compile big changes to this compiler; we store the
562 ;; values on its plist, and remove them later in -extrude.
563 (let ((v1 (or (get 'byte-code-vector 'tmp-compile-time-value)
564 (put 'byte-code-vector 'tmp-compile-time-value
565 (make-vector 256 nil))))
566 (v2 (or (get 'byte-stack+-info 'tmp-compile-time-value)
567 (put 'byte-stack+-info 'tmp-compile-time-value
568 (make-vector 256 nil)))))
569 (aset v1 opcode opname)
570 (aset v2 opcode stack-adjust))
571 (if docstring
572 (list 'defconst opname opcode (concat "Byte code opcode " docstring "."))
573 (list 'defconst opname opcode)))
575 (defmacro byte-extrude-byte-code-vectors ()
576 (prog1 (list 'setq 'byte-code-vector
577 (get 'byte-code-vector 'tmp-compile-time-value)
578 'byte-stack+-info
579 (get 'byte-stack+-info 'tmp-compile-time-value))
580 (put 'byte-code-vector 'tmp-compile-time-value nil)
581 (put 'byte-stack+-info 'tmp-compile-time-value nil)))
584 ;; unused: 0-7
586 ;; These opcodes are special in that they pack their argument into the
587 ;; opcode word.
589 (byte-defop 8 1 byte-varref "for variable reference")
590 (byte-defop 16 -1 byte-varset "for setting a variable")
591 (byte-defop 24 -1 byte-varbind "for binding a variable")
592 (byte-defop 32 0 byte-call "for calling a function")
593 (byte-defop 40 0 byte-unbind "for unbinding special bindings")
594 ;; codes 8-47 are consumed by the preceding opcodes
596 ;; unused: 48-55
598 (byte-defop 56 -1 byte-nth)
599 (byte-defop 57 0 byte-symbolp)
600 (byte-defop 58 0 byte-consp)
601 (byte-defop 59 0 byte-stringp)
602 (byte-defop 60 0 byte-listp)
603 (byte-defop 61 -1 byte-eq)
604 (byte-defop 62 -1 byte-memq)
605 (byte-defop 63 0 byte-not)
606 (byte-defop 64 0 byte-car)
607 (byte-defop 65 0 byte-cdr)
608 (byte-defop 66 -1 byte-cons)
609 (byte-defop 67 0 byte-list1)
610 (byte-defop 68 -1 byte-list2)
611 (byte-defop 69 -2 byte-list3)
612 (byte-defop 70 -3 byte-list4)
613 (byte-defop 71 0 byte-length)
614 (byte-defop 72 -1 byte-aref)
615 (byte-defop 73 -2 byte-aset)
616 (byte-defop 74 0 byte-symbol-value)
617 (byte-defop 75 0 byte-symbol-function) ; this was commented out
618 (byte-defop 76 -1 byte-set)
619 (byte-defop 77 -1 byte-fset) ; this was commented out
620 (byte-defop 78 -1 byte-get)
621 (byte-defop 79 -2 byte-substring)
622 (byte-defop 80 -1 byte-concat2)
623 (byte-defop 81 -2 byte-concat3)
624 (byte-defop 82 -3 byte-concat4)
625 (byte-defop 83 0 byte-sub1)
626 (byte-defop 84 0 byte-add1)
627 (byte-defop 85 -1 byte-eqlsign)
628 (byte-defop 86 -1 byte-gtr)
629 (byte-defop 87 -1 byte-lss)
630 (byte-defop 88 -1 byte-leq)
631 (byte-defop 89 -1 byte-geq)
632 (byte-defop 90 -1 byte-diff)
633 (byte-defop 91 0 byte-negate)
634 (byte-defop 92 -1 byte-plus)
635 (byte-defop 93 -1 byte-max)
636 (byte-defop 94 -1 byte-min)
637 (byte-defop 95 -1 byte-mult) ; v19 only
638 (byte-defop 96 1 byte-point)
639 (byte-defop 98 0 byte-goto-char)
640 (byte-defop 99 0 byte-insert)
641 (byte-defop 100 1 byte-point-max)
642 (byte-defop 101 1 byte-point-min)
643 (byte-defop 102 0 byte-char-after)
644 (byte-defop 103 1 byte-following-char)
645 (byte-defop 104 1 byte-preceding-char)
646 (byte-defop 105 1 byte-current-column)
647 (byte-defop 106 0 byte-indent-to)
648 (byte-defop 107 0 byte-scan-buffer-OBSOLETE) ; no longer generated as of v18
649 (byte-defop 108 1 byte-eolp)
650 (byte-defop 109 1 byte-eobp)
651 (byte-defop 110 1 byte-bolp)
652 (byte-defop 111 1 byte-bobp)
653 (byte-defop 112 1 byte-current-buffer)
654 (byte-defop 113 0 byte-set-buffer)
655 (byte-defop 114 0 byte-save-current-buffer
656 "To make a binding to record the current buffer")
657 (byte-defop 115 0 byte-set-mark-OBSOLETE)
658 (byte-defop 116 1 byte-interactive-p)
660 ;; These ops are new to v19
661 (byte-defop 117 0 byte-forward-char)
662 (byte-defop 118 0 byte-forward-word)
663 (byte-defop 119 -1 byte-skip-chars-forward)
664 (byte-defop 120 -1 byte-skip-chars-backward)
665 (byte-defop 121 0 byte-forward-line)
666 (byte-defop 122 0 byte-char-syntax)
667 (byte-defop 123 -1 byte-buffer-substring)
668 (byte-defop 124 -1 byte-delete-region)
669 (byte-defop 125 -1 byte-narrow-to-region)
670 (byte-defop 126 1 byte-widen)
671 (byte-defop 127 0 byte-end-of-line)
673 ;; unused: 128
675 ;; These store their argument in the next two bytes
676 (byte-defop 129 1 byte-constant2
677 "for reference to a constant with vector index >= byte-constant-limit")
678 (byte-defop 130 0 byte-goto "for unconditional jump")
679 (byte-defop 131 -1 byte-goto-if-nil "to pop value and jump if it's nil")
680 (byte-defop 132 -1 byte-goto-if-not-nil "to pop value and jump if it's not nil")
681 (byte-defop 133 -1 byte-goto-if-nil-else-pop
682 "to examine top-of-stack, jump and don't pop it if it's nil,
683 otherwise pop it")
684 (byte-defop 134 -1 byte-goto-if-not-nil-else-pop
685 "to examine top-of-stack, jump and don't pop it if it's non nil,
686 otherwise pop it")
688 (byte-defop 135 -1 byte-return "to pop a value and return it from `byte-code'")
689 (byte-defop 136 -1 byte-discard "to discard one value from stack")
690 (byte-defop 137 1 byte-dup "to duplicate the top of the stack")
692 (byte-defop 138 0 byte-save-excursion
693 "to make a binding to record the buffer, point and mark")
694 (byte-defop 139 0 byte-save-window-excursion
695 "to make a binding to record entire window configuration")
696 (byte-defop 140 0 byte-save-restriction
697 "to make a binding to record the current buffer clipping restrictions")
698 (byte-defop 141 -1 byte-catch
699 "for catch. Takes, on stack, the tag and an expression for the body")
700 (byte-defop 142 -1 byte-unwind-protect
701 "for unwind-protect. Takes, on stack, an expression for the unwind-action")
703 ;; For condition-case. Takes, on stack, the variable to bind,
704 ;; an expression for the body, and a list of clauses.
705 (byte-defop 143 -2 byte-condition-case)
707 ;; For entry to with-output-to-temp-buffer.
708 ;; Takes, on stack, the buffer name.
709 ;; Binds standard-output and does some other things.
710 ;; Returns with temp buffer on the stack in place of buffer name.
711 (byte-defop 144 0 byte-temp-output-buffer-setup)
713 ;; For exit from with-output-to-temp-buffer.
714 ;; Expects the temp buffer on the stack underneath value to return.
715 ;; Pops them both, then pushes the value back on.
716 ;; Unbinds standard-output and makes the temp buffer visible.
717 (byte-defop 145 -1 byte-temp-output-buffer-show)
719 ;; these ops are new to v19
721 ;; To unbind back to the beginning of this frame.
722 ;; Not used yet, but will be needed for tail-recursion elimination.
723 (byte-defop 146 0 byte-unbind-all)
725 ;; these ops are new to v19
726 (byte-defop 147 -2 byte-set-marker)
727 (byte-defop 148 0 byte-match-beginning)
728 (byte-defop 149 0 byte-match-end)
729 (byte-defop 150 0 byte-upcase)
730 (byte-defop 151 0 byte-downcase)
731 (byte-defop 152 -1 byte-string=)
732 (byte-defop 153 -1 byte-string<)
733 (byte-defop 154 -1 byte-equal)
734 (byte-defop 155 -1 byte-nthcdr)
735 (byte-defop 156 -1 byte-elt)
736 (byte-defop 157 -1 byte-member)
737 (byte-defop 158 -1 byte-assq)
738 (byte-defop 159 0 byte-nreverse)
739 (byte-defop 160 -1 byte-setcar)
740 (byte-defop 161 -1 byte-setcdr)
741 (byte-defop 162 0 byte-car-safe)
742 (byte-defop 163 0 byte-cdr-safe)
743 (byte-defop 164 -1 byte-nconc)
744 (byte-defop 165 -1 byte-quo)
745 (byte-defop 166 -1 byte-rem)
746 (byte-defop 167 0 byte-numberp)
747 (byte-defop 168 0 byte-integerp)
749 ;; unused: 169-174
750 (byte-defop 175 nil byte-listN)
751 (byte-defop 176 nil byte-concatN)
752 (byte-defop 177 nil byte-insertN)
754 ;; unused: 178-191
756 (byte-defop 192 1 byte-constant "for reference to a constant")
757 ;; codes 193-255 are consumed by byte-constant.
758 (defconst byte-constant-limit 64
759 "Exclusive maximum index usable in the `byte-constant' opcode.")
761 (defconst byte-goto-ops '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
762 byte-goto-if-nil-else-pop
763 byte-goto-if-not-nil-else-pop)
764 "List of byte-codes whose offset is a pc.")
766 (defconst byte-goto-always-pop-ops '(byte-goto-if-nil byte-goto-if-not-nil))
768 (byte-extrude-byte-code-vectors)
770 ;;; lapcode generator
772 ;; the byte-compiler now does source -> lapcode -> bytecode instead of
773 ;; source -> bytecode, because it's a lot easier to make optimizations
774 ;; on lapcode than on bytecode.
776 ;; Elements of the lapcode list are of the form (<instruction> . <parameter>)
777 ;; where instruction is a symbol naming a byte-code instruction,
778 ;; and parameter is an argument to that instruction, if any.
780 ;; The instruction can be the pseudo-op TAG, which means that this position
781 ;; in the instruction stream is a target of a goto. (car PARAMETER) will be
782 ;; the PC for this location, and the whole instruction "(TAG pc)" will be the
783 ;; parameter for some goto op.
785 ;; If the operation is varbind, varref, varset or push-constant, then the
786 ;; parameter is (variable/constant . index_in_constant_vector).
788 ;; First, the source code is macroexpanded and optimized in various ways.
789 ;; Then the resultant code is compiled into lapcode. Another set of
790 ;; optimizations are then run over the lapcode. Then the variables and
791 ;; constants referenced by the lapcode are collected and placed in the
792 ;; constants-vector. (This happens now so that variables referenced by dead
793 ;; code don't consume space.) And finally, the lapcode is transformed into
794 ;; compacted byte-code.
796 ;; A distinction is made between variables and constants because the variable-
797 ;; referencing instructions are more sensitive to the variables being near the
798 ;; front of the constants-vector than the constant-referencing instructions.
799 ;; Also, this lets us notice references to free variables.
801 (defun byte-compile-lapcode (lap)
802 "Turns lapcode into bytecode. The lapcode is destroyed."
803 ;; Lapcode modifications: changes the ID of a tag to be the tag's PC.
804 (let ((pc 0) ; Program counter
805 op off ; Operation & offset
806 (bytes '()) ; Put the output bytes here
807 (patchlist nil)) ; List of tags and goto's to patch
808 (while lap
809 (setq op (car (car lap))
810 off (cdr (car lap)))
811 (cond ((not (symbolp op))
812 (error "Non-symbolic opcode `%s'" op))
813 ((eq op 'TAG)
814 (setcar off pc)
815 (setq patchlist (cons off patchlist)))
816 ((memq op byte-goto-ops)
817 (setq pc (+ pc 3))
818 (setq bytes (cons (cons pc (cdr off))
819 (cons nil
820 (cons (symbol-value op) bytes))))
821 (setq patchlist (cons bytes patchlist)))
823 (setq bytes
824 (cond ((cond ((consp off)
825 ;; Variable or constant reference
826 (setq off (cdr off))
827 (eq op 'byte-constant)))
828 (cond ((< off byte-constant-limit)
829 (setq pc (1+ pc))
830 (cons (+ byte-constant off) bytes))
832 (setq pc (+ 3 pc))
833 (cons (lsh off -8)
834 (cons (logand off 255)
835 (cons byte-constant2 bytes))))))
836 ((<= byte-listN (symbol-value op))
837 (setq pc (+ 2 pc))
838 (cons off (cons (symbol-value op) bytes)))
839 ((< off 6)
840 (setq pc (1+ pc))
841 (cons (+ (symbol-value op) off) bytes))
842 ((< off 256)
843 (setq pc (+ 2 pc))
844 (cons off (cons (+ (symbol-value op) 6) bytes)))
846 (setq pc (+ 3 pc))
847 (cons (lsh off -8)
848 (cons (logand off 255)
849 (cons (+ (symbol-value op) 7)
850 bytes))))))))
851 (setq lap (cdr lap)))
852 ;;(if (not (= pc (length bytes)))
853 ;; (error "Compiler error: pc mismatch - %s %s" pc (length bytes)))
854 ;; Patch PC into jumps
855 (let (bytes)
856 (while patchlist
857 (setq bytes (car patchlist))
858 (cond ((atom (car bytes))) ; Tag
859 (t ; Absolute jump
860 (setq pc (car (cdr (car bytes)))) ; Pick PC from tag
861 (setcar (cdr bytes) (logand pc 255))
862 (setcar bytes (lsh pc -8))))
863 (setq patchlist (cdr patchlist))))
864 (apply 'unibyte-string (nreverse bytes))))
867 ;;; compile-time evaluation
869 (defun byte-compile-eval (form)
870 "Eval FORM and mark the functions defined therein.
871 Each function's symbol gets added to `byte-compile-noruntime-functions'."
872 (let ((hist-orig load-history)
873 (hist-nil-orig current-load-list))
874 (prog1 (eval form)
875 (when (byte-compile-warning-enabled-p 'noruntime)
876 (let ((hist-new load-history)
877 (hist-nil-new current-load-list))
878 ;; Go through load-history, look for newly loaded files
879 ;; and mark all the functions defined therein.
880 (while (and hist-new (not (eq hist-new hist-orig)))
881 (let ((xs (pop hist-new))
882 old-autoloads)
883 ;; Make sure the file was not already loaded before.
884 (unless (or (assoc (car xs) hist-orig)
885 (equal (car xs) "cl"))
886 (dolist (s xs)
887 (cond
888 ((symbolp s)
889 (unless (memq s old-autoloads)
890 (push s byte-compile-noruntime-functions)))
891 ((and (consp s) (eq t (car s)))
892 (push (cdr s) old-autoloads))
893 ((and (consp s) (eq 'autoload (car s)))
894 (push (cdr s) byte-compile-noruntime-functions)))))))
895 ;; Go through current-load-list for the locally defined funs.
896 (let (old-autoloads)
897 (while (and hist-nil-new (not (eq hist-nil-new hist-nil-orig)))
898 (let ((s (pop hist-nil-new)))
899 (when (and (symbolp s) (not (memq s old-autoloads)))
900 (push s byte-compile-noruntime-functions))
901 (when (and (consp s) (eq t (car s)))
902 (push (cdr s) old-autoloads)))))))
903 (when (byte-compile-warning-enabled-p 'cl-functions)
904 (let ((hist-new load-history))
905 ;; Go through load-history, look for newly loaded files
906 ;; and mark all the functions defined therein.
907 (while (and hist-new (not (eq hist-new hist-orig)))
908 (let ((xs (pop hist-new)))
909 ;; Make sure the file was not already loaded before.
910 (when (and (equal (car xs) "cl") (not (assoc (car xs) hist-orig)))
911 (byte-compile-find-cl-functions)))))))))
913 (defun byte-compile-eval-before-compile (form)
914 "Evaluate FORM for `eval-and-compile'."
915 (let ((hist-nil-orig current-load-list))
916 (prog1 (eval form)
917 ;; (eval-and-compile (require 'cl) turns off warnings for cl functions.
918 (let ((tem current-load-list))
919 (while (not (eq tem hist-nil-orig))
920 (when (equal (car tem) '(require . cl))
921 (byte-compile-disable-warning 'cl-functions))
922 (setq tem (cdr tem)))))))
924 ;;; byte compiler messages
926 (defvar byte-compile-current-form nil)
927 (defvar byte-compile-dest-file nil)
928 (defvar byte-compile-current-file nil)
929 (defvar byte-compile-current-buffer nil)
931 ;; Log something that isn't a warning.
932 (defmacro byte-compile-log (format-string &rest args)
933 `(and
934 byte-optimize
935 (memq byte-optimize-log '(t source))
936 (let ((print-escape-newlines t)
937 (print-level 4)
938 (print-length 4))
939 (byte-compile-log-1
940 (format
941 ,format-string
942 ,@(mapcar
943 (lambda (x) (if (symbolp x) (list 'prin1-to-string x) x))
944 args))))))
946 ;; Log something that isn't a warning.
947 (defun byte-compile-log-1 (string)
948 (with-current-buffer "*Compile-Log*"
949 (let ((inhibit-read-only t))
950 (goto-char (point-max))
951 (byte-compile-warning-prefix nil nil)
952 (cond (noninteractive
953 (message " %s" string))
955 (insert (format "%s\n" string)))))))
957 (defvar byte-compile-read-position nil
958 "Character position we began the last `read' from.")
959 (defvar byte-compile-last-position nil
960 "Last known character position in the input.")
962 ;; copied from gnus-util.el
963 (defsubst byte-compile-delete-first (elt list)
964 (if (eq (car list) elt)
965 (cdr list)
966 (let ((total list))
967 (while (and (cdr list)
968 (not (eq (cadr list) elt)))
969 (setq list (cdr list)))
970 (when (cdr list)
971 (setcdr list (cddr list)))
972 total)))
974 ;; The purpose of this function is to iterate through the
975 ;; `read-symbol-positions-list'. Each time we process, say, a
976 ;; function definition (`defun') we remove `defun' from
977 ;; `read-symbol-positions-list', and set `byte-compile-last-position'
978 ;; to that symbol's character position. Similarly, if we encounter a
979 ;; variable reference, like in (1+ foo), we remove `foo' from the
980 ;; list. If our current position is after the symbol's position, we
981 ;; assume we've already passed that point, and look for the next
982 ;; occurrence of the symbol.
984 ;; This function should not be called twice for the same occurrence of
985 ;; a symbol, and it should not be called for symbols generated by the
986 ;; byte compiler itself; because rather than just fail looking up the
987 ;; symbol, we may find an occurrence of the symbol further ahead, and
988 ;; then `byte-compile-last-position' as advanced too far.
990 ;; So your're probably asking yourself: Isn't this function a
991 ;; gross hack? And the answer, of course, would be yes.
992 (defun byte-compile-set-symbol-position (sym &optional allow-previous)
993 (when byte-compile-read-position
994 (let (last entry)
995 (while (progn
996 (setq last byte-compile-last-position
997 entry (assq sym read-symbol-positions-list))
998 (when entry
999 (setq byte-compile-last-position
1000 (+ byte-compile-read-position (cdr entry))
1001 read-symbol-positions-list
1002 (byte-compile-delete-first
1003 entry read-symbol-positions-list)))
1004 (or (and allow-previous (not (= last byte-compile-last-position)))
1005 (> last byte-compile-last-position)))))))
1007 (defvar byte-compile-last-warned-form nil)
1008 (defvar byte-compile-last-logged-file nil)
1010 ;; This is used as warning-prefix for the compiler.
1011 ;; It is always called with the warnings buffer current.
1012 (defun byte-compile-warning-prefix (level entry)
1013 (let* ((inhibit-read-only t)
1014 (dir default-directory)
1015 (file (cond ((stringp byte-compile-current-file)
1016 (format "%s:" (file-relative-name byte-compile-current-file dir)))
1017 ((bufferp byte-compile-current-file)
1018 (format "Buffer %s:"
1019 (buffer-name byte-compile-current-file)))
1020 (t "")))
1021 (pos (if (and byte-compile-current-file
1022 (integerp byte-compile-read-position))
1023 (with-current-buffer byte-compile-current-buffer
1024 (format "%d:%d:"
1025 (save-excursion
1026 (goto-char byte-compile-last-position)
1027 (1+ (count-lines (point-min) (point-at-bol))))
1028 (save-excursion
1029 (goto-char byte-compile-last-position)
1030 (1+ (current-column)))))
1031 ""))
1032 (form (if (eq byte-compile-current-form :end) "end of data"
1033 (or byte-compile-current-form "toplevel form"))))
1034 (when (or (and byte-compile-current-file
1035 (not (equal byte-compile-current-file
1036 byte-compile-last-logged-file)))
1037 (and byte-compile-current-form
1038 (not (eq byte-compile-current-form
1039 byte-compile-last-warned-form))))
1040 (insert (format "\nIn %s:\n" form)))
1041 (when level
1042 (insert (format "%s%s" file pos))))
1043 (setq byte-compile-last-logged-file byte-compile-current-file
1044 byte-compile-last-warned-form byte-compile-current-form)
1045 entry)
1047 ;; This no-op function is used as the value of warning-series
1048 ;; to tell inner calls to displaying-byte-compile-warnings
1049 ;; not to bind warning-series.
1050 (defun byte-compile-warning-series (&rest ignore)
1051 nil)
1053 ;; (compile-mode) will cause this to be loaded.
1054 (declare-function compilation-forget-errors "compile" ())
1056 ;; Log the start of a file in *Compile-Log*, and mark it as done.
1057 ;; Return the position of the start of the page in the log buffer.
1058 ;; But do nothing in batch mode.
1059 (defun byte-compile-log-file ()
1060 (and (not (equal byte-compile-current-file byte-compile-last-logged-file))
1061 (not noninteractive)
1062 (with-current-buffer (get-buffer-create "*Compile-Log*")
1063 (goto-char (point-max))
1064 (let* ((inhibit-read-only t)
1065 (dir (and byte-compile-current-file
1066 (file-name-directory byte-compile-current-file)))
1067 (was-same (equal default-directory dir))
1069 (when dir
1070 (unless was-same
1071 (insert (format "Leaving directory `%s'\n" default-directory))))
1072 (unless (bolp)
1073 (insert "\n"))
1074 (setq pt (point-marker))
1075 (if byte-compile-current-file
1076 (insert "\f\nCompiling "
1077 (if (stringp byte-compile-current-file)
1078 (concat "file " byte-compile-current-file)
1079 (concat "buffer " (buffer-name byte-compile-current-file)))
1080 " at " (current-time-string) "\n")
1081 (insert "\f\nCompiling no file at " (current-time-string) "\n"))
1082 (when dir
1083 (setq default-directory dir)
1084 (unless was-same
1085 (insert (format "Entering directory `%s'\n" default-directory))))
1086 (setq byte-compile-last-logged-file byte-compile-current-file
1087 byte-compile-last-warned-form nil)
1088 ;; Do this after setting default-directory.
1089 (unless (derived-mode-p 'compilation-mode) (compilation-mode))
1090 (compilation-forget-errors)
1091 pt))))
1093 ;; Log a message STRING in *Compile-Log*.
1094 ;; Also log the current function and file if not already done.
1095 (defun byte-compile-log-warning (string &optional fill level)
1096 (let ((warning-prefix-function 'byte-compile-warning-prefix)
1097 (warning-type-format "")
1098 (warning-fill-prefix (if fill " "))
1099 (inhibit-read-only t))
1100 (display-warning 'bytecomp string level "*Compile-Log*")))
1102 (defun byte-compile-warn (format &rest args)
1103 "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
1104 (setq format (apply 'format format args))
1105 (if byte-compile-error-on-warn
1106 (error "%s" format) ; byte-compile-file catches and logs it
1107 (byte-compile-log-warning format t :warning)))
1109 (defun byte-compile-warn-obsolete (symbol)
1110 "Warn that SYMBOL (a variable or function) is obsolete."
1111 (when (byte-compile-warning-enabled-p 'obsolete)
1112 (let* ((funcp (get symbol 'byte-obsolete-info))
1113 (obsolete (or funcp (get symbol 'byte-obsolete-variable)))
1114 (instead (car obsolete))
1115 (asof (if funcp (nth 2 obsolete) (cdr obsolete))))
1116 (byte-compile-warn "`%s' is an obsolete %s%s%s" symbol
1117 (if funcp "function" "variable")
1118 (if asof (concat " (as of Emacs " asof ")") "")
1119 (cond ((stringp instead)
1120 (concat "; " instead))
1121 (instead
1122 (format "; use `%s' instead." instead))
1123 (t "."))))))
1125 (defun byte-compile-report-error (error-info)
1126 "Report Lisp error in compilation. ERROR-INFO is the error data."
1127 (setq byte-compiler-error-flag t)
1128 (byte-compile-log-warning
1129 (error-message-string error-info)
1130 nil :error))
1132 ;;; Used by make-obsolete.
1133 (defun byte-compile-obsolete (form)
1134 (byte-compile-set-symbol-position (car form))
1135 (byte-compile-warn-obsolete (car form))
1136 (funcall (or (cadr (get (car form) 'byte-obsolete-info)) ; handler
1137 'byte-compile-normal-call) form))
1139 ;; Compiler options
1141 ;; (defvar byte-compiler-valid-options
1142 ;; '((optimize byte-optimize (t nil source byte) val)
1143 ;; (file-format byte-compile-compatibility (emacs18 emacs19)
1144 ;; (eq val 'emacs18))
1145 ;; ;; (new-bytecodes byte-compile-generate-emacs19-bytecodes (t nil) val)
1146 ;; (delete-errors byte-compile-delete-errors (t nil) val)
1147 ;; (verbose byte-compile-verbose (t nil) val)
1148 ;; (warnings byte-compile-warnings ((callargs redefine free-vars unresolved))
1149 ;; val)))
1151 ;; Inhibit v18/v19 selectors if the version is hardcoded.
1152 ;; #### This should print a warning if the user tries to change something
1153 ;; than can't be changed because the running compiler doesn't support it.
1154 ;; (cond
1155 ;; ((byte-compile-single-version)
1156 ;; (setcar (cdr (cdr (assq 'new-bytecodes byte-compiler-valid-options)))
1157 ;; (list (byte-compile-version-cond
1158 ;; byte-compile-generate-emacs19-bytecodes)))
1159 ;; (setcar (cdr (cdr (assq 'file-format byte-compiler-valid-options)))
1160 ;; (if (byte-compile-version-cond byte-compile-compatibility)
1161 ;; '(emacs18) '(emacs19)))))
1163 ;; (defun byte-compiler-options-handler (&rest args)
1164 ;; (let (key val desc choices)
1165 ;; (while args
1166 ;; (if (or (atom (car args)) (nthcdr 2 (car args)) (null (cdr (car args))))
1167 ;; (error "Malformed byte-compiler option `%s'" (car args)))
1168 ;; (setq key (car (car args))
1169 ;; val (car (cdr (car args)))
1170 ;; desc (assq key byte-compiler-valid-options))
1171 ;; (or desc
1172 ;; (error "Unknown byte-compiler option `%s'" key))
1173 ;; (setq choices (nth 2 desc))
1174 ;; (if (consp (car choices))
1175 ;; (let (this
1176 ;; (handler 'cons)
1177 ;; (ret (and (memq (car val) '(+ -))
1178 ;; (copy-sequence (if (eq t (symbol-value (nth 1 desc)))
1179 ;; choices
1180 ;; (symbol-value (nth 1 desc)))))))
1181 ;; (setq choices (car choices))
1182 ;; (while val
1183 ;; (setq this (car val))
1184 ;; (cond ((memq this choices)
1185 ;; (setq ret (funcall handler this ret)))
1186 ;; ((eq this '+) (setq handler 'cons))
1187 ;; ((eq this '-) (setq handler 'delq))
1188 ;; ((error "`%s' only accepts %s" key choices)))
1189 ;; (setq val (cdr val)))
1190 ;; (set (nth 1 desc) ret))
1191 ;; (or (memq val choices)
1192 ;; (error "`%s' must be one of `%s'" key choices))
1193 ;; (set (nth 1 desc) (eval (nth 3 desc))))
1194 ;; (setq args (cdr args)))
1195 ;; nil))
1197 ;;; sanity-checking arglists
1199 ;; If a function has an entry saying (FUNCTION . t).
1200 ;; that means we know it is defined but we don't know how.
1201 ;; If a function has an entry saying (FUNCTION . nil),
1202 ;; that means treat it as not defined.
1203 (defun byte-compile-fdefinition (name macro-p)
1204 (let* ((list (if macro-p
1205 byte-compile-macro-environment
1206 byte-compile-function-environment))
1207 (env (cdr (assq name list))))
1208 (or env
1209 (let ((fn name))
1210 (while (and (symbolp fn)
1211 (fboundp fn)
1212 (or (symbolp (symbol-function fn))
1213 (consp (symbol-function fn))
1214 (and (not macro-p)
1215 (byte-code-function-p (symbol-function fn)))))
1216 (setq fn (symbol-function fn)))
1217 (if (and (not macro-p) (byte-code-function-p fn))
1219 (and (consp fn)
1220 (if (eq 'macro (car fn))
1221 (cdr fn)
1222 (if macro-p
1224 (if (eq 'autoload (car fn))
1226 fn)))))))))
1228 (defun byte-compile-arglist-signature (arglist)
1229 (let ((args 0)
1230 opts
1231 restp)
1232 (while arglist
1233 (cond ((eq (car arglist) '&optional)
1234 (or opts (setq opts 0)))
1235 ((eq (car arglist) '&rest)
1236 (if (cdr arglist)
1237 (setq restp t
1238 arglist nil)))
1240 (if opts
1241 (setq opts (1+ opts))
1242 (setq args (1+ args)))))
1243 (setq arglist (cdr arglist)))
1244 (cons args (if restp nil (if opts (+ args opts) args)))))
1247 (defun byte-compile-arglist-signatures-congruent-p (old new)
1248 (not (or
1249 (> (car new) (car old)) ; requires more args now
1250 (and (null (cdr old)) ; took rest-args, doesn't any more
1251 (cdr new))
1252 (and (cdr new) (cdr old) ; can't take as many args now
1253 (< (cdr new) (cdr old)))
1256 (defun byte-compile-arglist-signature-string (signature)
1257 (cond ((null (cdr signature))
1258 (format "%d+" (car signature)))
1259 ((= (car signature) (cdr signature))
1260 (format "%d" (car signature)))
1261 (t (format "%d-%d" (car signature) (cdr signature)))))
1264 ;; Warn if the form is calling a function with the wrong number of arguments.
1265 (defun byte-compile-callargs-warn (form)
1266 (let* ((def (or (byte-compile-fdefinition (car form) nil)
1267 (byte-compile-fdefinition (car form) t)))
1268 (sig (if (and def (not (eq def t)))
1269 (byte-compile-arglist-signature
1270 (if (memq (car-safe def) '(declared lambda))
1271 (nth 1 def)
1272 (if (byte-code-function-p def)
1273 (aref def 0)
1274 '(&rest def))))
1275 (if (and (fboundp (car form))
1276 (subrp (symbol-function (car form))))
1277 (subr-arity (symbol-function (car form))))))
1278 (ncall (length (cdr form))))
1279 ;; Check many or unevalled from subr-arity.
1280 (if (and (cdr-safe sig)
1281 (not (numberp (cdr sig))))
1282 (setcdr sig nil))
1283 (if sig
1284 (when (or (< ncall (car sig))
1285 (and (cdr sig) (> ncall (cdr sig))))
1286 (byte-compile-set-symbol-position (car form))
1287 (byte-compile-warn
1288 "%s called with %d argument%s, but %s %s"
1289 (car form) ncall
1290 (if (= 1 ncall) "" "s")
1291 (if (< ncall (car sig))
1292 "requires"
1293 "accepts only")
1294 (byte-compile-arglist-signature-string sig))))
1295 (byte-compile-format-warn form)
1296 ;; Check to see if the function will be available at runtime
1297 ;; and/or remember its arity if it's unknown.
1298 (or (and (or def (fboundp (car form))) ; might be a subr or autoload.
1299 (not (memq (car form) byte-compile-noruntime-functions)))
1300 (eq (car form) byte-compile-current-form) ; ## this doesn't work
1301 ; with recursion.
1302 ;; It's a currently-undefined function.
1303 ;; Remember number of args in call.
1304 (let ((cons (assq (car form) byte-compile-unresolved-functions))
1305 (n (length (cdr form))))
1306 (if cons
1307 (or (memq n (cdr cons))
1308 (setcdr cons (cons n (cdr cons))))
1309 (push (list (car form) n)
1310 byte-compile-unresolved-functions))))))
1312 (defun byte-compile-format-warn (form)
1313 "Warn if FORM is `format'-like with inconsistent args.
1314 Applies if head of FORM is a symbol with non-nil property
1315 `byte-compile-format-like' and first arg is a constant string.
1316 Then check the number of format fields matches the number of
1317 extra args."
1318 (when (and (symbolp (car form))
1319 (stringp (nth 1 form))
1320 (get (car form) 'byte-compile-format-like))
1321 (let ((nfields (with-temp-buffer
1322 (insert (nth 1 form))
1323 (goto-char (point-min))
1324 (let ((n 0))
1325 (while (re-search-forward "%." nil t)
1326 (unless (eq ?% (char-after (1+ (match-beginning 0))))
1327 (setq n (1+ n))))
1328 n)))
1329 (nargs (- (length form) 2)))
1330 (unless (= nargs nfields)
1331 (byte-compile-warn
1332 "`%s' called with %d args to fill %d format field(s)" (car form)
1333 nargs nfields)))))
1335 (dolist (elt '(format message error))
1336 (put elt 'byte-compile-format-like t))
1338 ;; Warn if a custom definition fails to specify :group.
1339 (defun byte-compile-nogroup-warn (form)
1340 (let ((keyword-args (cdr (cdr (cdr (cdr form)))))
1341 (name (cadr form)))
1342 (or (not (eq (car-safe name) 'quote))
1343 (and (eq (car form) 'custom-declare-group)
1344 (equal name ''emacs))
1345 (plist-get keyword-args :group)
1346 (not (and (consp name) (eq (car name) 'quote)))
1347 (byte-compile-warn
1348 "%s for `%s' fails to specify containing group"
1349 (cdr (assq (car form)
1350 '((custom-declare-group . defgroup)
1351 (custom-declare-face . defface)
1352 (custom-declare-variable . defcustom))))
1353 (cadr name)))))
1355 ;; Warn if the function or macro is being redefined with a different
1356 ;; number of arguments.
1357 (defun byte-compile-arglist-warn (form macrop)
1358 (let ((old (byte-compile-fdefinition (nth 1 form) macrop)))
1359 (if (and old (not (eq old t)))
1360 (let ((sig1 (byte-compile-arglist-signature
1361 (if (eq 'lambda (car-safe old))
1362 (nth 1 old)
1363 (if (byte-code-function-p old)
1364 (aref old 0)
1365 '(&rest def)))))
1366 (sig2 (byte-compile-arglist-signature (nth 2 form))))
1367 (unless (byte-compile-arglist-signatures-congruent-p sig1 sig2)
1368 (byte-compile-set-symbol-position (nth 1 form))
1369 (byte-compile-warn
1370 "%s %s used to take %s %s, now takes %s"
1371 (if (eq (car form) 'defun) "function" "macro")
1372 (nth 1 form)
1373 (byte-compile-arglist-signature-string sig1)
1374 (if (equal sig1 '(1 . 1)) "argument" "arguments")
1375 (byte-compile-arglist-signature-string sig2))))
1376 ;; This is the first definition. See if previous calls are compatible.
1377 (let ((calls (assq (nth 1 form) byte-compile-unresolved-functions))
1378 nums sig min max)
1379 (if calls
1380 (progn
1381 (setq sig (byte-compile-arglist-signature (nth 2 form))
1382 nums (sort (copy-sequence (cdr calls)) (function <))
1383 min (car nums)
1384 max (car (nreverse nums)))
1385 (when (or (< min (car sig))
1386 (and (cdr sig) (> max (cdr sig))))
1387 (byte-compile-set-symbol-position (nth 1 form))
1388 (byte-compile-warn
1389 "%s being defined to take %s%s, but was previously called with %s"
1390 (nth 1 form)
1391 (byte-compile-arglist-signature-string sig)
1392 (if (equal sig '(1 . 1)) " arg" " args")
1393 (byte-compile-arglist-signature-string (cons min max))))
1395 (setq byte-compile-unresolved-functions
1396 (delq calls byte-compile-unresolved-functions)))))
1399 (defvar byte-compile-cl-functions nil
1400 "List of functions defined in CL.")
1402 (defun byte-compile-find-cl-functions ()
1403 (unless byte-compile-cl-functions
1404 (dolist (elt load-history)
1405 (when (and (stringp (car elt))
1406 (string-match
1407 "^cl\\>" (file-name-nondirectory (car elt))))
1408 (dolist (e (cdr elt))
1409 (when (memq (car-safe e) '(autoload defun))
1410 (push (cdr e) byte-compile-cl-functions)))))))
1412 (defun byte-compile-cl-warn (form)
1413 "Warn if FORM is a call of a function from the CL package."
1414 (let ((func (car-safe form)))
1415 (if (and byte-compile-cl-functions
1416 (memq func byte-compile-cl-functions)
1417 ;; Aliases which won't have been expanded at this point.
1418 ;; These aren't all aliases of subrs, so not trivial to
1419 ;; avoid hardwiring the list.
1420 (not (memq func
1421 '(cl-block-wrapper cl-block-throw
1422 multiple-value-call nth-value
1423 copy-seq first second rest endp cl-member
1424 ;; These are included in generated code
1425 ;; that can't be called except at compile time
1426 ;; or unless cl is loaded anyway.
1427 cl-defsubst-expand cl-struct-setf-expander
1428 ;; These would sometimes be warned about
1429 ;; but such warnings are never useful,
1430 ;; so don't warn about them.
1431 macroexpand cl-macroexpand-all
1432 cl-compiling-file)))
1433 ;; Avoid warnings for things which are safe because they
1434 ;; have suitable compiler macros, but those aren't
1435 ;; expanded at this stage. There should probably be more
1436 ;; here than caaar and friends.
1437 (not (and (eq (get func 'byte-compile)
1438 'cl-byte-compile-compiler-macro)
1439 (string-match "\\`c[ad]+r\\'" (symbol-name func)))))
1440 (byte-compile-warn "Function `%s' from cl package called at runtime"
1441 func)))
1442 form)
1444 (defun byte-compile-print-syms (str1 strn syms)
1445 (when syms
1446 (byte-compile-set-symbol-position (car syms) t))
1447 (cond ((and (cdr syms) (not noninteractive))
1448 (let* ((str strn)
1449 (L (length str))
1451 (while syms
1452 (setq s (symbol-name (pop syms))
1453 L (+ L (length s) 2))
1454 (if (< L (1- fill-column))
1455 (setq str (concat str " " s (and syms ",")))
1456 (setq str (concat str "\n " s (and syms ","))
1457 L (+ (length s) 4))))
1458 (byte-compile-warn "%s" str)))
1459 ((cdr syms)
1460 (byte-compile-warn "%s %s"
1461 strn
1462 (mapconcat #'symbol-name syms ", ")))
1464 (syms
1465 (byte-compile-warn str1 (car syms)))))
1467 ;; If we have compiled any calls to functions which are not known to be
1468 ;; defined, issue a warning enumerating them.
1469 ;; `unresolved' in the list `byte-compile-warnings' disables this.
1470 (defun byte-compile-warn-about-unresolved-functions ()
1471 (when (byte-compile-warning-enabled-p 'unresolved)
1472 (let ((byte-compile-current-form :end)
1473 (noruntime nil)
1474 (unresolved nil))
1475 ;; Separate the functions that will not be available at runtime
1476 ;; from the truly unresolved ones.
1477 (dolist (f byte-compile-unresolved-functions)
1478 (setq f (car f))
1479 (if (fboundp f) (push f noruntime) (push f unresolved)))
1480 ;; Complain about the no-run-time functions
1481 (byte-compile-print-syms
1482 "the function `%s' might not be defined at runtime."
1483 "the following functions might not be defined at runtime:"
1484 noruntime)
1485 ;; Complain about the unresolved functions
1486 (byte-compile-print-syms
1487 "the function `%s' is not known to be defined."
1488 "the following functions are not known to be defined:"
1489 unresolved)))
1490 nil)
1493 (defsubst byte-compile-const-symbol-p (symbol &optional any-value)
1494 "Non-nil if SYMBOL is constant.
1495 If ANY-VALUE is nil, only return non-nil if the value of the symbol is the
1496 symbol itself."
1497 (or (memq symbol '(nil t))
1498 (keywordp symbol)
1499 (if any-value (memq symbol byte-compile-const-variables))))
1501 (defmacro byte-compile-constp (form)
1502 "Return non-nil if FORM is a constant."
1503 `(cond ((consp ,form) (eq (car ,form) 'quote))
1504 ((not (symbolp ,form)))
1505 ((byte-compile-const-symbol-p ,form))))
1507 (defmacro byte-compile-close-variables (&rest body)
1508 (cons 'let
1509 (cons '(;;
1510 ;; Close over these variables to encapsulate the
1511 ;; compilation state
1513 (byte-compile-macro-environment
1514 ;; Copy it because the compiler may patch into the
1515 ;; macroenvironment.
1516 (copy-alist byte-compile-initial-macro-environment))
1517 (byte-compile-function-environment nil)
1518 (byte-compile-bound-variables nil)
1519 (byte-compile-const-variables nil)
1520 (byte-compile-free-references nil)
1521 (byte-compile-free-assignments nil)
1523 ;; Close over these variables so that `byte-compiler-options'
1524 ;; can change them on a per-file basis.
1526 (byte-compile-verbose byte-compile-verbose)
1527 (byte-optimize byte-optimize)
1528 (byte-compile-compatibility byte-compile-compatibility)
1529 (byte-compile-dynamic byte-compile-dynamic)
1530 (byte-compile-dynamic-docstrings
1531 byte-compile-dynamic-docstrings)
1532 ;; (byte-compile-generate-emacs19-bytecodes
1533 ;; byte-compile-generate-emacs19-bytecodes)
1534 (byte-compile-warnings byte-compile-warnings)
1536 body)))
1538 (defmacro displaying-byte-compile-warnings (&rest body)
1539 `(let* ((--displaying-byte-compile-warnings-fn (lambda () ,@body))
1540 (warning-series-started
1541 (and (markerp warning-series)
1542 (eq (marker-buffer warning-series)
1543 (get-buffer "*Compile-Log*")))))
1544 (byte-compile-find-cl-functions)
1545 (if (or (eq warning-series 'byte-compile-warning-series)
1546 warning-series-started)
1547 ;; warning-series does come from compilation,
1548 ;; so don't bind it, but maybe do set it.
1549 (let (tem)
1550 ;; Log the file name. Record position of that text.
1551 (setq tem (byte-compile-log-file))
1552 (unless warning-series-started
1553 (setq warning-series (or tem 'byte-compile-warning-series)))
1554 (if byte-compile-debug
1555 (funcall --displaying-byte-compile-warnings-fn)
1556 (condition-case error-info
1557 (funcall --displaying-byte-compile-warnings-fn)
1558 (error (byte-compile-report-error error-info)))))
1559 ;; warning-series does not come from compilation, so bind it.
1560 (let ((warning-series
1561 ;; Log the file name. Record position of that text.
1562 (or (byte-compile-log-file) 'byte-compile-warning-series)))
1563 (if byte-compile-debug
1564 (funcall --displaying-byte-compile-warnings-fn)
1565 (condition-case error-info
1566 (funcall --displaying-byte-compile-warnings-fn)
1567 (error (byte-compile-report-error error-info))))))))
1569 ;;;###autoload
1570 (defun byte-force-recompile (directory)
1571 "Recompile every `.el' file in DIRECTORY that already has a `.elc' file.
1572 Files in subdirectories of DIRECTORY are processed also."
1573 (interactive "DByte force recompile (directory): ")
1574 (byte-recompile-directory directory nil t))
1576 ;; The `bytecomp-' prefix is applied to all local variables with
1577 ;; otherwise common names in this and similar functions for the sake
1578 ;; of the boundp test in byte-compile-variable-ref.
1579 ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg00237.html
1580 ;; http://lists.gnu.org/archive/html/bug-gnu-emacs/2008-02/msg00134.html
1581 ;;;###autoload
1582 (defun byte-recompile-directory (bytecomp-directory &optional bytecomp-arg
1583 bytecomp-force)
1584 "Recompile every `.el' file in BYTECOMP-DIRECTORY that needs recompilation.
1585 This is if a `.elc' file exists but is older than the `.el' file.
1586 Files in subdirectories of BYTECOMP-DIRECTORY are processed also.
1588 If the `.elc' file does not exist, normally this function *does not*
1589 compile the corresponding `.el' file. However, if the prefix argument
1590 BYTECOMP-ARG is 0, that means do compile all those files. A nonzero
1591 BYTECOMP-ARG means ask the user, for each such `.el' file, whether to
1592 compile it. A nonzero BYTECOMP-ARG also means ask about each subdirectory
1593 before scanning it.
1595 If the third argument BYTECOMP-FORCE is non-nil, recompile every `.el' file
1596 that already has a `.elc' file."
1597 (interactive "DByte recompile directory: \nP")
1598 (if bytecomp-arg
1599 (setq bytecomp-arg (prefix-numeric-value bytecomp-arg)))
1600 (if noninteractive
1602 (save-some-buffers)
1603 (force-mode-line-update))
1604 (with-current-buffer (get-buffer-create "*Compile-Log*")
1605 (setq default-directory (expand-file-name bytecomp-directory))
1606 ;; compilation-mode copies value of default-directory.
1607 (unless (eq major-mode 'compilation-mode)
1608 (compilation-mode))
1609 (let ((bytecomp-directories (list default-directory))
1610 (default-directory default-directory)
1611 (skip-count 0)
1612 (fail-count 0)
1613 (file-count 0)
1614 (dir-count 0)
1615 last-dir)
1616 (displaying-byte-compile-warnings
1617 (while bytecomp-directories
1618 (setq bytecomp-directory (car bytecomp-directories))
1619 (message "Checking %s..." bytecomp-directory)
1620 (let ((bytecomp-files (directory-files bytecomp-directory))
1621 bytecomp-source bytecomp-dest)
1622 (dolist (bytecomp-file bytecomp-files)
1623 (setq bytecomp-source
1624 (expand-file-name bytecomp-file bytecomp-directory))
1625 (if (and (not (member bytecomp-file '("RCS" "CVS")))
1626 (not (eq ?\. (aref bytecomp-file 0)))
1627 (file-directory-p bytecomp-source)
1628 (not (file-symlink-p bytecomp-source)))
1629 ;; This file is a subdirectory. Handle them differently.
1630 (when (or (null bytecomp-arg)
1631 (eq 0 bytecomp-arg)
1632 (y-or-n-p (concat "Check " bytecomp-source "? ")))
1633 (setq bytecomp-directories
1634 (nconc bytecomp-directories (list bytecomp-source))))
1635 ;; It is an ordinary file. Decide whether to compile it.
1636 (if (and (string-match emacs-lisp-file-regexp bytecomp-source)
1637 (file-readable-p bytecomp-source)
1638 (not (auto-save-file-name-p bytecomp-source))
1639 (setq bytecomp-dest
1640 (byte-compile-dest-file bytecomp-source))
1641 (if (file-exists-p bytecomp-dest)
1642 ;; File was already compiled.
1643 (or bytecomp-force
1644 (file-newer-than-file-p bytecomp-source
1645 bytecomp-dest))
1646 ;; No compiled file exists yet.
1647 (and bytecomp-arg
1648 (or (eq 0 bytecomp-arg)
1649 (y-or-n-p (concat "Compile "
1650 bytecomp-source "? "))))))
1651 (progn (if (and noninteractive (not byte-compile-verbose))
1652 (message "Compiling %s..." bytecomp-source))
1653 (let ((bytecomp-res (byte-compile-file
1654 bytecomp-source)))
1655 (cond ((eq bytecomp-res 'no-byte-compile)
1656 (setq skip-count (1+ skip-count)))
1657 ((eq bytecomp-res t)
1658 (setq file-count (1+ file-count)))
1659 ((eq bytecomp-res nil)
1660 (setq fail-count (1+ fail-count)))))
1661 (or noninteractive
1662 (message "Checking %s..." bytecomp-directory))
1663 (if (not (eq last-dir bytecomp-directory))
1664 (setq last-dir bytecomp-directory
1665 dir-count (1+ dir-count)))
1666 )))))
1667 (setq bytecomp-directories (cdr bytecomp-directories))))
1668 (message "Done (Total of %d file%s compiled%s%s%s)"
1669 file-count (if (= file-count 1) "" "s")
1670 (if (> fail-count 0) (format ", %d failed" fail-count) "")
1671 (if (> skip-count 0) (format ", %d skipped" skip-count) "")
1672 (if (> dir-count 1)
1673 (format " in %d directories" dir-count) "")))))
1675 (defvar no-byte-compile nil
1676 "Non-nil to prevent byte-compiling of emacs-lisp code.
1677 This is normally set in local file variables at the end of the elisp file:
1679 ;; Local Variables:\n;; no-byte-compile: t\n;; End: ")
1680 ;;;###autoload(put 'no-byte-compile 'safe-local-variable 'booleanp)
1682 ;;;###autoload
1683 (defun byte-compile-file (bytecomp-filename &optional load)
1684 "Compile a file of Lisp code named BYTECOMP-FILENAME into a file of byte code.
1685 The output file's name is generated by passing BYTECOMP-FILENAME to the
1686 `byte-compile-dest-file' function (which see).
1687 With prefix arg (noninteractively: 2nd arg), LOAD the file after compiling.
1688 The value is non-nil if there were no errors, nil if errors."
1689 ;; (interactive "fByte compile file: \nP")
1690 (interactive
1691 (let ((bytecomp-file buffer-file-name)
1692 (bytecomp-file-name nil)
1693 (bytecomp-file-dir nil))
1694 (and bytecomp-file
1695 (eq (cdr (assq 'major-mode (buffer-local-variables)))
1696 'emacs-lisp-mode)
1697 (setq bytecomp-file-name (file-name-nondirectory bytecomp-file)
1698 bytecomp-file-dir (file-name-directory bytecomp-file)))
1699 (list (read-file-name (if current-prefix-arg
1700 "Byte compile and load file: "
1701 "Byte compile file: ")
1702 bytecomp-file-dir bytecomp-file-name nil)
1703 current-prefix-arg)))
1704 ;; Expand now so we get the current buffer's defaults
1705 (setq bytecomp-filename (expand-file-name bytecomp-filename))
1707 ;; If we're compiling a file that's in a buffer and is modified, offer
1708 ;; to save it first.
1709 (or noninteractive
1710 (let ((b (get-file-buffer (expand-file-name bytecomp-filename))))
1711 (if (and b (buffer-modified-p b)
1712 (y-or-n-p (format "Save buffer %s first? " (buffer-name b))))
1713 (with-current-buffer b (save-buffer)))))
1715 ;; Force logging of the file name for each file compiled.
1716 (setq byte-compile-last-logged-file nil)
1717 (let ((byte-compile-current-file bytecomp-filename)
1718 (set-auto-coding-for-load t)
1719 target-file input-buffer output-buffer
1720 byte-compile-dest-file)
1721 (setq target-file (byte-compile-dest-file bytecomp-filename))
1722 (setq byte-compile-dest-file target-file)
1723 (with-current-buffer
1724 (setq input-buffer (get-buffer-create " *Compiler Input*"))
1725 (erase-buffer)
1726 (setq buffer-file-coding-system nil)
1727 ;; Always compile an Emacs Lisp file as multibyte
1728 ;; unless the file itself forces unibyte with -*-coding: raw-text;-*-
1729 (set-buffer-multibyte t)
1730 (insert-file-contents bytecomp-filename)
1731 ;; Mimic the way after-insert-file-set-coding can make the
1732 ;; buffer unibyte when visiting this file.
1733 (when (or (eq last-coding-system-used 'no-conversion)
1734 (eq (coding-system-type last-coding-system-used) 5))
1735 ;; For coding systems no-conversion and raw-text...,
1736 ;; edit the buffer as unibyte.
1737 (set-buffer-multibyte nil))
1738 ;; Run hooks including the uncompression hook.
1739 ;; If they change the file name, then change it for the output also.
1740 (let ((buffer-file-name bytecomp-filename)
1741 (default-major-mode 'emacs-lisp-mode)
1742 ;; Ignore unsafe local variables.
1743 ;; We only care about a few of them for our purposes.
1744 (enable-local-variables :safe)
1745 (enable-local-eval nil))
1746 ;; Arg of t means don't alter enable-local-variables.
1747 (normal-mode t)
1748 (setq bytecomp-filename buffer-file-name))
1749 ;; Set the default directory, in case an eval-when-compile uses it.
1750 (setq default-directory (file-name-directory bytecomp-filename)))
1751 ;; Check if the file's local variables explicitly specify not to
1752 ;; compile this file.
1753 (if (with-current-buffer input-buffer no-byte-compile)
1754 (progn
1755 ;; (message "%s not compiled because of `no-byte-compile: %s'"
1756 ;; (file-relative-name bytecomp-filename)
1757 ;; (with-current-buffer input-buffer no-byte-compile))
1758 (when (file-exists-p target-file)
1759 (message "%s deleted because of `no-byte-compile: %s'"
1760 (file-relative-name target-file)
1761 (buffer-local-value 'no-byte-compile input-buffer))
1762 (condition-case nil (delete-file target-file) (error nil)))
1763 ;; We successfully didn't compile this file.
1764 'no-byte-compile)
1765 (when byte-compile-verbose
1766 (message "Compiling %s..." bytecomp-filename))
1767 (setq byte-compiler-error-flag nil)
1768 ;; It is important that input-buffer not be current at this call,
1769 ;; so that the value of point set in input-buffer
1770 ;; within byte-compile-from-buffer lingers in that buffer.
1771 (setq output-buffer
1772 (save-current-buffer
1773 (byte-compile-from-buffer input-buffer bytecomp-filename)))
1774 (if byte-compiler-error-flag
1776 (when byte-compile-verbose
1777 (message "Compiling %s...done" bytecomp-filename))
1778 (kill-buffer input-buffer)
1779 (with-current-buffer output-buffer
1780 (goto-char (point-max))
1781 (insert "\n") ; aaah, unix.
1782 (let ((vms-stmlf-recfm t))
1783 (if (file-writable-p target-file)
1784 ;; We must disable any code conversion here.
1785 (let ((coding-system-for-write 'no-conversion))
1786 (if (memq system-type '(ms-dos 'windows-nt))
1787 (setq buffer-file-type t))
1788 (when (file-exists-p target-file)
1789 ;; Remove the target before writing it, so that any
1790 ;; hard-links continue to point to the old file (this makes
1791 ;; it possible for installed files to share disk space with
1792 ;; the build tree, without causing problems when emacs-lisp
1793 ;; files in the build tree are recompiled).
1794 (delete-file target-file))
1795 (write-region (point-min) (point-max) target-file))
1796 ;; This is just to give a better error message than write-region
1797 (signal 'file-error
1798 (list "Opening output file"
1799 (if (file-exists-p target-file)
1800 "cannot overwrite file"
1801 "directory not writable or nonexistent")
1802 target-file))))
1803 (kill-buffer (current-buffer)))
1804 (if (and byte-compile-generate-call-tree
1805 (or (eq t byte-compile-generate-call-tree)
1806 (y-or-n-p (format "Report call tree for %s? "
1807 bytecomp-filename))))
1808 (save-excursion
1809 (display-call-tree bytecomp-filename)))
1810 (if load
1811 (load target-file))
1812 t))))
1814 ;;(defun byte-compile-and-load-file (&optional filename)
1815 ;; "Compile a file of Lisp code named FILENAME into a file of byte code,
1816 ;;and then load it. The output file's name is made by appending \"c\" to
1817 ;;the end of FILENAME."
1818 ;; (interactive)
1819 ;; (if filename ; I don't get it, (interactive-p) doesn't always work
1820 ;; (byte-compile-file filename t)
1821 ;; (let ((current-prefix-arg '(4)))
1822 ;; (call-interactively 'byte-compile-file))))
1824 ;;(defun byte-compile-buffer (&optional buffer)
1825 ;; "Byte-compile and evaluate contents of BUFFER (default: the current buffer)."
1826 ;; (interactive "bByte compile buffer: ")
1827 ;; (setq buffer (if buffer (get-buffer buffer) (current-buffer)))
1828 ;; (message "Compiling %s..." (buffer-name buffer))
1829 ;; (let* ((filename (or (buffer-file-name buffer)
1830 ;; (concat "#<buffer " (buffer-name buffer) ">")))
1831 ;; (byte-compile-current-file buffer))
1832 ;; (byte-compile-from-buffer buffer nil))
1833 ;; (message "Compiling %s...done" (buffer-name buffer))
1834 ;; t)
1836 ;;; compiling a single function
1837 ;;;###autoload
1838 (defun compile-defun (&optional arg)
1839 "Compile and evaluate the current top-level form.
1840 Print the result in the echo area.
1841 With argument, insert value in current buffer after the form."
1842 (interactive "P")
1843 (save-excursion
1844 (end-of-defun)
1845 (beginning-of-defun)
1846 (let* ((byte-compile-current-file nil)
1847 (byte-compile-current-buffer (current-buffer))
1848 (byte-compile-read-position (point))
1849 (byte-compile-last-position byte-compile-read-position)
1850 (byte-compile-last-warned-form 'nothing)
1851 (value (eval
1852 (let ((read-with-symbol-positions (current-buffer))
1853 (read-symbol-positions-list nil))
1854 (displaying-byte-compile-warnings
1855 (byte-compile-sexp (read (current-buffer))))))))
1856 (cond (arg
1857 (message "Compiling from buffer... done.")
1858 (prin1 value (current-buffer))
1859 (insert "\n"))
1860 ((message "%s" (prin1-to-string value)))))))
1863 (defun byte-compile-from-buffer (inbuffer &optional filename)
1864 ;; Filename is used for the loading-into-Emacs-18 error message.
1865 (let (outbuffer
1866 (byte-compile-current-buffer inbuffer)
1867 (byte-compile-read-position nil)
1868 (byte-compile-last-position nil)
1869 ;; Prevent truncation of flonums and lists as we read and print them
1870 (float-output-format nil)
1871 (case-fold-search nil)
1872 (print-length nil)
1873 (print-level nil)
1874 ;; Prevent edebug from interfering when we compile
1875 ;; and put the output into a file.
1876 ;; (edebug-all-defs nil)
1877 ;; (edebug-all-forms nil)
1878 ;; Simulate entry to byte-compile-top-level
1879 (byte-compile-constants nil)
1880 (byte-compile-variables nil)
1881 (byte-compile-tag-number 0)
1882 (byte-compile-depth 0)
1883 (byte-compile-maxdepth 0)
1884 (byte-compile-output nil)
1885 ;; This allows us to get the positions of symbols read; it's
1886 ;; new in Emacs 22.1.
1887 (read-with-symbol-positions inbuffer)
1888 (read-symbol-positions-list nil)
1889 ;; #### This is bound in b-c-close-variables.
1890 ;; (byte-compile-warnings byte-compile-warnings)
1892 (byte-compile-close-variables
1893 (with-current-buffer
1894 (setq outbuffer (get-buffer-create " *Compiler Output*"))
1895 (set-buffer-multibyte t)
1896 (erase-buffer)
1897 ;; (emacs-lisp-mode)
1898 (setq case-fold-search nil)
1899 ;; This is a kludge. Some operating systems (OS/2, DOS) need to
1900 ;; write files containing binary information specially.
1901 ;; Under most circumstances, such files will be in binary
1902 ;; overwrite mode, so those OS's use that flag to guess how
1903 ;; they should write their data. Advise them that .elc files
1904 ;; need to be written carefully.
1905 (setq overwrite-mode 'overwrite-mode-binary))
1906 (displaying-byte-compile-warnings
1907 (and filename (byte-compile-insert-header filename inbuffer outbuffer))
1908 (with-current-buffer inbuffer
1909 (goto-char (point-min))
1910 ;; Should we always do this? When calling multiple files, it
1911 ;; would be useful to delay this warning until all have been
1912 ;; compiled. A: Yes! b-c-u-f might contain dross from a
1913 ;; previous byte-compile.
1914 (setq byte-compile-unresolved-functions nil)
1916 ;; Compile the forms from the input buffer.
1917 (while (progn
1918 (while (progn (skip-chars-forward " \t\n\^l")
1919 (looking-at ";"))
1920 (forward-line 1))
1921 (not (eobp)))
1922 (setq byte-compile-read-position (point)
1923 byte-compile-last-position byte-compile-read-position)
1924 (let* ((old-style-backquotes nil)
1925 (form (read inbuffer)))
1926 ;; Warn about the use of old-style backquotes.
1927 (when old-style-backquotes
1928 (byte-compile-warn "!! The file uses old-style backquotes !!
1929 This functionality has been obsolete for more than 10 years already
1930 and will be removed soon. See (elisp)Backquote in the manual."))
1931 (byte-compile-file-form form)))
1932 ;; Compile pending forms at end of file.
1933 (byte-compile-flush-pending)
1934 ;; Make warnings about unresolved functions
1935 ;; give the end of the file as their position.
1936 (setq byte-compile-last-position (point-max))
1937 (byte-compile-warn-about-unresolved-functions))
1938 ;; Fix up the header at the front of the output
1939 ;; if the buffer contains multibyte characters.
1940 (and filename (byte-compile-fix-header filename inbuffer outbuffer))))
1941 outbuffer))
1943 (defun byte-compile-fix-header (filename inbuffer outbuffer)
1944 (with-current-buffer outbuffer
1945 ;; See if the buffer has any multibyte characters.
1946 (when (< (point-max) (position-bytes (point-max)))
1947 (when (byte-compile-version-cond byte-compile-compatibility)
1948 (error "Version-18 compatibility not valid with multibyte characters"))
1949 (goto-char (point-min))
1950 ;; Find the comment that describes the version test.
1951 (search-forward "\n;;; This file")
1952 (beginning-of-line)
1953 (narrow-to-region (point) (point-max))
1954 ;; Find the line of ballast semicolons.
1955 (search-forward ";;;;;;;;;;")
1956 (beginning-of-line)
1958 (narrow-to-region (point-min) (point))
1959 (let ((old-header-end (point))
1960 delta)
1961 (goto-char (point-min))
1962 (delete-region (point) (progn (re-search-forward "^(")
1963 (beginning-of-line)
1964 (point)))
1965 (insert ";;; This file contains utf-8 non-ASCII characters\n"
1966 ";;; and therefore cannot be loaded into Emacs 21 or earlier.\n")
1967 ;; Replace "19" or "19.29" with "22", twice.
1968 (re-search-forward "19\\(\\.[0-9]+\\)")
1969 (replace-match "23")
1970 (re-search-forward "19\\(\\.[0-9]+\\)")
1971 (replace-match "23")
1972 ;; Now compensate for the change in size,
1973 ;; to make sure all positions in the file remain valid.
1974 (setq delta (- (point-max) old-header-end))
1975 (goto-char (point-max))
1976 (widen)
1977 (delete-char delta)))))
1979 (defun byte-compile-insert-header (filename inbuffer outbuffer)
1980 (with-current-buffer inbuffer
1981 (let ((dynamic-docstrings byte-compile-dynamic-docstrings)
1982 (dynamic byte-compile-dynamic))
1983 (set-buffer outbuffer)
1984 (goto-char (point-min))
1985 ;; The magic number of .elc files is ";ELC", or 0x3B454C43. After
1986 ;; that is the file-format version number (18, 19, 20, or 23) as a
1987 ;; byte, followed by some nulls. The primary motivation for doing
1988 ;; this is to get some binary characters up in the first line of
1989 ;; the file so that `diff' will simply say "Binary files differ"
1990 ;; instead of actually doing a diff of two .elc files. An extra
1991 ;; benefit is that you can add this to /etc/magic:
1993 ;; 0 string ;ELC GNU Emacs Lisp compiled file,
1994 ;; >4 byte x version %d
1996 (insert
1997 ";ELC"
1998 (if (byte-compile-version-cond byte-compile-compatibility) 18 23)
1999 "\000\000\000\n"
2001 (insert ";;; Compiled by "
2002 (or (and (boundp 'user-mail-address) user-mail-address)
2003 (concat (user-login-name) "@" (system-name)))
2004 " on "
2005 (current-time-string) "\n;;; from file " filename "\n")
2006 (insert ";;; in Emacs version " emacs-version "\n")
2007 (insert ";;; "
2008 (cond
2009 ((eq byte-optimize 'source) "with source-level optimization only")
2010 ((eq byte-optimize 'byte) "with byte-level optimization only")
2011 (byte-optimize "with all optimizations")
2012 (t "without optimization"))
2013 (if (byte-compile-version-cond byte-compile-compatibility)
2014 "; compiled with Emacs 18 compatibility.\n"
2015 ".\n"))
2016 (if dynamic
2017 (insert ";;; Function definitions are lazy-loaded.\n"))
2018 (if (not (byte-compile-version-cond byte-compile-compatibility))
2019 (let (intro-string minimum-version)
2020 ;; Figure out which Emacs version to require,
2021 ;; and what comment to use to explain why.
2022 ;; Note that this fails to take account of whether
2023 ;; the buffer contains multibyte characters. We may have to
2024 ;; compensate at the end in byte-compile-fix-header.
2025 (if dynamic-docstrings
2026 (setq intro-string
2027 ";;; This file uses dynamic docstrings, first added in Emacs 19.29.\n"
2028 minimum-version "19.29")
2029 (setq intro-string
2030 ";;; This file uses opcodes which do not exist in Emacs 18.\n"
2031 minimum-version "19"))
2032 ;; Now insert the comment and the error check.
2033 (insert
2034 "\n"
2035 intro-string
2036 ;; Have to check if emacs-version is bound so that this works
2037 ;; in files loaded early in loadup.el.
2038 "(if (and (boundp 'emacs-version)\n"
2039 ;; If there is a name at the end of emacs-version,
2040 ;; don't try to check the version number.
2041 "\t (< (aref emacs-version (1- (length emacs-version))) ?A)\n"
2042 "\t (or (and (boundp 'epoch::version) epoch::version)\n"
2043 (format "\t (string-lessp emacs-version \"%s\")))\n"
2044 minimum-version)
2045 " (error \"`"
2046 ;; prin1-to-string is used to quote backslashes.
2047 (substring (prin1-to-string (file-name-nondirectory filename))
2048 1 -1)
2049 (format "' was compiled for Emacs %s or later\"))\n\n"
2050 minimum-version)
2051 ;; Insert semicolons as ballast, so that byte-compile-fix-header
2052 ;; can delete them so as to keep the buffer positions
2053 ;; constant for the actual compiled code.
2054 ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n\n"))
2055 ;; Here if we want Emacs 18 compatibility.
2056 (when dynamic-docstrings
2057 (error "Version-18 compatibility doesn't support dynamic doc strings"))
2058 (when byte-compile-dynamic
2059 (error "Version-18 compatibility doesn't support dynamic byte code"))
2060 (insert "(or (boundp 'current-load-list) (setq current-load-list nil))\n"
2061 "\n")))))
2063 (defun byte-compile-output-file-form (form)
2064 ;; writes the given form to the output buffer, being careful of docstrings
2065 ;; in defun, defmacro, defvar, defconst, autoload and
2066 ;; custom-declare-variable because make-docfile is so amazingly stupid.
2067 ;; defalias calls are output directly by byte-compile-file-form-defmumble;
2068 ;; it does not pay to first build the defalias in defmumble and then parse
2069 ;; it here.
2070 (if (and (memq (car-safe form) '(defun defmacro defvar defconst autoload
2071 custom-declare-variable))
2072 (stringp (nth 3 form)))
2073 (byte-compile-output-docform nil nil '("\n(" 3 ")") form nil
2074 (memq (car form)
2075 '(autoload custom-declare-variable)))
2076 (let ((print-escape-newlines t)
2077 (print-length nil)
2078 (print-level nil)
2079 (print-quoted t)
2080 (print-gensym t)
2081 (print-circle ; handle circular data structures
2082 (not byte-compile-disable-print-circle)))
2083 (princ "\n" outbuffer)
2084 (prin1 form outbuffer)
2085 nil)))
2087 (defvar print-gensym-alist) ;Used before print-circle existed.
2089 (defun byte-compile-output-docform (preface name info form specindex quoted)
2090 "Print a form with a doc string. INFO is (prefix doc-index postfix).
2091 If PREFACE and NAME are non-nil, print them too,
2092 before INFO and the FORM but after the doc string itself.
2093 If SPECINDEX is non-nil, it is the index in FORM
2094 of the function bytecode string. In that case,
2095 we output that argument and the following argument (the constants vector)
2096 together, for lazy loading.
2097 QUOTED says that we have to put a quote before the
2098 list that represents a doc string reference.
2099 `autoload' and `custom-declare-variable' need that."
2100 ;; We need to examine byte-compile-dynamic-docstrings
2101 ;; in the input buffer (now current), not in the output buffer.
2102 (let ((dynamic-docstrings byte-compile-dynamic-docstrings))
2103 (with-current-buffer outbuffer
2104 (let (position)
2106 ;; Insert the doc string, and make it a comment with #@LENGTH.
2107 (and (>= (nth 1 info) 0)
2108 dynamic-docstrings
2109 (not byte-compile-compatibility)
2110 (progn
2111 ;; Make the doc string start at beginning of line
2112 ;; for make-docfile's sake.
2113 (insert "\n")
2114 (setq position
2115 (byte-compile-output-as-comment
2116 (nth (nth 1 info) form) nil))
2117 (setq position (- (position-bytes position) (point-min) -1))
2118 ;; If the doc string starts with * (a user variable),
2119 ;; negate POSITION.
2120 (if (and (stringp (nth (nth 1 info) form))
2121 (> (length (nth (nth 1 info) form)) 0)
2122 (eq (aref (nth (nth 1 info) form) 0) ?*))
2123 (setq position (- position)))))
2125 (if preface
2126 (progn
2127 (insert preface)
2128 (prin1 name outbuffer)))
2129 (insert (car info))
2130 (let ((print-escape-newlines t)
2131 (print-quoted t)
2132 ;; For compatibility with code before print-circle,
2133 ;; use a cons cell to say that we want
2134 ;; print-gensym-alist not to be cleared
2135 ;; between calls to print functions.
2136 (print-gensym '(t))
2137 (print-circle ; handle circular data structures
2138 (not byte-compile-disable-print-circle))
2139 print-gensym-alist ; was used before print-circle existed.
2140 (print-continuous-numbering t)
2141 print-number-table
2142 (index 0))
2143 (prin1 (car form) outbuffer)
2144 (while (setq form (cdr form))
2145 (setq index (1+ index))
2146 (insert " ")
2147 (cond ((and (numberp specindex) (= index specindex)
2148 ;; Don't handle the definition dynamically
2149 ;; if it refers (or might refer)
2150 ;; to objects already output
2151 ;; (for instance, gensyms in the arg list).
2152 (let (non-nil)
2153 (dotimes (i (length print-number-table))
2154 (if (aref print-number-table i)
2155 (setq non-nil t)))
2156 (not non-nil)))
2157 ;; Output the byte code and constants specially
2158 ;; for lazy dynamic loading.
2159 (let ((position
2160 (byte-compile-output-as-comment
2161 (cons (car form) (nth 1 form))
2162 t)))
2163 (setq position (- (position-bytes position) (point-min) -1))
2164 (princ (format "(#$ . %d) nil" position) outbuffer)
2165 (setq form (cdr form))
2166 (setq index (1+ index))))
2167 ((= index (nth 1 info))
2168 (if position
2169 (princ (format (if quoted "'(#$ . %d)" "(#$ . %d)")
2170 position)
2171 outbuffer)
2172 (let ((print-escape-newlines nil))
2173 (goto-char (prog1 (1+ (point))
2174 (prin1 (car form) outbuffer)))
2175 (insert "\\\n")
2176 (goto-char (point-max)))))
2178 (prin1 (car form) outbuffer)))))
2179 (insert (nth 2 info)))))
2180 nil)
2182 (defun byte-compile-keep-pending (form &optional handler)
2183 (if (memq byte-optimize '(t source))
2184 (setq form (byte-optimize-form form t)))
2185 (if handler
2186 (let ((for-effect t))
2187 ;; To avoid consing up monstrously large forms at load time, we split
2188 ;; the output regularly.
2189 (and (memq (car-safe form) '(fset defalias))
2190 (nthcdr 300 byte-compile-output)
2191 (byte-compile-flush-pending))
2192 (funcall handler form)
2193 (if for-effect
2194 (byte-compile-discard)))
2195 (byte-compile-form form t))
2196 nil)
2198 (defun byte-compile-flush-pending ()
2199 (if byte-compile-output
2200 (let ((form (byte-compile-out-toplevel t 'file)))
2201 (cond ((eq (car-safe form) 'progn)
2202 (mapc 'byte-compile-output-file-form (cdr form)))
2203 (form
2204 (byte-compile-output-file-form form)))
2205 (setq byte-compile-constants nil
2206 byte-compile-variables nil
2207 byte-compile-depth 0
2208 byte-compile-maxdepth 0
2209 byte-compile-output nil))))
2211 (defun byte-compile-file-form (form)
2212 (let ((byte-compile-current-form nil) ; close over this for warnings.
2213 handler)
2214 (cond
2215 ((not (consp form))
2216 (byte-compile-keep-pending form))
2217 ((and (symbolp (car form))
2218 (setq handler (get (car form) 'byte-hunk-handler)))
2219 (cond ((setq form (funcall handler form))
2220 (byte-compile-flush-pending)
2221 (byte-compile-output-file-form form))))
2222 ((eq form (setq form (macroexpand form byte-compile-macro-environment)))
2223 (byte-compile-keep-pending form))
2225 (byte-compile-file-form form)))))
2227 ;; Functions and variables with doc strings must be output separately,
2228 ;; so make-docfile can recognise them. Most other things can be output
2229 ;; as byte-code.
2231 (put 'defsubst 'byte-hunk-handler 'byte-compile-file-form-defsubst)
2232 (defun byte-compile-file-form-defsubst (form)
2233 (when (assq (nth 1 form) byte-compile-unresolved-functions)
2234 (setq byte-compile-current-form (nth 1 form))
2235 (byte-compile-warn "defsubst `%s' was used before it was defined"
2236 (nth 1 form)))
2237 (byte-compile-file-form
2238 (macroexpand form byte-compile-macro-environment))
2239 ;; Return nil so the form is not output twice.
2240 nil)
2242 (put 'autoload 'byte-hunk-handler 'byte-compile-file-form-autoload)
2243 (defun byte-compile-file-form-autoload (form)
2244 (and (let ((form form))
2245 (while (if (setq form (cdr form)) (byte-compile-constp (car form))))
2246 (null form)) ;Constants only
2247 (eval (nth 5 form)) ;Macro
2248 (eval form)) ;Define the autoload.
2249 ;; Avoid undefined function warnings for the autoload.
2250 (if (and (consp (nth 1 form))
2251 (eq (car (nth 1 form)) 'quote)
2252 (consp (cdr (nth 1 form)))
2253 (symbolp (nth 1 (nth 1 form))))
2254 (push (cons (nth 1 (nth 1 form))
2255 (cons 'autoload (cdr (cdr form))))
2256 byte-compile-function-environment))
2257 (if (stringp (nth 3 form))
2258 form
2259 ;; No doc string, so we can compile this as a normal form.
2260 (byte-compile-keep-pending form 'byte-compile-normal-call)))
2262 (put 'defvar 'byte-hunk-handler 'byte-compile-file-form-defvar)
2263 (put 'defconst 'byte-hunk-handler 'byte-compile-file-form-defvar)
2264 (defun byte-compile-file-form-defvar (form)
2265 (if (null (nth 3 form))
2266 ;; Since there is no doc string, we can compile this as a normal form,
2267 ;; and not do a file-boundary.
2268 (byte-compile-keep-pending form)
2269 (when (byte-compile-warning-enabled-p 'free-vars)
2270 (push (nth 1 form) byte-compile-bound-variables)
2271 (if (eq (car form) 'defconst)
2272 (push (nth 1 form) byte-compile-const-variables)))
2273 (cond ((consp (nth 2 form))
2274 (setq form (copy-sequence form))
2275 (setcar (cdr (cdr form))
2276 (byte-compile-top-level (nth 2 form) nil 'file))))
2277 form))
2279 (put 'define-abbrev-table 'byte-hunk-handler 'byte-compile-file-form-define-abbrev-table)
2280 (defun byte-compile-file-form-define-abbrev-table (form)
2281 (when (and (byte-compile-warning-enabled-p 'free-vars)
2282 (eq 'quote (car-safe (car-safe (cdr form)))))
2283 (push (car-safe (cdr (cadr form))) byte-compile-bound-variables))
2284 (byte-compile-keep-pending form))
2286 (put 'custom-declare-variable 'byte-hunk-handler
2287 'byte-compile-file-form-custom-declare-variable)
2288 (defun byte-compile-file-form-custom-declare-variable (form)
2289 (when (byte-compile-warning-enabled-p 'callargs)
2290 (byte-compile-nogroup-warn form))
2291 (when (byte-compile-warning-enabled-p 'free-vars)
2292 (push (nth 1 (nth 1 form)) byte-compile-bound-variables))
2293 ;; Don't compile the expression because it may be displayed to the user.
2294 ;; (when (eq (car-safe (nth 2 form)) 'quote)
2295 ;; ;; (nth 2 form) is meant to evaluate to an expression, so if we have the
2296 ;; ;; final value already, we can byte-compile it.
2297 ;; (setcar (cdr (nth 2 form))
2298 ;; (byte-compile-top-level (cadr (nth 2 form)) nil 'file)))
2299 (let ((tail (nthcdr 4 form)))
2300 (while tail
2301 (unless (keywordp (car tail)) ;No point optimizing keywords.
2302 ;; Compile the keyword arguments.
2303 (setcar tail (byte-compile-top-level (car tail) nil 'file)))
2304 (setq tail (cdr tail))))
2305 form)
2307 (put 'require 'byte-hunk-handler 'byte-compile-file-form-require)
2308 (defun byte-compile-file-form-require (form)
2309 (let ((args (mapcar 'eval (cdr form))))
2310 (apply 'require args)
2311 ;; Detect (require 'cl) in a way that works even if cl is already loaded.
2312 (if (member (car args) '("cl" cl))
2313 (byte-compile-disable-warning 'cl-functions)))
2314 (byte-compile-keep-pending form 'byte-compile-normal-call))
2316 (put 'progn 'byte-hunk-handler 'byte-compile-file-form-progn)
2317 (put 'prog1 'byte-hunk-handler 'byte-compile-file-form-progn)
2318 (put 'prog2 'byte-hunk-handler 'byte-compile-file-form-progn)
2319 (defun byte-compile-file-form-progn (form)
2320 (mapc 'byte-compile-file-form (cdr form))
2321 ;; Return nil so the forms are not output twice.
2322 nil)
2324 ;; This handler is not necessary, but it makes the output from dont-compile
2325 ;; and similar macros cleaner.
2326 (put 'eval 'byte-hunk-handler 'byte-compile-file-form-eval)
2327 (defun byte-compile-file-form-eval (form)
2328 (if (eq (car-safe (nth 1 form)) 'quote)
2329 (nth 1 (nth 1 form))
2330 (byte-compile-keep-pending form)))
2332 (put 'defun 'byte-hunk-handler 'byte-compile-file-form-defun)
2333 (defun byte-compile-file-form-defun (form)
2334 (byte-compile-file-form-defmumble form nil))
2336 (put 'defmacro 'byte-hunk-handler 'byte-compile-file-form-defmacro)
2337 (defun byte-compile-file-form-defmacro (form)
2338 (byte-compile-file-form-defmumble form t))
2340 (defun byte-compile-file-form-defmumble (form macrop)
2341 (let* ((name (car (cdr form)))
2342 (this-kind (if macrop 'byte-compile-macro-environment
2343 'byte-compile-function-environment))
2344 (that-kind (if macrop 'byte-compile-function-environment
2345 'byte-compile-macro-environment))
2346 (this-one (assq name (symbol-value this-kind)))
2347 (that-one (assq name (symbol-value that-kind)))
2348 (byte-compile-free-references nil)
2349 (byte-compile-free-assignments nil))
2350 (byte-compile-set-symbol-position name)
2351 ;; When a function or macro is defined, add it to the call tree so that
2352 ;; we can tell when functions are not used.
2353 (if byte-compile-generate-call-tree
2354 (or (assq name byte-compile-call-tree)
2355 (setq byte-compile-call-tree
2356 (cons (list name nil nil) byte-compile-call-tree))))
2358 (setq byte-compile-current-form name) ; for warnings
2359 (if (byte-compile-warning-enabled-p 'redefine)
2360 (byte-compile-arglist-warn form macrop))
2361 (if byte-compile-verbose
2362 (message "Compiling %s... (%s)" (or filename "") (nth 1 form)))
2363 (cond (that-one
2364 (if (and (byte-compile-warning-enabled-p 'redefine)
2365 ;; don't warn when compiling the stubs in byte-run...
2366 (not (assq (nth 1 form)
2367 byte-compile-initial-macro-environment)))
2368 (byte-compile-warn
2369 "`%s' defined multiple times, as both function and macro"
2370 (nth 1 form)))
2371 (setcdr that-one nil))
2372 (this-one
2373 (when (and (byte-compile-warning-enabled-p 'redefine)
2374 ;; hack: don't warn when compiling the magic internal
2375 ;; byte-compiler macros in byte-run.el...
2376 (not (assq (nth 1 form)
2377 byte-compile-initial-macro-environment)))
2378 (byte-compile-warn "%s `%s' defined multiple times in this file"
2379 (if macrop "macro" "function")
2380 (nth 1 form))))
2381 ((and (fboundp name)
2382 (eq (car-safe (symbol-function name))
2383 (if macrop 'lambda 'macro)))
2384 (when (byte-compile-warning-enabled-p 'redefine)
2385 (byte-compile-warn "%s `%s' being redefined as a %s"
2386 (if macrop "function" "macro")
2387 (nth 1 form)
2388 (if macrop "macro" "function")))
2389 ;; shadow existing definition
2390 (set this-kind
2391 (cons (cons name nil) (symbol-value this-kind))))
2393 (let ((body (nthcdr 3 form)))
2394 (when (and (stringp (car body))
2395 (symbolp (car-safe (cdr-safe body)))
2396 (car-safe (cdr-safe body))
2397 (stringp (car-safe (cdr-safe (cdr-safe body)))))
2398 (byte-compile-set-symbol-position (nth 1 form))
2399 (byte-compile-warn "probable `\"' without `\\' in doc string of %s"
2400 (nth 1 form))))
2402 ;; Generate code for declarations in macro definitions.
2403 ;; Remove declarations from the body of the macro definition.
2404 (when macrop
2405 (let ((tail (nthcdr 2 form)))
2406 (when (stringp (car (cdr tail)))
2407 (setq tail (cdr tail)))
2408 (while (and (consp (car (cdr tail)))
2409 (eq (car (car (cdr tail))) 'declare))
2410 (let ((declaration (car (cdr tail))))
2411 (setcdr tail (cdr (cdr tail)))
2412 (prin1 `(if macro-declaration-function
2413 (funcall macro-declaration-function
2414 ',name ',declaration))
2415 outbuffer)))))
2417 (let* ((new-one (byte-compile-lambda (nthcdr 2 form) t))
2418 (code (byte-compile-byte-code-maker new-one)))
2419 (if this-one
2420 (setcdr this-one new-one)
2421 (set this-kind
2422 (cons (cons name new-one) (symbol-value this-kind))))
2423 (if (and (stringp (nth 3 form))
2424 (eq 'quote (car-safe code))
2425 (eq 'lambda (car-safe (nth 1 code))))
2426 (cons (car form)
2427 (cons name (cdr (nth 1 code))))
2428 (byte-compile-flush-pending)
2429 (if (not (stringp (nth 3 form)))
2430 ;; No doc string. Provide -1 as the "doc string index"
2431 ;; so that no element will be treated as a doc string.
2432 (byte-compile-output-docform
2433 (if (byte-compile-version-cond byte-compile-compatibility)
2434 "\n(fset '" "\n(defalias '")
2435 name
2436 (cond ((atom code)
2437 (if macrop '(" '(macro . #[" -1 "])") '(" #[" -1 "]")))
2438 ((eq (car code) 'quote)
2439 (setq code new-one)
2440 (if macrop '(" '(macro " -1 ")") '(" '(" -1 ")")))
2441 ((if macrop '(" (cons 'macro (" -1 "))") '(" (" -1 ")"))))
2442 (append code nil)
2443 (and (atom code) byte-compile-dynamic
2445 nil)
2446 ;; Output the form by hand, that's much simpler than having
2447 ;; b-c-output-file-form analyze the defalias.
2448 (byte-compile-output-docform
2449 (if (byte-compile-version-cond byte-compile-compatibility)
2450 "\n(fset '" "\n(defalias '")
2451 name
2452 (cond ((atom code)
2453 (if macrop '(" '(macro . #[" 4 "])") '(" #[" 4 "]")))
2454 ((eq (car code) 'quote)
2455 (setq code new-one)
2456 (if macrop '(" '(macro " 2 ")") '(" '(" 2 ")")))
2457 ((if macrop '(" (cons 'macro (" 5 "))") '(" (" 5 ")"))))
2458 (append code nil)
2459 (and (atom code) byte-compile-dynamic
2461 nil))
2462 (princ ")" outbuffer)
2463 nil))))
2465 ;; Print Lisp object EXP in the output file, inside a comment,
2466 ;; and return the file position it will have.
2467 ;; If QUOTED is non-nil, print with quoting; otherwise, print without quoting.
2468 (defun byte-compile-output-as-comment (exp quoted)
2469 (let ((position (point)))
2470 (with-current-buffer outbuffer
2472 ;; Insert EXP, and make it a comment with #@LENGTH.
2473 (insert " ")
2474 (if quoted
2475 (prin1 exp outbuffer)
2476 (princ exp outbuffer))
2477 (goto-char position)
2478 ;; Quote certain special characters as needed.
2479 ;; get_doc_string in doc.c does the unquoting.
2480 (while (search-forward "\^A" nil t)
2481 (replace-match "\^A\^A" t t))
2482 (goto-char position)
2483 (while (search-forward "\000" nil t)
2484 (replace-match "\^A0" t t))
2485 (goto-char position)
2486 (while (search-forward "\037" nil t)
2487 (replace-match "\^A_" t t))
2488 (goto-char (point-max))
2489 (insert "\037")
2490 (goto-char position)
2491 (insert "#@" (format "%d" (- (position-bytes (point-max))
2492 (position-bytes position))))
2494 ;; Save the file position of the object.
2495 ;; Note we should add 1 to skip the space
2496 ;; that we inserted before the actual doc string,
2497 ;; and subtract 1 to convert from an 1-origin Emacs position
2498 ;; to a file position; they cancel.
2499 (setq position (point))
2500 (goto-char (point-max)))
2501 position))
2505 ;;;###autoload
2506 (defun byte-compile (form)
2507 "If FORM is a symbol, byte-compile its function definition.
2508 If FORM is a lambda or a macro, byte-compile it as a function."
2509 (displaying-byte-compile-warnings
2510 (byte-compile-close-variables
2511 (let* ((fun (if (symbolp form)
2512 (and (fboundp form) (symbol-function form))
2513 form))
2514 (macro (eq (car-safe fun) 'macro)))
2515 (if macro
2516 (setq fun (cdr fun)))
2517 (cond ((eq (car-safe fun) 'lambda)
2518 (setq fun (if macro
2519 (cons 'macro (byte-compile-lambda fun))
2520 (byte-compile-lambda fun)))
2521 (if (symbolp form)
2522 (defalias form fun)
2523 fun)))))))
2525 (defun byte-compile-sexp (sexp)
2526 "Compile and return SEXP."
2527 (displaying-byte-compile-warnings
2528 (byte-compile-close-variables
2529 (byte-compile-top-level sexp))))
2531 ;; Given a function made by byte-compile-lambda, make a form which produces it.
2532 (defun byte-compile-byte-code-maker (fun)
2533 (cond
2534 ((byte-compile-version-cond byte-compile-compatibility)
2535 ;; Return (quote (lambda ...)).
2536 (list 'quote (byte-compile-byte-code-unmake fun)))
2537 ;; ## atom is faster than compiled-func-p.
2538 ((atom fun) ; compiled function.
2539 ;; generate-emacs19-bytecodes must be on, otherwise byte-compile-lambda
2540 ;; would have produced a lambda.
2541 fun)
2542 ;; b-c-lambda didn't produce a compiled-function, so it's either a trivial
2543 ;; function, or this is Emacs 18, or generate-emacs19-bytecodes is off.
2544 ((let (tmp)
2545 (if (and (setq tmp (assq 'byte-code (cdr-safe (cdr fun))))
2546 (null (cdr (memq tmp fun))))
2547 ;; Generate a make-byte-code call.
2548 (let* ((interactive (assq 'interactive (cdr (cdr fun)))))
2549 (nconc (list 'make-byte-code
2550 (list 'quote (nth 1 fun)) ;arglist
2551 (nth 1 tmp) ;bytes
2552 (nth 2 tmp) ;consts
2553 (nth 3 tmp)) ;depth
2554 (cond ((stringp (nth 2 fun))
2555 (list (nth 2 fun))) ;doc
2556 (interactive
2557 (list nil)))
2558 (cond (interactive
2559 (list (if (or (null (nth 1 interactive))
2560 (stringp (nth 1 interactive)))
2561 (nth 1 interactive)
2562 ;; Interactive spec is a list or a variable
2563 ;; (if it is correct).
2564 (list 'quote (nth 1 interactive))))))))
2565 ;; a non-compiled function (probably trivial)
2566 (list 'quote fun))))))
2568 ;; Turn a function into an ordinary lambda. Needed for v18 files.
2569 (defun byte-compile-byte-code-unmake (function)
2570 (if (consp function)
2571 function;;It already is a lambda.
2572 (setq function (append function nil)) ; turn it into a list
2573 (nconc (list 'lambda (nth 0 function))
2574 (and (nth 4 function) (list (nth 4 function)))
2575 (if (nthcdr 5 function)
2576 (list (cons 'interactive (if (nth 5 function)
2577 (nthcdr 5 function)))))
2578 (list (list 'byte-code
2579 (nth 1 function) (nth 2 function)
2580 (nth 3 function))))))
2583 (defun byte-compile-check-lambda-list (list)
2584 "Check lambda-list LIST for errors."
2585 (let (vars)
2586 (while list
2587 (let ((arg (car list)))
2588 (when (symbolp arg)
2589 (byte-compile-set-symbol-position arg))
2590 (cond ((or (not (symbolp arg))
2591 (byte-compile-const-symbol-p arg t))
2592 (error "Invalid lambda variable %s" arg))
2593 ((eq arg '&rest)
2594 (unless (cdr list)
2595 (error "&rest without variable name"))
2596 (when (cddr list)
2597 (error "Garbage following &rest VAR in lambda-list")))
2598 ((eq arg '&optional)
2599 (unless (cdr list)
2600 (error "Variable name missing after &optional")))
2601 ((memq arg vars)
2602 (byte-compile-warn "repeated variable %s in lambda-list" arg))
2604 (push arg vars))))
2605 (setq list (cdr list)))))
2608 ;; Byte-compile a lambda-expression and return a valid function.
2609 ;; The value is usually a compiled function but may be the original
2610 ;; lambda-expression.
2611 ;; When ADD-LAMBDA is non-nil, the symbol `lambda' is added as head
2612 ;; of the list FUN and `byte-compile-set-symbol-position' is not called.
2613 ;; Use this feature to avoid calling `byte-compile-set-symbol-position'
2614 ;; for symbols generated by the byte compiler itself.
2615 (defun byte-compile-lambda (fun &optional add-lambda)
2616 (if add-lambda
2617 (setq fun (cons 'lambda fun))
2618 (unless (eq 'lambda (car-safe fun))
2619 (error "Not a lambda list: %S" fun))
2620 (byte-compile-set-symbol-position 'lambda))
2621 (byte-compile-check-lambda-list (nth 1 fun))
2622 (let* ((arglist (nth 1 fun))
2623 (byte-compile-bound-variables
2624 (nconc (and (byte-compile-warning-enabled-p 'free-vars)
2625 (delq '&rest (delq '&optional (copy-sequence arglist))))
2626 byte-compile-bound-variables))
2627 (body (cdr (cdr fun)))
2628 (doc (if (stringp (car body))
2629 (prog1 (car body)
2630 ;; Discard the doc string
2631 ;; unless it is the last element of the body.
2632 (if (cdr body)
2633 (setq body (cdr body))))))
2634 (int (assq 'interactive body)))
2635 ;; Process the interactive spec.
2636 (when int
2637 (byte-compile-set-symbol-position 'interactive)
2638 ;; Skip (interactive) if it is in front (the most usual location).
2639 (if (eq int (car body))
2640 (setq body (cdr body)))
2641 (cond ((consp (cdr int))
2642 (if (cdr (cdr int))
2643 (byte-compile-warn "malformed interactive spec: %s"
2644 (prin1-to-string int)))
2645 ;; If the interactive spec is a call to `list', don't
2646 ;; compile it, because `call-interactively' looks at the
2647 ;; args of `list'. Actually, compile it to get warnings,
2648 ;; but don't use the result.
2649 (let ((form (nth 1 int)))
2650 (while (memq (car-safe form) '(let let* progn save-excursion))
2651 (while (consp (cdr form))
2652 (setq form (cdr form)))
2653 (setq form (car form)))
2654 (if (eq (car-safe form) 'list)
2655 (byte-compile-top-level (nth 1 int))
2656 (setq int (list 'interactive
2657 (byte-compile-top-level (nth 1 int)))))))
2658 ((cdr int)
2659 (byte-compile-warn "malformed interactive spec: %s"
2660 (prin1-to-string int)))))
2661 ;; Process the body.
2662 (let ((compiled (byte-compile-top-level (cons 'progn body) nil 'lambda)))
2663 ;; Build the actual byte-coded function.
2664 (if (and (eq 'byte-code (car-safe compiled))
2665 (not (byte-compile-version-cond
2666 byte-compile-compatibility)))
2667 (apply 'make-byte-code
2668 (append (list arglist)
2669 ;; byte-string, constants-vector, stack depth
2670 (cdr compiled)
2671 ;; optionally, the doc string.
2672 (if (or doc int)
2673 (list doc))
2674 ;; optionally, the interactive spec.
2675 (if int
2676 (list (nth 1 int)))))
2677 (setq compiled
2678 (nconc (if int (list int))
2679 (cond ((eq (car-safe compiled) 'progn) (cdr compiled))
2680 (compiled (list compiled)))))
2681 (nconc (list 'lambda arglist)
2682 (if (or doc (stringp (car compiled)))
2683 (cons doc (cond (compiled)
2684 (body (list nil))))
2685 compiled))))))
2687 (defun byte-compile-constants-vector ()
2688 ;; Builds the constants-vector from the current variables and constants.
2689 ;; This modifies the constants from (const . nil) to (const . offset).
2690 ;; To keep the byte-codes to look up the vector as short as possible:
2691 ;; First 6 elements are vars, as there are one-byte varref codes for those.
2692 ;; Next up to byte-constant-limit are constants, still with one-byte codes.
2693 ;; Next variables again, to get 2-byte codes for variable lookup.
2694 ;; The rest of the constants and variables need 3-byte byte-codes.
2695 (let* ((i -1)
2696 (rest (nreverse byte-compile-variables)) ; nreverse because the first
2697 (other (nreverse byte-compile-constants)) ; vars often are used most.
2698 ret tmp
2699 (limits '(5 ; Use the 1-byte varref codes,
2700 63 ; 1-constlim ; 1-byte byte-constant codes,
2701 255 ; 2-byte varref codes,
2702 65535)) ; 3-byte codes for the rest.
2703 limit)
2704 (while (or rest other)
2705 (setq limit (car limits))
2706 (while (and rest (not (eq i limit)))
2707 (if (setq tmp (assq (car (car rest)) ret))
2708 (setcdr (car rest) (cdr tmp))
2709 (setcdr (car rest) (setq i (1+ i)))
2710 (setq ret (cons (car rest) ret)))
2711 (setq rest (cdr rest)))
2712 (setq limits (cdr limits)
2713 rest (prog1 other
2714 (setq other rest))))
2715 (apply 'vector (nreverse (mapcar 'car ret)))))
2717 ;; Given an expression FORM, compile it and return an equivalent byte-code
2718 ;; expression (a call to the function byte-code).
2719 (defun byte-compile-top-level (form &optional for-effect output-type)
2720 ;; OUTPUT-TYPE advises about how form is expected to be used:
2721 ;; 'eval or nil -> a single form,
2722 ;; 'progn or t -> a list of forms,
2723 ;; 'lambda -> body of a lambda,
2724 ;; 'file -> used at file-level.
2725 (let ((byte-compile-constants nil)
2726 (byte-compile-variables nil)
2727 (byte-compile-tag-number 0)
2728 (byte-compile-depth 0)
2729 (byte-compile-maxdepth 0)
2730 (byte-compile-output nil))
2731 (if (memq byte-optimize '(t source))
2732 (setq form (byte-optimize-form form for-effect)))
2733 (while (and (eq (car-safe form) 'progn) (null (cdr (cdr form))))
2734 (setq form (nth 1 form)))
2735 (if (and (eq 'byte-code (car-safe form))
2736 (not (memq byte-optimize '(t byte)))
2737 (stringp (nth 1 form)) (vectorp (nth 2 form))
2738 (natnump (nth 3 form)))
2739 form
2740 (byte-compile-form form for-effect)
2741 (byte-compile-out-toplevel for-effect output-type))))
2743 (defun byte-compile-out-toplevel (&optional for-effect output-type)
2744 (if for-effect
2745 ;; The stack is empty. Push a value to be returned from (byte-code ..).
2746 (if (eq (car (car byte-compile-output)) 'byte-discard)
2747 (setq byte-compile-output (cdr byte-compile-output))
2748 (byte-compile-push-constant
2749 ;; Push any constant - preferably one which already is used, and
2750 ;; a number or symbol - ie not some big sequence. The return value
2751 ;; isn't returned, but it would be a shame if some textually large
2752 ;; constant was not optimized away because we chose to return it.
2753 (and (not (assq nil byte-compile-constants)) ; Nil is often there.
2754 (let ((tmp (reverse byte-compile-constants)))
2755 (while (and tmp (not (or (symbolp (caar tmp))
2756 (numberp (caar tmp)))))
2757 (setq tmp (cdr tmp)))
2758 (caar tmp))))))
2759 (byte-compile-out 'byte-return 0)
2760 (setq byte-compile-output (nreverse byte-compile-output))
2761 (if (memq byte-optimize '(t byte))
2762 (setq byte-compile-output
2763 (byte-optimize-lapcode byte-compile-output for-effect)))
2765 ;; Decompile trivial functions:
2766 ;; only constants and variables, or a single funcall except in lambdas.
2767 ;; Except for Lisp_Compiled objects, forms like (foo "hi")
2768 ;; are still quicker than (byte-code "..." [foo "hi"] 2).
2769 ;; Note that even (quote foo) must be parsed just as any subr by the
2770 ;; interpreter, so quote should be compiled into byte-code in some contexts.
2771 ;; What to leave uncompiled:
2772 ;; lambda -> never. we used to leave it uncompiled if the body was
2773 ;; a single atom, but that causes confusion if the docstring
2774 ;; uses the (file . pos) syntax. Besides, now that we have
2775 ;; the Lisp_Compiled type, the compiled form is faster.
2776 ;; eval -> atom, quote or (function atom atom atom)
2777 ;; progn -> as <<same-as-eval>> or (progn <<same-as-eval>> atom)
2778 ;; file -> as progn, but takes both quotes and atoms, and longer forms.
2779 (let (rest
2780 (maycall (not (eq output-type 'lambda))) ; t if we may make a funcall.
2781 tmp body)
2782 (cond
2783 ;; #### This should be split out into byte-compile-nontrivial-function-p.
2784 ((or (eq output-type 'lambda)
2785 (nthcdr (if (eq output-type 'file) 50 8) byte-compile-output)
2786 (assq 'TAG byte-compile-output) ; Not necessary, but speeds up a bit.
2787 (not (setq tmp (assq 'byte-return byte-compile-output)))
2788 (progn
2789 (setq rest (nreverse
2790 (cdr (memq tmp (reverse byte-compile-output)))))
2791 (while (cond
2792 ((memq (car (car rest)) '(byte-varref byte-constant))
2793 (setq tmp (car (cdr (car rest))))
2794 (if (if (eq (car (car rest)) 'byte-constant)
2795 (or (consp tmp)
2796 (and (symbolp tmp)
2797 (not (byte-compile-const-symbol-p tmp)))))
2798 (if maycall
2799 (setq body (cons (list 'quote tmp) body)))
2800 (setq body (cons tmp body))))
2801 ((and maycall
2802 ;; Allow a funcall if at most one atom follows it.
2803 (null (nthcdr 3 rest))
2804 (setq tmp (get (car (car rest)) 'byte-opcode-invert))
2805 (or (null (cdr rest))
2806 (and (memq output-type '(file progn t))
2807 (cdr (cdr rest))
2808 (eq (car (nth 1 rest)) 'byte-discard)
2809 (progn (setq rest (cdr rest)) t))))
2810 (setq maycall nil) ; Only allow one real function call.
2811 (setq body (nreverse body))
2812 (setq body (list
2813 (if (and (eq tmp 'funcall)
2814 (eq (car-safe (car body)) 'quote))
2815 (cons (nth 1 (car body)) (cdr body))
2816 (cons tmp body))))
2817 (or (eq output-type 'file)
2818 (not (delq nil (mapcar 'consp (cdr (car body))))))))
2819 (setq rest (cdr rest)))
2820 rest))
2821 (let ((byte-compile-vector (byte-compile-constants-vector)))
2822 (list 'byte-code (byte-compile-lapcode byte-compile-output)
2823 byte-compile-vector byte-compile-maxdepth)))
2824 ;; it's a trivial function
2825 ((cdr body) (cons 'progn (nreverse body)))
2826 ((car body)))))
2828 ;; Given BODY, compile it and return a new body.
2829 (defun byte-compile-top-level-body (body &optional for-effect)
2830 (setq body (byte-compile-top-level (cons 'progn body) for-effect t))
2831 (cond ((eq (car-safe body) 'progn)
2832 (cdr body))
2833 (body
2834 (list body))))
2836 (put 'declare-function 'byte-hunk-handler 'byte-compile-declare-function)
2837 (defun byte-compile-declare-function (form)
2838 (push (cons (nth 1 form)
2839 (if (and (> (length form) 3)
2840 (listp (nth 3 form)))
2841 (list 'declared (nth 3 form))
2842 t)) ; arglist not specified
2843 byte-compile-function-environment)
2844 ;; We are stating that it _will_ be defined at runtime.
2845 (setq byte-compile-noruntime-functions
2846 (delq (nth 1 form) byte-compile-noruntime-functions))
2847 nil)
2850 ;; This is the recursive entry point for compiling each subform of an
2851 ;; expression.
2852 ;; If for-effect is non-nil, byte-compile-form will output a byte-discard
2853 ;; before terminating (ie no value will be left on the stack).
2854 ;; A byte-compile handler may, when for-effect is non-nil, choose output code
2855 ;; which does not leave a value on the stack, and then set for-effect to nil
2856 ;; (to prevent byte-compile-form from outputting the byte-discard).
2857 ;; If a handler wants to call another handler, it should do so via
2858 ;; byte-compile-form, or take extreme care to handle for-effect correctly.
2859 ;; (Use byte-compile-form-do-effect to reset the for-effect flag too.)
2861 (defun byte-compile-form (form &optional for-effect)
2862 (setq form (macroexpand form byte-compile-macro-environment))
2863 (cond ((not (consp form))
2864 (cond ((or (not (symbolp form)) (byte-compile-const-symbol-p form))
2865 (when (symbolp form)
2866 (byte-compile-set-symbol-position form))
2867 (byte-compile-constant form))
2868 ((and for-effect byte-compile-delete-errors)
2869 (when (symbolp form)
2870 (byte-compile-set-symbol-position form))
2871 (setq for-effect nil))
2872 (t (byte-compile-variable-ref 'byte-varref form))))
2873 ((symbolp (car form))
2874 (let* ((fn (car form))
2875 (handler (get fn 'byte-compile)))
2876 (when (byte-compile-const-symbol-p fn)
2877 (byte-compile-warn "`%s' called as a function" fn))
2878 (and (byte-compile-warning-enabled-p 'interactive-only)
2879 (memq fn byte-compile-interactive-only-functions)
2880 (byte-compile-warn "`%s' used from Lisp code\n\
2881 That command is designed for interactive use only" fn))
2882 (if (and handler
2883 ;; Make sure that function exists. This is important
2884 ;; for CL compiler macros since the symbol may be
2885 ;; `cl-byte-compile-compiler-macro' but if CL isn't
2886 ;; loaded, this function doesn't exist.
2887 (or (not (memq handler '(cl-byte-compile-compiler-macro)))
2888 (functionp handler))
2889 (not (and (byte-compile-version-cond
2890 byte-compile-compatibility)
2891 (get (get fn 'byte-opcode) 'emacs19-opcode))))
2892 (funcall handler form)
2893 (when (byte-compile-warning-enabled-p 'callargs)
2894 (if (memq fn '(custom-declare-group custom-declare-variable custom-declare-face))
2895 (byte-compile-nogroup-warn form))
2896 (byte-compile-callargs-warn form))
2897 (byte-compile-normal-call form))
2898 (if (byte-compile-warning-enabled-p 'cl-functions)
2899 (byte-compile-cl-warn form))))
2900 ((and (or (byte-code-function-p (car form))
2901 (eq (car-safe (car form)) 'lambda))
2902 ;; if the form comes out the same way it went in, that's
2903 ;; because it was malformed, and we couldn't unfold it.
2904 (not (eq form (setq form (byte-compile-unfold-lambda form)))))
2905 (byte-compile-form form for-effect)
2906 (setq for-effect nil))
2907 ((byte-compile-normal-call form)))
2908 (if for-effect
2909 (byte-compile-discard)))
2911 (defun byte-compile-normal-call (form)
2912 (if byte-compile-generate-call-tree
2913 (byte-compile-annotate-call-tree form))
2914 (when (and for-effect (eq (car form) 'mapcar)
2915 (byte-compile-warning-enabled-p 'mapcar))
2916 (byte-compile-set-symbol-position 'mapcar)
2917 (byte-compile-warn
2918 "`mapcar' called for effect; use `mapc' or `dolist' instead"))
2919 (byte-compile-push-constant (car form))
2920 (mapc 'byte-compile-form (cdr form)) ; wasteful, but faster.
2921 (byte-compile-out 'byte-call (length (cdr form))))
2923 (defun byte-compile-variable-ref (base-op var)
2924 (when (symbolp var)
2925 (byte-compile-set-symbol-position var))
2926 (if (or (not (symbolp var))
2927 (byte-compile-const-symbol-p var (not (eq base-op 'byte-varref))))
2928 (byte-compile-warn
2929 (cond ((eq base-op 'byte-varbind) "attempt to let-bind %s `%s'")
2930 ((eq base-op 'byte-varset) "variable assignment to %s `%s'")
2931 (t "variable reference to %s `%s'"))
2932 (if (symbolp var) "constant" "nonvariable")
2933 (prin1-to-string var))
2934 (and (get var 'byte-obsolete-variable)
2935 (not (eq var byte-compile-not-obsolete-var))
2936 (byte-compile-warn-obsolete var))
2937 (if (byte-compile-warning-enabled-p 'free-vars)
2938 (if (eq base-op 'byte-varbind)
2939 (push var byte-compile-bound-variables)
2940 (or (boundp var)
2941 (memq var byte-compile-bound-variables)
2942 (if (eq base-op 'byte-varset)
2943 (or (memq var byte-compile-free-assignments)
2944 (progn
2945 (byte-compile-warn "assignment to free variable `%s'" var)
2946 (push var byte-compile-free-assignments)))
2947 (or (memq var byte-compile-free-references)
2948 (progn
2949 (byte-compile-warn "reference to free variable `%s'" var)
2950 (push var byte-compile-free-references))))))))
2951 (let ((tmp (assq var byte-compile-variables)))
2952 (unless tmp
2953 (setq tmp (list var))
2954 (push tmp byte-compile-variables))
2955 (byte-compile-out base-op tmp)))
2957 (defmacro byte-compile-get-constant (const)
2958 `(or (if (stringp ,const)
2959 ;; In a string constant, treat properties as significant.
2960 (let (result)
2961 (dolist (elt byte-compile-constants)
2962 (if (equal-including-properties (car elt) ,const)
2963 (setq result elt)))
2964 result)
2965 (assq ,const byte-compile-constants))
2966 (car (setq byte-compile-constants
2967 (cons (list ,const) byte-compile-constants)))))
2969 ;; Use this when the value of a form is a constant. This obeys for-effect.
2970 (defun byte-compile-constant (const)
2971 (if for-effect
2972 (setq for-effect nil)
2973 (when (symbolp const)
2974 (byte-compile-set-symbol-position const))
2975 (byte-compile-out 'byte-constant (byte-compile-get-constant const))))
2977 ;; Use this for a constant that is not the value of its containing form.
2978 ;; This ignores for-effect.
2979 (defun byte-compile-push-constant (const)
2980 (let ((for-effect nil))
2981 (inline (byte-compile-constant const))))
2984 ;; Compile those primitive ordinary functions
2985 ;; which have special byte codes just for speed.
2987 (defmacro byte-defop-compiler (function &optional compile-handler)
2988 ;; add a compiler-form for FUNCTION.
2989 ;; If function is a symbol, then the variable "byte-SYMBOL" must name
2990 ;; the opcode to be used. If function is a list, the first element
2991 ;; is the function and the second element is the bytecode-symbol.
2992 ;; The second element may be nil, meaning there is no opcode.
2993 ;; COMPILE-HANDLER is the function to use to compile this byte-op, or
2994 ;; may be the abbreviations 0, 1, 2, 3, 0-1, or 1-2.
2995 ;; If it is nil, then the handler is "byte-compile-SYMBOL."
2996 (let (opcode)
2997 (if (symbolp function)
2998 (setq opcode (intern (concat "byte-" (symbol-name function))))
2999 (setq opcode (car (cdr function))
3000 function (car function)))
3001 (let ((fnform
3002 (list 'put (list 'quote function) ''byte-compile
3003 (list 'quote
3004 (or (cdr (assq compile-handler
3005 '((0 . byte-compile-no-args)
3006 (1 . byte-compile-one-arg)
3007 (2 . byte-compile-two-args)
3008 (3 . byte-compile-three-args)
3009 (0-1 . byte-compile-zero-or-one-arg)
3010 (1-2 . byte-compile-one-or-two-args)
3011 (2-3 . byte-compile-two-or-three-args)
3013 compile-handler
3014 (intern (concat "byte-compile-"
3015 (symbol-name function))))))))
3016 (if opcode
3017 (list 'progn fnform
3018 (list 'put (list 'quote function)
3019 ''byte-opcode (list 'quote opcode))
3020 (list 'put (list 'quote opcode)
3021 ''byte-opcode-invert (list 'quote function)))
3022 fnform))))
3024 (defmacro byte-defop-compiler19 (function &optional compile-handler)
3025 ;; Just like byte-defop-compiler, but defines an opcode that will only
3026 ;; be used when byte-compile-compatibility is false.
3027 (if (and (byte-compile-single-version)
3028 byte-compile-compatibility)
3029 ;; #### instead of doing nothing, this should do some remprops,
3030 ;; #### to protect against the case where a single-version compiler
3031 ;; #### is loaded into a world that has contained a multi-version one.
3033 (list 'progn
3034 (list 'put
3035 (list 'quote
3036 (or (car (cdr-safe function))
3037 (intern (concat "byte-"
3038 (symbol-name (or (car-safe function) function))))))
3039 ''emacs19-opcode t)
3040 (list 'byte-defop-compiler function compile-handler))))
3042 (defmacro byte-defop-compiler-1 (function &optional compile-handler)
3043 (list 'byte-defop-compiler (list function nil) compile-handler))
3046 (put 'byte-call 'byte-opcode-invert 'funcall)
3047 (put 'byte-list1 'byte-opcode-invert 'list)
3048 (put 'byte-list2 'byte-opcode-invert 'list)
3049 (put 'byte-list3 'byte-opcode-invert 'list)
3050 (put 'byte-list4 'byte-opcode-invert 'list)
3051 (put 'byte-listN 'byte-opcode-invert 'list)
3052 (put 'byte-concat2 'byte-opcode-invert 'concat)
3053 (put 'byte-concat3 'byte-opcode-invert 'concat)
3054 (put 'byte-concat4 'byte-opcode-invert 'concat)
3055 (put 'byte-concatN 'byte-opcode-invert 'concat)
3056 (put 'byte-insertN 'byte-opcode-invert 'insert)
3058 (byte-defop-compiler point 0)
3059 ;;(byte-defop-compiler mark 0) ;; obsolete
3060 (byte-defop-compiler point-max 0)
3061 (byte-defop-compiler point-min 0)
3062 (byte-defop-compiler following-char 0)
3063 (byte-defop-compiler preceding-char 0)
3064 (byte-defop-compiler current-column 0)
3065 (byte-defop-compiler eolp 0)
3066 (byte-defop-compiler eobp 0)
3067 (byte-defop-compiler bolp 0)
3068 (byte-defop-compiler bobp 0)
3069 (byte-defop-compiler current-buffer 0)
3070 ;;(byte-defop-compiler read-char 0) ;; obsolete
3071 (byte-defop-compiler interactive-p 0)
3072 (byte-defop-compiler19 widen 0)
3073 (byte-defop-compiler19 end-of-line 0-1)
3074 (byte-defop-compiler19 forward-char 0-1)
3075 (byte-defop-compiler19 forward-line 0-1)
3076 (byte-defop-compiler symbolp 1)
3077 (byte-defop-compiler consp 1)
3078 (byte-defop-compiler stringp 1)
3079 (byte-defop-compiler listp 1)
3080 (byte-defop-compiler not 1)
3081 (byte-defop-compiler (null byte-not) 1)
3082 (byte-defop-compiler car 1)
3083 (byte-defop-compiler cdr 1)
3084 (byte-defop-compiler length 1)
3085 (byte-defop-compiler symbol-value 1)
3086 (byte-defop-compiler symbol-function 1)
3087 (byte-defop-compiler (1+ byte-add1) 1)
3088 (byte-defop-compiler (1- byte-sub1) 1)
3089 (byte-defop-compiler goto-char 1)
3090 (byte-defop-compiler char-after 0-1)
3091 (byte-defop-compiler set-buffer 1)
3092 ;;(byte-defop-compiler set-mark 1) ;; obsolete
3093 (byte-defop-compiler19 forward-word 0-1)
3094 (byte-defop-compiler19 char-syntax 1)
3095 (byte-defop-compiler19 nreverse 1)
3096 (byte-defop-compiler19 car-safe 1)
3097 (byte-defop-compiler19 cdr-safe 1)
3098 (byte-defop-compiler19 numberp 1)
3099 (byte-defop-compiler19 integerp 1)
3100 (byte-defop-compiler19 skip-chars-forward 1-2)
3101 (byte-defop-compiler19 skip-chars-backward 1-2)
3102 (byte-defop-compiler eq 2)
3103 (byte-defop-compiler memq 2)
3104 (byte-defop-compiler cons 2)
3105 (byte-defop-compiler aref 2)
3106 (byte-defop-compiler set 2)
3107 (byte-defop-compiler (= byte-eqlsign) 2)
3108 (byte-defop-compiler (< byte-lss) 2)
3109 (byte-defop-compiler (> byte-gtr) 2)
3110 (byte-defop-compiler (<= byte-leq) 2)
3111 (byte-defop-compiler (>= byte-geq) 2)
3112 (byte-defop-compiler get 2)
3113 (byte-defop-compiler nth 2)
3114 (byte-defop-compiler substring 2-3)
3115 (byte-defop-compiler19 (move-marker byte-set-marker) 2-3)
3116 (byte-defop-compiler19 set-marker 2-3)
3117 (byte-defop-compiler19 match-beginning 1)
3118 (byte-defop-compiler19 match-end 1)
3119 (byte-defop-compiler19 upcase 1)
3120 (byte-defop-compiler19 downcase 1)
3121 (byte-defop-compiler19 string= 2)
3122 (byte-defop-compiler19 string< 2)
3123 (byte-defop-compiler19 (string-equal byte-string=) 2)
3124 (byte-defop-compiler19 (string-lessp byte-string<) 2)
3125 (byte-defop-compiler19 equal 2)
3126 (byte-defop-compiler19 nthcdr 2)
3127 (byte-defop-compiler19 elt 2)
3128 (byte-defop-compiler19 member 2)
3129 (byte-defop-compiler19 assq 2)
3130 (byte-defop-compiler19 (rplaca byte-setcar) 2)
3131 (byte-defop-compiler19 (rplacd byte-setcdr) 2)
3132 (byte-defop-compiler19 setcar 2)
3133 (byte-defop-compiler19 setcdr 2)
3134 (byte-defop-compiler19 buffer-substring 2)
3135 (byte-defop-compiler19 delete-region 2)
3136 (byte-defop-compiler19 narrow-to-region 2)
3137 (byte-defop-compiler19 (% byte-rem) 2)
3138 (byte-defop-compiler aset 3)
3140 (byte-defop-compiler max byte-compile-associative)
3141 (byte-defop-compiler min byte-compile-associative)
3142 (byte-defop-compiler (+ byte-plus) byte-compile-associative)
3143 (byte-defop-compiler19 (* byte-mult) byte-compile-associative)
3145 ;;####(byte-defop-compiler19 move-to-column 1)
3146 (byte-defop-compiler-1 interactive byte-compile-noop)
3149 (defun byte-compile-subr-wrong-args (form n)
3150 (byte-compile-set-symbol-position (car form))
3151 (byte-compile-warn "`%s' called with %d arg%s, but requires %s"
3152 (car form) (length (cdr form))
3153 (if (= 1 (length (cdr form))) "" "s") n)
3154 ;; get run-time wrong-number-of-args error.
3155 (byte-compile-normal-call form))
3157 (defun byte-compile-no-args (form)
3158 (if (not (= (length form) 1))
3159 (byte-compile-subr-wrong-args form "none")
3160 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3162 (defun byte-compile-one-arg (form)
3163 (if (not (= (length form) 2))
3164 (byte-compile-subr-wrong-args form 1)
3165 (byte-compile-form (car (cdr form))) ;; Push the argument
3166 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3168 (defun byte-compile-two-args (form)
3169 (if (not (= (length form) 3))
3170 (byte-compile-subr-wrong-args form 2)
3171 (byte-compile-form (car (cdr form))) ;; Push the arguments
3172 (byte-compile-form (nth 2 form))
3173 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3175 (defun byte-compile-three-args (form)
3176 (if (not (= (length form) 4))
3177 (byte-compile-subr-wrong-args form 3)
3178 (byte-compile-form (car (cdr form))) ;; Push the arguments
3179 (byte-compile-form (nth 2 form))
3180 (byte-compile-form (nth 3 form))
3181 (byte-compile-out (get (car form) 'byte-opcode) 0)))
3183 (defun byte-compile-zero-or-one-arg (form)
3184 (let ((len (length form)))
3185 (cond ((= len 1) (byte-compile-one-arg (append form '(nil))))
3186 ((= len 2) (byte-compile-one-arg form))
3187 (t (byte-compile-subr-wrong-args form "0-1")))))
3189 (defun byte-compile-one-or-two-args (form)
3190 (let ((len (length form)))
3191 (cond ((= len 2) (byte-compile-two-args (append form '(nil))))
3192 ((= len 3) (byte-compile-two-args form))
3193 (t (byte-compile-subr-wrong-args form "1-2")))))
3195 (defun byte-compile-two-or-three-args (form)
3196 (let ((len (length form)))
3197 (cond ((= len 3) (byte-compile-three-args (append form '(nil))))
3198 ((= len 4) (byte-compile-three-args form))
3199 (t (byte-compile-subr-wrong-args form "2-3")))))
3201 (defun byte-compile-noop (form)
3202 (byte-compile-constant nil))
3204 (defun byte-compile-discard ()
3205 (byte-compile-out 'byte-discard 0))
3208 ;; Compile a function that accepts one or more args and is right-associative.
3209 ;; We do it by left-associativity so that the operations
3210 ;; are done in the same order as in interpreted code.
3211 ;; We treat the one-arg case, as in (+ x), like (+ x 0).
3212 ;; in order to convert markers to numbers, and trigger expected errors.
3213 (defun byte-compile-associative (form)
3214 (if (cdr form)
3215 (let ((opcode (get (car form) 'byte-opcode))
3216 (args (copy-sequence (cdr form))))
3217 (byte-compile-form (car args))
3218 (setq args (cdr args))
3219 (or args (setq args '(0)
3220 opcode (get '+ 'byte-opcode)))
3221 (dolist (arg args)
3222 (byte-compile-form arg)
3223 (byte-compile-out opcode 0)))
3224 (byte-compile-constant (eval form))))
3227 ;; more complicated compiler macros
3229 (byte-defop-compiler char-before)
3230 (byte-defop-compiler backward-char)
3231 (byte-defop-compiler backward-word)
3232 (byte-defop-compiler list)
3233 (byte-defop-compiler concat)
3234 (byte-defop-compiler fset)
3235 (byte-defop-compiler (indent-to-column byte-indent-to) byte-compile-indent-to)
3236 (byte-defop-compiler indent-to)
3237 (byte-defop-compiler insert)
3238 (byte-defop-compiler-1 function byte-compile-function-form)
3239 (byte-defop-compiler-1 - byte-compile-minus)
3240 (byte-defop-compiler19 (/ byte-quo) byte-compile-quo)
3241 (byte-defop-compiler19 nconc)
3243 (defun byte-compile-char-before (form)
3244 (cond ((= 2 (length form))
3245 (byte-compile-form (list 'char-after (if (numberp (nth 1 form))
3246 (1- (nth 1 form))
3247 `(1- ,(nth 1 form))))))
3248 ((= 1 (length form))
3249 (byte-compile-form '(char-after (1- (point)))))
3250 (t (byte-compile-subr-wrong-args form "0-1"))))
3252 ;; backward-... ==> forward-... with negated argument.
3253 (defun byte-compile-backward-char (form)
3254 (cond ((= 2 (length form))
3255 (byte-compile-form (list 'forward-char (if (numberp (nth 1 form))
3256 (- (nth 1 form))
3257 `(- ,(nth 1 form))))))
3258 ((= 1 (length form))
3259 (byte-compile-form '(forward-char -1)))
3260 (t (byte-compile-subr-wrong-args form "0-1"))))
3262 (defun byte-compile-backward-word (form)
3263 (cond ((= 2 (length form))
3264 (byte-compile-form (list 'forward-word (if (numberp (nth 1 form))
3265 (- (nth 1 form))
3266 `(- ,(nth 1 form))))))
3267 ((= 1 (length form))
3268 (byte-compile-form '(forward-word -1)))
3269 (t (byte-compile-subr-wrong-args form "0-1"))))
3271 (defun byte-compile-list (form)
3272 (let ((count (length (cdr form))))
3273 (cond ((= count 0)
3274 (byte-compile-constant nil))
3275 ((< count 5)
3276 (mapc 'byte-compile-form (cdr form))
3277 (byte-compile-out
3278 (aref [byte-list1 byte-list2 byte-list3 byte-list4] (1- count)) 0))
3279 ((and (< count 256) (not (byte-compile-version-cond
3280 byte-compile-compatibility)))
3281 (mapc 'byte-compile-form (cdr form))
3282 (byte-compile-out 'byte-listN count))
3283 (t (byte-compile-normal-call form)))))
3285 (defun byte-compile-concat (form)
3286 (let ((count (length (cdr form))))
3287 (cond ((and (< 1 count) (< count 5))
3288 (mapc 'byte-compile-form (cdr form))
3289 (byte-compile-out
3290 (aref [byte-concat2 byte-concat3 byte-concat4] (- count 2))
3292 ;; Concat of one arg is not a no-op if arg is not a string.
3293 ((= count 0)
3294 (byte-compile-form ""))
3295 ((and (< count 256) (not (byte-compile-version-cond
3296 byte-compile-compatibility)))
3297 (mapc 'byte-compile-form (cdr form))
3298 (byte-compile-out 'byte-concatN count))
3299 ((byte-compile-normal-call form)))))
3301 (defun byte-compile-minus (form)
3302 (if (null (setq form (cdr form)))
3303 (byte-compile-constant 0)
3304 (byte-compile-form (car form))
3305 (if (cdr form)
3306 (while (setq form (cdr form))
3307 (byte-compile-form (car form))
3308 (byte-compile-out 'byte-diff 0))
3309 (byte-compile-out 'byte-negate 0))))
3311 (defun byte-compile-quo (form)
3312 (let ((len (length form)))
3313 (cond ((<= len 2)
3314 (byte-compile-subr-wrong-args form "2 or more"))
3316 (byte-compile-form (car (setq form (cdr form))))
3317 (while (setq form (cdr form))
3318 (byte-compile-form (car form))
3319 (byte-compile-out 'byte-quo 0))))))
3321 (defun byte-compile-nconc (form)
3322 (let ((len (length form)))
3323 (cond ((= len 1)
3324 (byte-compile-constant nil))
3325 ((= len 2)
3326 ;; nconc of one arg is a noop, even if that arg isn't a list.
3327 (byte-compile-form (nth 1 form)))
3329 (byte-compile-form (car (setq form (cdr form))))
3330 (while (setq form (cdr form))
3331 (byte-compile-form (car form))
3332 (byte-compile-out 'byte-nconc 0))))))
3334 (defun byte-compile-fset (form)
3335 ;; warn about forms like (fset 'foo '(lambda () ...))
3336 ;; (where the lambda expression is non-trivial...)
3337 (let ((fn (nth 2 form))
3338 body)
3339 (if (and (eq (car-safe fn) 'quote)
3340 (eq (car-safe (setq fn (nth 1 fn))) 'lambda))
3341 (progn
3342 (setq body (cdr (cdr fn)))
3343 (if (stringp (car body)) (setq body (cdr body)))
3344 (if (eq 'interactive (car-safe (car body))) (setq body (cdr body)))
3345 (if (and (consp (car body))
3346 (not (eq 'byte-code (car (car body)))))
3347 (byte-compile-warn
3348 "A quoted lambda form is the second argument of `fset'. This is probably
3349 not what you want, as that lambda cannot be compiled. Consider using
3350 the syntax (function (lambda (...) ...)) instead.")))))
3351 (byte-compile-two-args form))
3353 (defun byte-compile-funarg (form)
3354 ;; (mapcar '(lambda (x) ..) ..) ==> (mapcar (function (lambda (x) ..)) ..)
3355 ;; for cases where it's guaranteed that first arg will be used as a lambda.
3356 (byte-compile-normal-call
3357 (let ((fn (nth 1 form)))
3358 (if (and (eq (car-safe fn) 'quote)
3359 (eq (car-safe (nth 1 fn)) 'lambda))
3360 (cons (car form)
3361 (cons (cons 'function (cdr fn))
3362 (cdr (cdr form))))
3363 form))))
3365 (defun byte-compile-funarg-2 (form)
3366 ;; (sort ... '(lambda (x) ..)) ==> (sort ... (function (lambda (x) ..)))
3367 ;; for cases where it's guaranteed that second arg will be used as a lambda.
3368 (byte-compile-normal-call
3369 (let ((fn (nth 2 form)))
3370 (if (and (eq (car-safe fn) 'quote)
3371 (eq (car-safe (nth 1 fn)) 'lambda))
3372 (cons (car form)
3373 (cons (nth 1 form)
3374 (cons (cons 'function (cdr fn))
3375 (cdr (cdr (cdr form))))))
3376 form))))
3378 ;; (function foo) must compile like 'foo, not like (symbol-function 'foo).
3379 ;; Otherwise it will be incompatible with the interpreter,
3380 ;; and (funcall (function foo)) will lose with autoloads.
3382 (defun byte-compile-function-form (form)
3383 (byte-compile-constant
3384 (cond ((symbolp (nth 1 form))
3385 (nth 1 form))
3386 ;; If we're not allowed to use #[] syntax, then output a form like
3387 ;; '(lambda (..) (byte-code ..)) instead of a call to make-byte-code.
3388 ;; In this situation, calling make-byte-code at run-time will usually
3389 ;; be less efficient than processing a call to byte-code.
3390 ((byte-compile-version-cond byte-compile-compatibility)
3391 (byte-compile-byte-code-unmake (byte-compile-lambda (nth 1 form))))
3392 ((byte-compile-lambda (nth 1 form))))))
3394 (defun byte-compile-indent-to (form)
3395 (let ((len (length form)))
3396 (cond ((= len 2)
3397 (byte-compile-form (car (cdr form)))
3398 (byte-compile-out 'byte-indent-to 0))
3399 ((= len 3)
3400 ;; no opcode for 2-arg case.
3401 (byte-compile-normal-call form))
3403 (byte-compile-subr-wrong-args form "1-2")))))
3405 (defun byte-compile-insert (form)
3406 (cond ((null (cdr form))
3407 (byte-compile-constant nil))
3408 ((and (not (byte-compile-version-cond
3409 byte-compile-compatibility))
3410 (<= (length form) 256))
3411 (mapc 'byte-compile-form (cdr form))
3412 (if (cdr (cdr form))
3413 (byte-compile-out 'byte-insertN (length (cdr form)))
3414 (byte-compile-out 'byte-insert 0)))
3415 ((memq t (mapcar 'consp (cdr (cdr form))))
3416 (byte-compile-normal-call form))
3417 ;; We can split it; there is no function call after inserting 1st arg.
3419 (while (setq form (cdr form))
3420 (byte-compile-form (car form))
3421 (byte-compile-out 'byte-insert 0)
3422 (if (cdr form)
3423 (byte-compile-discard))))))
3426 (byte-defop-compiler-1 setq)
3427 (byte-defop-compiler-1 setq-default)
3428 (byte-defop-compiler-1 quote)
3429 (byte-defop-compiler-1 quote-form)
3431 (defun byte-compile-setq (form)
3432 (let ((args (cdr form)))
3433 (if args
3434 (while args
3435 (byte-compile-form (car (cdr args)))
3436 (or for-effect (cdr (cdr args))
3437 (byte-compile-out 'byte-dup 0))
3438 (byte-compile-variable-ref 'byte-varset (car args))
3439 (setq args (cdr (cdr args))))
3440 ;; (setq), with no arguments.
3441 (byte-compile-form nil for-effect))
3442 (setq for-effect nil)))
3444 (defun byte-compile-setq-default (form)
3445 (let ((args (cdr form))
3446 setters)
3447 (while args
3448 (setq setters
3449 (cons (list 'set-default (list 'quote (car args)) (car (cdr args)))
3450 setters))
3451 (setq args (cdr (cdr args))))
3452 (byte-compile-form (cons 'progn (nreverse setters)))))
3454 (defun byte-compile-quote (form)
3455 (byte-compile-constant (car (cdr form))))
3457 (defun byte-compile-quote-form (form)
3458 (byte-compile-constant (byte-compile-top-level (nth 1 form))))
3461 ;;; control structures
3463 (defun byte-compile-body (body &optional for-effect)
3464 (while (cdr body)
3465 (byte-compile-form (car body) t)
3466 (setq body (cdr body)))
3467 (byte-compile-form (car body) for-effect))
3469 (defsubst byte-compile-body-do-effect (body)
3470 (byte-compile-body body for-effect)
3471 (setq for-effect nil))
3473 (defsubst byte-compile-form-do-effect (form)
3474 (byte-compile-form form for-effect)
3475 (setq for-effect nil))
3477 (byte-defop-compiler-1 inline byte-compile-progn)
3478 (byte-defop-compiler-1 progn)
3479 (byte-defop-compiler-1 prog1)
3480 (byte-defop-compiler-1 prog2)
3481 (byte-defop-compiler-1 if)
3482 (byte-defop-compiler-1 cond)
3483 (byte-defop-compiler-1 and)
3484 (byte-defop-compiler-1 or)
3485 (byte-defop-compiler-1 while)
3486 (byte-defop-compiler-1 funcall)
3487 (byte-defop-compiler-1 apply byte-compile-funarg)
3488 (byte-defop-compiler-1 mapcar byte-compile-funarg)
3489 (byte-defop-compiler-1 mapatoms byte-compile-funarg)
3490 (byte-defop-compiler-1 mapconcat byte-compile-funarg)
3491 (byte-defop-compiler-1 mapc byte-compile-funarg)
3492 (byte-defop-compiler-1 maphash byte-compile-funarg)
3493 (byte-defop-compiler-1 map-char-table byte-compile-funarg)
3494 (byte-defop-compiler-1 map-char-table byte-compile-funarg-2)
3495 ;; map-charset-chars should be funarg but has optional third arg
3496 (byte-defop-compiler-1 sort byte-compile-funarg-2)
3497 (byte-defop-compiler-1 let)
3498 (byte-defop-compiler-1 let*)
3500 (defun byte-compile-progn (form)
3501 (byte-compile-body-do-effect (cdr form)))
3503 (defun byte-compile-prog1 (form)
3504 (byte-compile-form-do-effect (car (cdr form)))
3505 (byte-compile-body (cdr (cdr form)) t))
3507 (defun byte-compile-prog2 (form)
3508 (byte-compile-form (nth 1 form) t)
3509 (byte-compile-form-do-effect (nth 2 form))
3510 (byte-compile-body (cdr (cdr (cdr form))) t))
3512 (defmacro byte-compile-goto-if (cond discard tag)
3513 `(byte-compile-goto
3514 (if ,cond
3515 (if ,discard 'byte-goto-if-not-nil 'byte-goto-if-not-nil-else-pop)
3516 (if ,discard 'byte-goto-if-nil 'byte-goto-if-nil-else-pop))
3517 ,tag))
3519 ;; Return the list of items in CONDITION-PARAM that match PRED-LIST.
3520 ;; Only return items that are not in ONLY-IF-NOT-PRESENT.
3521 (defun byte-compile-find-bound-condition (condition-param
3522 pred-list
3523 &optional only-if-not-present)
3524 (let ((result nil)
3525 (nth-one nil)
3526 (cond-list
3527 (if (memq (car-safe condition-param) pred-list)
3528 ;; The condition appears by itself.
3529 (list condition-param)
3530 ;; If the condition is an `and', look for matches among the
3531 ;; `and' arguments.
3532 (when (eq 'and (car-safe condition-param))
3533 (cdr condition-param)))))
3535 (dolist (crt cond-list)
3536 (when (and (memq (car-safe crt) pred-list)
3537 (eq 'quote (car-safe (setq nth-one (nth 1 crt))))
3538 ;; Ignore if the symbol is already on the unresolved
3539 ;; list.
3540 (not (assq (nth 1 nth-one) ; the relevant symbol
3541 only-if-not-present)))
3542 (push (nth 1 (nth 1 crt)) result)))
3543 result))
3545 (defmacro byte-compile-maybe-guarded (condition &rest body)
3546 "Execute forms in BODY, potentially guarded by CONDITION.
3547 CONDITION is a variable whose value is a test in an `if' or `cond'.
3548 BODY is the code to compile first arm of the if or the body of the
3549 cond clause. If CONDITION's value is of the form (fboundp 'foo)
3550 or (boundp 'foo), the relevant warnings from BODY about foo's
3551 being undefined will be suppressed.
3553 If CONDITION's value is (not (featurep 'emacs)) or (featurep 'xemacs),
3554 that suppresses all warnings during execution of BODY."
3555 (declare (indent 1) (debug t))
3556 `(let* ((fbound-list (byte-compile-find-bound-condition
3557 ,condition (list 'fboundp)
3558 byte-compile-unresolved-functions))
3559 (bound-list (byte-compile-find-bound-condition
3560 ,condition (list 'boundp 'default-boundp)))
3561 ;; Maybe add to the bound list.
3562 (byte-compile-bound-variables
3563 (if bound-list
3564 (append bound-list byte-compile-bound-variables)
3565 byte-compile-bound-variables)))
3566 (unwind-protect
3567 (progn ,@body)
3568 ;; Maybe remove the function symbol from the unresolved list.
3569 (dolist (fbound fbound-list)
3570 (when fbound
3571 (setq byte-compile-unresolved-functions
3572 (delq (assq fbound byte-compile-unresolved-functions)
3573 byte-compile-unresolved-functions)))))))
3575 (defun byte-compile-if (form)
3576 (byte-compile-form (car (cdr form)))
3577 ;; Check whether we have `(if (fboundp ...' or `(if (boundp ...'
3578 ;; and avoid warnings about the relevent symbols in the consequent.
3579 (let ((clause (nth 1 form))
3580 (donetag (byte-compile-make-tag)))
3581 (if (null (nthcdr 3 form))
3582 ;; No else-forms
3583 (progn
3584 (byte-compile-goto-if nil for-effect donetag)
3585 (byte-compile-maybe-guarded clause
3586 (byte-compile-form (nth 2 form) for-effect))
3587 (byte-compile-out-tag donetag))
3588 (let ((elsetag (byte-compile-make-tag)))
3589 (byte-compile-goto 'byte-goto-if-nil elsetag)
3590 (byte-compile-maybe-guarded clause
3591 (byte-compile-form (nth 2 form) for-effect))
3592 (byte-compile-goto 'byte-goto donetag)
3593 (byte-compile-out-tag elsetag)
3594 (byte-compile-maybe-guarded (list 'not clause)
3595 (byte-compile-body (cdr (cdr (cdr form))) for-effect))
3596 (byte-compile-out-tag donetag))))
3597 (setq for-effect nil))
3599 (defun byte-compile-cond (clauses)
3600 (let ((donetag (byte-compile-make-tag))
3601 nexttag clause)
3602 (while (setq clauses (cdr clauses))
3603 (setq clause (car clauses))
3604 (cond ((or (eq (car clause) t)
3605 (and (eq (car-safe (car clause)) 'quote)
3606 (car-safe (cdr-safe (car clause)))))
3607 ;; Unconditional clause
3608 (setq clause (cons t clause)
3609 clauses nil))
3610 ((cdr clauses)
3611 (byte-compile-form (car clause))
3612 (if (null (cdr clause))
3613 ;; First clause is a singleton.
3614 (byte-compile-goto-if t for-effect donetag)
3615 (setq nexttag (byte-compile-make-tag))
3616 (byte-compile-goto 'byte-goto-if-nil nexttag)
3617 (byte-compile-maybe-guarded (car clause)
3618 (byte-compile-body (cdr clause) for-effect))
3619 (byte-compile-goto 'byte-goto donetag)
3620 (byte-compile-out-tag nexttag)))))
3621 ;; Last clause
3622 (let ((guard (car clause)))
3623 (and (cdr clause) (not (eq guard t))
3624 (progn (byte-compile-form guard)
3625 (byte-compile-goto-if nil for-effect donetag)
3626 (setq clause (cdr clause))))
3627 (byte-compile-maybe-guarded guard
3628 (byte-compile-body-do-effect clause)))
3629 (byte-compile-out-tag donetag)))
3631 (defun byte-compile-and (form)
3632 (let ((failtag (byte-compile-make-tag))
3633 (args (cdr form)))
3634 (if (null args)
3635 (byte-compile-form-do-effect t)
3636 (byte-compile-and-recursion args failtag))))
3638 ;; Handle compilation of a nontrivial `and' call.
3639 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3640 (defun byte-compile-and-recursion (rest failtag)
3641 (if (cdr rest)
3642 (progn
3643 (byte-compile-form (car rest))
3644 (byte-compile-goto-if nil for-effect failtag)
3645 (byte-compile-maybe-guarded (car rest)
3646 (byte-compile-and-recursion (cdr rest) failtag)))
3647 (byte-compile-form-do-effect (car rest))
3648 (byte-compile-out-tag failtag)))
3650 (defun byte-compile-or (form)
3651 (let ((wintag (byte-compile-make-tag))
3652 (args (cdr form)))
3653 (if (null args)
3654 (byte-compile-form-do-effect nil)
3655 (byte-compile-or-recursion args wintag))))
3657 ;; Handle compilation of a nontrivial `or' call.
3658 ;; We use tail recursion so we can use byte-compile-maybe-guarded.
3659 (defun byte-compile-or-recursion (rest wintag)
3660 (if (cdr rest)
3661 (progn
3662 (byte-compile-form (car rest))
3663 (byte-compile-goto-if t for-effect wintag)
3664 (byte-compile-maybe-guarded (list 'not (car rest))
3665 (byte-compile-or-recursion (cdr rest) wintag)))
3666 (byte-compile-form-do-effect (car rest))
3667 (byte-compile-out-tag wintag)))
3669 (defun byte-compile-while (form)
3670 (let ((endtag (byte-compile-make-tag))
3671 (looptag (byte-compile-make-tag)))
3672 (byte-compile-out-tag looptag)
3673 (byte-compile-form (car (cdr form)))
3674 (byte-compile-goto-if nil for-effect endtag)
3675 (byte-compile-body (cdr (cdr form)) t)
3676 (byte-compile-goto 'byte-goto looptag)
3677 (byte-compile-out-tag endtag)
3678 (setq for-effect nil)))
3680 (defun byte-compile-funcall (form)
3681 (mapc 'byte-compile-form (cdr form))
3682 (byte-compile-out 'byte-call (length (cdr (cdr form)))))
3685 (defun byte-compile-let (form)
3686 ;; First compute the binding values in the old scope.
3687 (let ((varlist (car (cdr form))))
3688 (dolist (var varlist)
3689 (if (consp var)
3690 (byte-compile-form (car (cdr var)))
3691 (byte-compile-push-constant nil))))
3692 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3693 (varlist (reverse (car (cdr form)))))
3694 (dolist (var varlist)
3695 (byte-compile-variable-ref 'byte-varbind (if (consp var) (car var) var)))
3696 (byte-compile-body-do-effect (cdr (cdr form)))
3697 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3699 (defun byte-compile-let* (form)
3700 (let ((byte-compile-bound-variables byte-compile-bound-variables) ;new scope
3701 (varlist (copy-sequence (car (cdr form)))))
3702 (dolist (var varlist)
3703 (if (atom var)
3704 (byte-compile-push-constant nil)
3705 (byte-compile-form (car (cdr var)))
3706 (setq var (car var)))
3707 (byte-compile-variable-ref 'byte-varbind var))
3708 (byte-compile-body-do-effect (cdr (cdr form)))
3709 (byte-compile-out 'byte-unbind (length (car (cdr form))))))
3712 (byte-defop-compiler-1 /= byte-compile-negated)
3713 (byte-defop-compiler-1 atom byte-compile-negated)
3714 (byte-defop-compiler-1 nlistp byte-compile-negated)
3716 (put '/= 'byte-compile-negated-op '=)
3717 (put 'atom 'byte-compile-negated-op 'consp)
3718 (put 'nlistp 'byte-compile-negated-op 'listp)
3720 (defun byte-compile-negated (form)
3721 (byte-compile-form-do-effect (byte-compile-negation-optimizer form)))
3723 ;; Even when optimization is off, /= is optimized to (not (= ...)).
3724 (defun byte-compile-negation-optimizer (form)
3725 ;; an optimizer for forms where <form1> is less efficient than (not <form2>)
3726 (byte-compile-set-symbol-position (car form))
3727 (list 'not
3728 (cons (or (get (car form) 'byte-compile-negated-op)
3729 (error
3730 "Compiler error: `%s' has no `byte-compile-negated-op' property"
3731 (car form)))
3732 (cdr form))))
3734 ;;; other tricky macro-like special-forms
3736 (byte-defop-compiler-1 catch)
3737 (byte-defop-compiler-1 unwind-protect)
3738 (byte-defop-compiler-1 condition-case)
3739 (byte-defop-compiler-1 save-excursion)
3740 (byte-defop-compiler-1 save-current-buffer)
3741 (byte-defop-compiler-1 save-restriction)
3742 (byte-defop-compiler-1 save-window-excursion)
3743 (byte-defop-compiler-1 with-output-to-temp-buffer)
3744 (byte-defop-compiler-1 track-mouse)
3746 (defun byte-compile-catch (form)
3747 (byte-compile-form (car (cdr form)))
3748 (byte-compile-push-constant
3749 (byte-compile-top-level (cons 'progn (cdr (cdr form))) for-effect))
3750 (byte-compile-out 'byte-catch 0))
3752 (defun byte-compile-unwind-protect (form)
3753 (byte-compile-push-constant
3754 (byte-compile-top-level-body (cdr (cdr form)) t))
3755 (byte-compile-out 'byte-unwind-protect 0)
3756 (byte-compile-form-do-effect (car (cdr form)))
3757 (byte-compile-out 'byte-unbind 1))
3759 (defun byte-compile-track-mouse (form)
3760 (byte-compile-form
3761 `(funcall '(lambda nil
3762 (track-mouse ,@(byte-compile-top-level-body (cdr form)))))))
3764 (defun byte-compile-condition-case (form)
3765 (let* ((var (nth 1 form))
3766 (byte-compile-bound-variables
3767 (if var (cons var byte-compile-bound-variables)
3768 byte-compile-bound-variables)))
3769 (byte-compile-set-symbol-position 'condition-case)
3770 (unless (symbolp var)
3771 (byte-compile-warn
3772 "`%s' is not a variable-name or nil (in condition-case)" var))
3773 (byte-compile-push-constant var)
3774 (byte-compile-push-constant (byte-compile-top-level
3775 (nth 2 form) for-effect))
3776 (let ((clauses (cdr (cdr (cdr form))))
3777 compiled-clauses)
3778 (while clauses
3779 (let* ((clause (car clauses))
3780 (condition (car clause)))
3781 (cond ((not (or (symbolp condition)
3782 (and (listp condition)
3783 (let ((syms condition) (ok t))
3784 (while syms
3785 (if (not (symbolp (car syms)))
3786 (setq ok nil))
3787 (setq syms (cdr syms)))
3788 ok))))
3789 (byte-compile-warn
3790 "`%s' is not a condition name or list of such (in condition-case)"
3791 (prin1-to-string condition)))
3792 ;; ((not (or (eq condition 't)
3793 ;; (and (stringp (get condition 'error-message))
3794 ;; (consp (get condition 'error-conditions)))))
3795 ;; (byte-compile-warn
3796 ;; "`%s' is not a known condition name (in condition-case)"
3797 ;; condition))
3799 (setq compiled-clauses
3800 (cons (cons condition
3801 (byte-compile-top-level-body
3802 (cdr clause) for-effect))
3803 compiled-clauses)))
3804 (setq clauses (cdr clauses)))
3805 (byte-compile-push-constant (nreverse compiled-clauses)))
3806 (byte-compile-out 'byte-condition-case 0)))
3809 (defun byte-compile-save-excursion (form)
3810 (byte-compile-out 'byte-save-excursion 0)
3811 (byte-compile-body-do-effect (cdr form))
3812 (byte-compile-out 'byte-unbind 1))
3814 (defun byte-compile-save-restriction (form)
3815 (byte-compile-out 'byte-save-restriction 0)
3816 (byte-compile-body-do-effect (cdr form))
3817 (byte-compile-out 'byte-unbind 1))
3819 (defun byte-compile-save-current-buffer (form)
3820 (byte-compile-out 'byte-save-current-buffer 0)
3821 (byte-compile-body-do-effect (cdr form))
3822 (byte-compile-out 'byte-unbind 1))
3824 (defun byte-compile-save-window-excursion (form)
3825 (byte-compile-push-constant
3826 (byte-compile-top-level-body (cdr form) for-effect))
3827 (byte-compile-out 'byte-save-window-excursion 0))
3829 (defun byte-compile-with-output-to-temp-buffer (form)
3830 (byte-compile-form (car (cdr form)))
3831 (byte-compile-out 'byte-temp-output-buffer-setup 0)
3832 (byte-compile-body (cdr (cdr form)))
3833 (byte-compile-out 'byte-temp-output-buffer-show 0))
3835 ;;; top-level forms elsewhere
3837 (byte-defop-compiler-1 defun)
3838 (byte-defop-compiler-1 defmacro)
3839 (byte-defop-compiler-1 defvar)
3840 (byte-defop-compiler-1 defconst byte-compile-defvar)
3841 (byte-defop-compiler-1 autoload)
3842 (byte-defop-compiler-1 lambda byte-compile-lambda-form)
3844 (defun byte-compile-defun (form)
3845 ;; This is not used for file-level defuns with doc strings.
3846 (if (symbolp (car form))
3847 (byte-compile-set-symbol-position (car form))
3848 (byte-compile-set-symbol-position 'defun)
3849 (error "defun name must be a symbol, not %s" (car form)))
3850 (if (byte-compile-version-cond byte-compile-compatibility)
3851 (progn
3852 (byte-compile-two-args ; Use this to avoid byte-compile-fset's warning.
3853 (list 'fset
3854 (list 'quote (nth 1 form))
3855 (byte-compile-byte-code-maker
3856 (byte-compile-lambda (cdr (cdr form)) t))))
3857 (byte-compile-discard))
3858 ;; We prefer to generate a defalias form so it will record the function
3859 ;; definition just like interpreting a defun.
3860 (byte-compile-form
3861 (list 'defalias
3862 (list 'quote (nth 1 form))
3863 (byte-compile-byte-code-maker
3864 (byte-compile-lambda (cdr (cdr form)) t)))
3866 (byte-compile-constant (nth 1 form)))
3868 (defun byte-compile-defmacro (form)
3869 ;; This is not used for file-level defmacros with doc strings.
3870 (byte-compile-body-do-effect
3871 (list (list 'fset (list 'quote (nth 1 form))
3872 (let ((code (byte-compile-byte-code-maker
3873 (byte-compile-lambda (cdr (cdr form)) t))))
3874 (if (eq (car-safe code) 'make-byte-code)
3875 (list 'cons ''macro code)
3876 (list 'quote (cons 'macro (eval code))))))
3877 (list 'quote (nth 1 form)))))
3879 (defun byte-compile-defvar (form)
3880 ;; This is not used for file-level defvar/consts with doc strings.
3881 (let ((fun (nth 0 form))
3882 (var (nth 1 form))
3883 (value (nth 2 form))
3884 (string (nth 3 form)))
3885 (byte-compile-set-symbol-position fun)
3886 (when (or (> (length form) 4)
3887 (and (eq fun 'defconst) (null (cddr form))))
3888 (let ((ncall (length (cdr form))))
3889 (byte-compile-warn
3890 "`%s' called with %d argument%s, but %s %s"
3891 fun ncall
3892 (if (= 1 ncall) "" "s")
3893 (if (< ncall 2) "requires" "accepts only")
3894 "2-3")))
3895 (when (byte-compile-warning-enabled-p 'free-vars)
3896 (push var byte-compile-bound-variables)
3897 (if (eq fun 'defconst)
3898 (push var byte-compile-const-variables)))
3899 (byte-compile-body-do-effect
3900 (list
3901 ;; Put the defined variable in this library's load-history entry
3902 ;; just as a real defvar would, but only in top-level forms.
3903 (when (and (cddr form) (null byte-compile-current-form))
3904 `(push ',var current-load-list))
3905 (when (> (length form) 3)
3906 (when (and string (not (stringp string)))
3907 (byte-compile-warn "third arg to `%s %s' is not a string: %s"
3908 fun var string))
3909 `(put ',var 'variable-documentation ,string))
3910 (if (cddr form) ; `value' provided
3911 (let ((byte-compile-not-obsolete-var var))
3912 (if (eq fun 'defconst)
3913 ;; `defconst' sets `var' unconditionally.
3914 (let ((tmp (make-symbol "defconst-tmp-var")))
3915 `(funcall '(lambda (,tmp) (defconst ,var ,tmp))
3916 ,value))
3917 ;; `defvar' sets `var' only when unbound.
3918 `(if (not (default-boundp ',var)) (setq-default ,var ,value))))
3919 (when (eq fun 'defconst)
3920 ;; This will signal an appropriate error at runtime.
3921 `(eval ',form)))
3922 `',var))))
3924 (defun byte-compile-autoload (form)
3925 (byte-compile-set-symbol-position 'autoload)
3926 (and (byte-compile-constp (nth 1 form))
3927 (byte-compile-constp (nth 5 form))
3928 (eval (nth 5 form)) ; macro-p
3929 (not (fboundp (eval (nth 1 form))))
3930 (byte-compile-warn
3931 "The compiler ignores `autoload' except at top level. You should
3932 probably put the autoload of the macro `%s' at top-level."
3933 (eval (nth 1 form))))
3934 (byte-compile-normal-call form))
3936 ;; Lambdas in valid places are handled as special cases by various code.
3937 ;; The ones that remain are errors.
3938 (defun byte-compile-lambda-form (form)
3939 (byte-compile-set-symbol-position 'lambda)
3940 (error "`lambda' used as function name is invalid"))
3942 ;; Compile normally, but deal with warnings for the function being defined.
3943 (put 'defalias 'byte-hunk-handler 'byte-compile-file-form-defalias)
3944 (defun byte-compile-file-form-defalias (form)
3945 (if (and (consp (cdr form)) (consp (nth 1 form))
3946 (eq (car (nth 1 form)) 'quote)
3947 (consp (cdr (nth 1 form)))
3948 (symbolp (nth 1 (nth 1 form))))
3949 (let ((constant
3950 (and (consp (nthcdr 2 form))
3951 (consp (nth 2 form))
3952 (eq (car (nth 2 form)) 'quote)
3953 (consp (cdr (nth 2 form)))
3954 (symbolp (nth 1 (nth 2 form))))))
3955 (byte-compile-defalias-warn (nth 1 (nth 1 form)))
3956 (push (cons (nth 1 (nth 1 form))
3957 (if constant (nth 1 (nth 2 form)) t))
3958 byte-compile-function-environment)))
3959 ;; We used to jus do: (byte-compile-normal-call form)
3960 ;; But it turns out that this fails to optimize the code.
3961 ;; So instead we now do the same as what other byte-hunk-handlers do,
3962 ;; which is to call back byte-compile-file-form and then return nil.
3963 ;; Except that we can't just call byte-compile-file-form since it would
3964 ;; call us right back.
3965 (byte-compile-keep-pending form)
3966 ;; Return nil so the form is not output twice.
3967 nil)
3969 ;; Turn off warnings about prior calls to the function being defalias'd.
3970 ;; This could be smarter and compare those calls with
3971 ;; the function it is being aliased to.
3972 (defun byte-compile-defalias-warn (new)
3973 (let ((calls (assq new byte-compile-unresolved-functions)))
3974 (if calls
3975 (setq byte-compile-unresolved-functions
3976 (delq calls byte-compile-unresolved-functions)))))
3978 (byte-defop-compiler-1 with-no-warnings byte-compile-no-warnings)
3979 (defun byte-compile-no-warnings (form)
3980 (let (byte-compile-warnings)
3981 (byte-compile-form (cons 'progn (cdr form)))))
3983 ;; Warn about misuses of make-variable-buffer-local.
3984 (byte-defop-compiler-1 make-variable-buffer-local byte-compile-make-variable-buffer-local)
3985 (defun byte-compile-make-variable-buffer-local (form)
3986 (if (and (eq (car-safe (car-safe (cdr-safe form))) 'quote)
3987 (byte-compile-warning-enabled-p 'make-local))
3988 (byte-compile-warn
3989 "`make-variable-buffer-local' should be called at toplevel"))
3990 (byte-compile-normal-call form))
3991 (put 'make-variable-buffer-local
3992 'byte-hunk-handler 'byte-compile-form-make-variable-buffer-local)
3993 (defun byte-compile-form-make-variable-buffer-local (form)
3994 (byte-compile-keep-pending form 'byte-compile-normal-call))
3997 ;;; tags
3999 ;; Note: Most operations will strip off the 'TAG, but it speeds up
4000 ;; optimization to have the 'TAG as a part of the tag.
4001 ;; Tags will be (TAG . (tag-number . stack-depth)).
4002 (defun byte-compile-make-tag ()
4003 (list 'TAG (setq byte-compile-tag-number (1+ byte-compile-tag-number))))
4006 (defun byte-compile-out-tag (tag)
4007 (setq byte-compile-output (cons tag byte-compile-output))
4008 (if (cdr (cdr tag))
4009 (progn
4010 ;; ## remove this someday
4011 (and byte-compile-depth
4012 (not (= (cdr (cdr tag)) byte-compile-depth))
4013 (error "Compiler bug: depth conflict at tag %d" (car (cdr tag))))
4014 (setq byte-compile-depth (cdr (cdr tag))))
4015 (setcdr (cdr tag) byte-compile-depth)))
4017 (defun byte-compile-goto (opcode tag)
4018 (push (cons opcode tag) byte-compile-output)
4019 (setcdr (cdr tag) (if (memq opcode byte-goto-always-pop-ops)
4020 (1- byte-compile-depth)
4021 byte-compile-depth))
4022 (setq byte-compile-depth (and (not (eq opcode 'byte-goto))
4023 (1- byte-compile-depth))))
4025 (defun byte-compile-out (opcode offset)
4026 (push (cons opcode offset) byte-compile-output)
4027 (cond ((eq opcode 'byte-call)
4028 (setq byte-compile-depth (- byte-compile-depth offset)))
4029 ((eq opcode 'byte-return)
4030 ;; This is actually an unnecessary case, because there should be
4031 ;; no more opcodes behind byte-return.
4032 (setq byte-compile-depth nil))
4034 (setq byte-compile-depth (+ byte-compile-depth
4035 (or (aref byte-stack+-info
4036 (symbol-value opcode))
4037 (- (1- offset))))
4038 byte-compile-maxdepth (max byte-compile-depth
4039 byte-compile-maxdepth))))
4040 ;;(if (< byte-compile-depth 0) (error "Compiler error: stack underflow"))
4044 ;;; call tree stuff
4046 (defun byte-compile-annotate-call-tree (form)
4047 (let (entry)
4048 ;; annotate the current call
4049 (if (setq entry (assq (car form) byte-compile-call-tree))
4050 (or (memq byte-compile-current-form (nth 1 entry)) ;callers
4051 (setcar (cdr entry)
4052 (cons byte-compile-current-form (nth 1 entry))))
4053 (setq byte-compile-call-tree
4054 (cons (list (car form) (list byte-compile-current-form) nil)
4055 byte-compile-call-tree)))
4056 ;; annotate the current function
4057 (if (setq entry (assq byte-compile-current-form byte-compile-call-tree))
4058 (or (memq (car form) (nth 2 entry)) ;called
4059 (setcar (cdr (cdr entry))
4060 (cons (car form) (nth 2 entry))))
4061 (setq byte-compile-call-tree
4062 (cons (list byte-compile-current-form nil (list (car form)))
4063 byte-compile-call-tree)))
4066 ;; Renamed from byte-compile-report-call-tree
4067 ;; to avoid interfering with completion of byte-compile-file.
4068 ;;;###autoload
4069 (defun display-call-tree (&optional filename)
4070 "Display a call graph of a specified file.
4071 This lists which functions have been called, what functions called
4072 them, and what functions they call. The list includes all functions
4073 whose definitions have been compiled in this Emacs session, as well as
4074 all functions called by those functions.
4076 The call graph does not include macros, inline functions, or
4077 primitives that the byte-code interpreter knows about directly \(eq,
4078 cons, etc.\).
4080 The call tree also lists those functions which are not known to be called
4081 \(that is, to which no calls have been compiled\), and which cannot be
4082 invoked interactively."
4083 (interactive)
4084 (message "Generating call tree...")
4085 (with-output-to-temp-buffer "*Call-Tree*"
4086 (set-buffer "*Call-Tree*")
4087 (erase-buffer)
4088 (message "Generating call tree... (sorting on %s)"
4089 byte-compile-call-tree-sort)
4090 (insert "Call tree for "
4091 (cond ((null byte-compile-current-file) (or filename "???"))
4092 ((stringp byte-compile-current-file)
4093 byte-compile-current-file)
4094 (t (buffer-name byte-compile-current-file)))
4095 " sorted on "
4096 (prin1-to-string byte-compile-call-tree-sort)
4097 ":\n\n")
4098 (if byte-compile-call-tree-sort
4099 (setq byte-compile-call-tree
4100 (sort byte-compile-call-tree
4101 (cond ((eq byte-compile-call-tree-sort 'callers)
4102 (function (lambda (x y) (< (length (nth 1 x))
4103 (length (nth 1 y))))))
4104 ((eq byte-compile-call-tree-sort 'calls)
4105 (function (lambda (x y) (< (length (nth 2 x))
4106 (length (nth 2 y))))))
4107 ((eq byte-compile-call-tree-sort 'calls+callers)
4108 (function (lambda (x y) (< (+ (length (nth 1 x))
4109 (length (nth 2 x)))
4110 (+ (length (nth 1 y))
4111 (length (nth 2 y)))))))
4112 ((eq byte-compile-call-tree-sort 'name)
4113 (function (lambda (x y) (string< (car x)
4114 (car y)))))
4115 (t (error "`byte-compile-call-tree-sort': `%s' - unknown sort mode"
4116 byte-compile-call-tree-sort))))))
4117 (message "Generating call tree...")
4118 (let ((rest byte-compile-call-tree)
4119 (b (current-buffer))
4121 callers calls)
4122 (while rest
4123 (prin1 (car (car rest)) b)
4124 (setq callers (nth 1 (car rest))
4125 calls (nth 2 (car rest)))
4126 (insert "\t"
4127 (cond ((not (fboundp (setq f (car (car rest)))))
4128 (if (null f)
4129 " <top level>";; shouldn't insert nil then, actually -sk
4130 " <not defined>"))
4131 ((subrp (setq f (symbol-function f)))
4132 " <subr>")
4133 ((symbolp f)
4134 (format " ==> %s" f))
4135 ((byte-code-function-p f)
4136 "<compiled function>")
4137 ((not (consp f))
4138 "<malformed function>")
4139 ((eq 'macro (car f))
4140 (if (or (byte-code-function-p (cdr f))
4141 (assq 'byte-code (cdr (cdr (cdr f)))))
4142 " <compiled macro>"
4143 " <macro>"))
4144 ((assq 'byte-code (cdr (cdr f)))
4145 "<compiled lambda>")
4146 ((eq 'lambda (car f))
4147 "<function>")
4148 (t "???"))
4149 (format " (%d callers + %d calls = %d)"
4150 ;; Does the optimizer eliminate common subexpressions?-sk
4151 (length callers)
4152 (length calls)
4153 (+ (length callers) (length calls)))
4154 "\n")
4155 (if callers
4156 (progn
4157 (insert " called by:\n")
4158 (setq p (point))
4159 (insert " " (if (car callers)
4160 (mapconcat 'symbol-name callers ", ")
4161 "<top level>"))
4162 (let ((fill-prefix " "))
4163 (fill-region-as-paragraph p (point)))
4164 (unless (= 0 (current-column))
4165 (insert "\n"))))
4166 (if calls
4167 (progn
4168 (insert " calls:\n")
4169 (setq p (point))
4170 (insert " " (mapconcat 'symbol-name calls ", "))
4171 (let ((fill-prefix " "))
4172 (fill-region-as-paragraph p (point)))
4173 (unless (= 0 (current-column))
4174 (insert "\n"))))
4175 (setq rest (cdr rest)))
4177 (message "Generating call tree...(finding uncalled functions...)")
4178 (setq rest byte-compile-call-tree)
4179 (let ((uncalled nil))
4180 (while rest
4181 (or (nth 1 (car rest))
4182 (null (setq f (car (car rest))))
4183 (functionp (byte-compile-fdefinition f t))
4184 (commandp (byte-compile-fdefinition f nil))
4185 (setq uncalled (cons f uncalled)))
4186 (setq rest (cdr rest)))
4187 (if uncalled
4188 (let ((fill-prefix " "))
4189 (insert "Noninteractive functions not known to be called:\n ")
4190 (setq p (point))
4191 (insert (mapconcat 'symbol-name (nreverse uncalled) ", "))
4192 (fill-region-as-paragraph p (point)))))
4194 (message "Generating call tree...done.")
4198 ;;;###autoload
4199 (defun batch-byte-compile-if-not-done ()
4200 "Like `byte-compile-file' but doesn't recompile if already up to date.
4201 Use this from the command line, with `-batch';
4202 it won't work in an interactive Emacs."
4203 (batch-byte-compile t))
4205 ;;; by crl@newton.purdue.edu
4206 ;;; Only works noninteractively.
4207 ;;;###autoload
4208 (defun batch-byte-compile (&optional noforce)
4209 "Run `byte-compile-file' on the files remaining on the command line.
4210 Use this from the command line, with `-batch';
4211 it won't work in an interactive Emacs.
4212 Each file is processed even if an error occurred previously.
4213 For example, invoke \"emacs -batch -f batch-byte-compile $emacs/ ~/*.el\".
4214 If NOFORCE is non-nil, don't recompile a file that seems to be
4215 already up-to-date."
4216 ;; command-line-args-left is what is left of the command line (from startup.el)
4217 (defvar command-line-args-left) ;Avoid 'free variable' warning
4218 (if (not noninteractive)
4219 (error "`batch-byte-compile' is to be used only with -batch"))
4220 (let ((error nil))
4221 (while command-line-args-left
4222 (if (file-directory-p (expand-file-name (car command-line-args-left)))
4223 ;; Directory as argument.
4224 (let ((bytecomp-files (directory-files (car command-line-args-left)))
4225 bytecomp-source bytecomp-dest)
4226 (dolist (bytecomp-file bytecomp-files)
4227 (if (and (string-match emacs-lisp-file-regexp bytecomp-file)
4228 (not (auto-save-file-name-p bytecomp-file))
4229 (setq bytecomp-source
4230 (expand-file-name bytecomp-file
4231 (car command-line-args-left)))
4232 (setq bytecomp-dest (byte-compile-dest-file
4233 bytecomp-source))
4234 (file-exists-p bytecomp-dest)
4235 (file-newer-than-file-p bytecomp-source bytecomp-dest))
4236 (if (null (batch-byte-compile-file bytecomp-source))
4237 (setq error t)))))
4238 ;; Specific file argument
4239 (if (or (not noforce)
4240 (let* ((bytecomp-source (car command-line-args-left))
4241 (bytecomp-dest (byte-compile-dest-file bytecomp-source)))
4242 (or (not (file-exists-p bytecomp-dest))
4243 (file-newer-than-file-p bytecomp-source bytecomp-dest))))
4244 (if (null (batch-byte-compile-file (car command-line-args-left)))
4245 (setq error t))))
4246 (setq command-line-args-left (cdr command-line-args-left)))
4247 (kill-emacs (if error 1 0))))
4249 (defun batch-byte-compile-file (bytecomp-file)
4250 (if debug-on-error
4251 (byte-compile-file bytecomp-file)
4252 (condition-case err
4253 (byte-compile-file bytecomp-file)
4254 (file-error
4255 (message (if (cdr err)
4256 ">>Error occurred processing %s: %s (%s)"
4257 ">>Error occurred processing %s: %s")
4258 bytecomp-file
4259 (get (car err) 'error-message)
4260 (prin1-to-string (cdr err)))
4261 (let ((bytecomp-destfile (byte-compile-dest-file bytecomp-file)))
4262 (if (file-exists-p bytecomp-destfile)
4263 (delete-file bytecomp-destfile)))
4264 nil)
4265 (error
4266 (message (if (cdr err)
4267 ">>Error occurred processing %s: %s (%s)"
4268 ">>Error occurred processing %s: %s")
4269 bytecomp-file
4270 (get (car err) 'error-message)
4271 (prin1-to-string (cdr err)))
4272 nil))))
4274 ;;;###autoload
4275 (defun batch-byte-recompile-directory (&optional arg)
4276 "Run `byte-recompile-directory' on the dirs remaining on the command line.
4277 Must be used only with `-batch', and kills Emacs on completion.
4278 For example, invoke `emacs -batch -f batch-byte-recompile-directory .'.
4280 Optional argument ARG is passed as second argument ARG to
4281 `byte-recompile-directory'; see there for its possible values
4282 and corresponding effects."
4283 ;; command-line-args-left is what is left of the command line (startup.el)
4284 (defvar command-line-args-left) ;Avoid 'free variable' warning
4285 (if (not noninteractive)
4286 (error "batch-byte-recompile-directory is to be used only with -batch"))
4287 (or command-line-args-left
4288 (setq command-line-args-left '(".")))
4289 (while command-line-args-left
4290 (byte-recompile-directory (car command-line-args-left) arg)
4291 (setq command-line-args-left (cdr command-line-args-left)))
4292 (kill-emacs 0))
4294 (provide 'byte-compile)
4295 (provide 'bytecomp)
4298 ;;; report metering (see the hacks in bytecode.c)
4300 (defvar byte-code-meter)
4301 (defun byte-compile-report-ops ()
4302 (with-output-to-temp-buffer "*Meter*"
4303 (set-buffer "*Meter*")
4304 (let ((i 0) n op off)
4305 (while (< i 256)
4306 (setq n (aref (aref byte-code-meter 0) i)
4307 off nil)
4308 (if t ;(not (zerop n))
4309 (progn
4310 (setq op i)
4311 (setq off nil)
4312 (cond ((< op byte-nth)
4313 (setq off (logand op 7))
4314 (setq op (logand op 248)))
4315 ((>= op byte-constant)
4316 (setq off (- op byte-constant)
4317 op byte-constant)))
4318 (setq op (aref byte-code-vector op))
4319 (insert (format "%-4d" i))
4320 (insert (symbol-name op))
4321 (if off (insert " [" (int-to-string off) "]"))
4322 (indent-to 40)
4323 (insert (int-to-string n) "\n")))
4324 (setq i (1+ i))))))
4326 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when bytecomp compiles
4327 ;; itself, compile some of its most used recursive functions (at load time).
4329 (eval-when-compile
4330 (or (byte-code-function-p (symbol-function 'byte-compile-form))
4331 (assq 'byte-code (symbol-function 'byte-compile-form))
4332 (let ((byte-optimize nil) ; do it fast
4333 (byte-compile-warnings nil))
4334 (mapc (lambda (x)
4335 (or noninteractive (message "compiling %s..." x))
4336 (byte-compile x)
4337 (or noninteractive (message "compiling %s...done" x)))
4338 '(byte-compile-normal-call
4339 byte-compile-form
4340 byte-compile-body
4341 ;; Inserted some more than necessary, to speed it up.
4342 byte-compile-top-level
4343 byte-compile-out-toplevel
4344 byte-compile-constant
4345 byte-compile-variable-ref))))
4346 nil)
4348 (run-hooks 'bytecomp-load-hook)
4350 ;; arch-tag: 9c97b0f0-8745-4571-bfc3-8dceb677292a
4351 ;;; bytecomp.el ends here