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