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