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