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