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