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