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