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