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