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