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