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