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