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