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