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