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