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